Files
telemetry_visualization/docs/architecture.md
2024-10-19 13:24:27 -07:00

38 lines
1.2 KiB
Markdown

# Telemetry Visualization Architecture
## Data Gateway
A data gateway is a standalone application which connects to a live source of
data and a consumer of commands.
While this can be the original producer and end target of the commands, it can
also be a proxy or middleman application responsible for connecting the end
application to the telemetry and commanding backend.
This talks to the Backend's gateway API.
## Backend
The backend is responsible for acting as a bridge between data gateways and
the frontend.
In addition the backend is responsible for recording and providing access to
historical data.
### Gateway API
The backend provides an API for gateways to connect and send telemetry and
receive commands.
The gateway is responsible for registering the types of commands and
telemetry which it expects to interface with.
The gateway API is a Websocket API.
### Frontend API
The backend provides an API for frontends to receive telemetry and send
commands through the gateway.
Additionally, the frontend api provides access to save configurations
for various panels and procedures.
The frontend API is an HTTP and Websocket API.
## Frontend
The frontend is a web-based tool for displaying telemetry and sending
commands to end devices.