Admin Guide¶
This guide is for the people who set up and support FIDOs: organization administrators, and the engineers who build SD cards, update firmware and run the cloud server. Field procedures are in the User Guide.
System architecture¶
The FIDO sampler consists of the following stack of technologies:
- The FIDO sampler itself (motors, valves, etc.)
- The Sampler Microcontroller, based on an STM32 MCU.
- The Sampler Microcontroller Code
- A RockPi S controller, which runs the sampler over a serial protocol,
serves the local user interface, and connects to the cloud server over
MQTT. Useful links:
- RockPi Controller Board
- RockPi Housing
- RockPi WiFi Antenna
- 32 GB SD Card
- Power Supply
- Additional Debugging Tools
- The Web Application, which runs on the RockPi controller and on Amazon
Web Services.
- Local Interface (NOTE: You have to be connected to the local WiFi hotspot from the RockPi device to get to this interface.)
- Production Cloud Server
- Development Cloud Server
flowchart LR
fido-sampler[Sampler]
stm32-mcu[Sampler STM32 MCU]
subgraph Headscale-Tailscale VPN
rockpi[RockPi Controller]
subgraph AWS EC2 Server
nginx[Nginx Server]
subgraph Docker
flask[Gunicorn App Server]
mosquitto[MQTT Broker]
end
end
end
cloud-app[Web App]
local-app[Web App]
fido-sampler --- stm32-mcu
stm32-mcu <--serial--> rockpi
rockpi <--telemetry--> mosquitto
mosquitto <--> flask
flask <--> nginx
nginx <--> cloud-app
rockpi <--wifi--> local-app
Versioning and compatibility¶
READI-Net (this repository) and the FIDO firmware (esp-sampler) are versioned independently as VN.x.y (READI-Net) and VN.a.b (esp-sampler). The shared leading number N is the compatibility contract: every READI-Net VN.x.y release must work with every esp-sampler VN.a.b release. x.y and a.b are independent of each other and don't correlate. For example, READI-Net V1.0.18 and esp-sampler V1.3.0 are a valid pair.
- Bump the major in both projects together when either makes a change the other can't handle (serial protocol, command names, parameter file format, result codes).
- Bump minor/patch independently for fixes and features within the line.
- The User Guide's footer (
copyrightinmkdocs.yml) names the major it documents. Publish a new edition of the manual with each new major.
The user-facing explanation is in Software Versions.