-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This wiki aims to be a useful resource to anyone interested in the inner workings of the Backend and as a tool to diagnose future problems that might arise.
Each page refers to one of the 10 modules the backend has, first the exposed API is covered, after which the specifics of how it works are explored in more detail. At the end of each one there is a section with common problems that might happen if the user uses the API in an unexpected way, if you find any other problems please open an issue in this repository.
Our backend has the following objectives:
- Send messages from the Pod to the GUI in a format it understands.
- Encode messages sent from the GUI and send them to the Pod.
- Log all the data the Pod generates.
- Serve the GUI (the GUI is a webpage).
- Notify of connected and disconnected boards.
The backend takes all the data that the Pod generates and translates it to a format we can handle from other tools (like a webpage for the GUI or using the generated log files to extract detailed info of the Pod operation) and sends to the Pod orders to controll its behaviour (levitate, accelerate, brake, etc.).
This repo currently has 3 different revisions of the backend, this documentation relates to the latest one (DEV-70 onwards) The term Backend and Back will be used interchangeably to refer to the same thing: this project.