Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add diagram showing system overview #166

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add diagram showing system overview #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,7 @@ image-gen:
docker build -t $(ALPHA_IMAGE_NAME) .
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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be above PHONY and most likely needs to be part of PHONY

docker run -v ./:/data plantuml/plantuml "doc"

.PHONY: test build vet linters install integration image-gen generate-protos generate-golang generate-python generate-ruby doc-images clean
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading