Skip to content

Commit

Permalink
add diagram showing system overview
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickdemers6 committed Apr 22, 2024
1 parent 3f39c7c commit dd0d584
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,6 @@ image-gen:
docker save $(ALPHA_IMAGE_NAME) | gzip > $(ALPHA_IMAGE_COMPRESSED_FILENAME).tar.gz

.PHONY: test build vet linters install integration image-gen generate-protos generate-golang generate-python generate-ruby clean

doc-images:
docker run -v ./:/data plantuml/plantuml "doc"
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ The service handles device connectivity as well as receiving and storing transmi

## Configuring and running the service

This diagram shows a summary of steps taken during configuration and how the system will operate.

![](doc/system_overview.png)

### Setup steps

1. Create a third-party application on [developer.tesla.com](https://developer.tesla.com).
Expand Down
Binary file added doc/system_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions doc/system_overview.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
@startuml
title Fleet Telemetry

== First time only ==

Partner -> "Fleet API": Call register endpoint with CSR
"Fleet API" -> "Fleet API": Process CSR\n(this will take some time)
"Fleet API" -> Partner: Email notification
Partner -> Partner: Setup fleet-telemetry server

== For each user ==

Partner -> Customer: Share the add virtual key to vehicle link\nhttps://tesla.com/_ak/your-domain.com
Customer -> Vehicle: Click link, add virtual key to vehicle
note over Partner: Prerequisites:\n- Virtual key on vehicle\n- Firmware version > 2023.20\n- Not a pre-2021 Model S or X
Partner -> "Fleet API": Configure vehicle request
"Fleet API" -> Vehicle: Configures vehicle for streaming

== Once vehicle is configured ==

group mTLS Websocket
Vehicle -> "Fleet Telemetry Server": Data
end
"Fleet Telemetry Server" -> "Data Broker": Data

@enduml

0 comments on commit dd0d584

Please sign in to comment.