docs: define cargo esp api contract

2026-06-09 15:02:44 -06:00
parent 19538781e8
commit f1683897bc
6 changed files with 166 additions and 0 deletions
@@ -189,3 +189,17 @@ It may display state and request changes through the Cargo ESP HTTP API, but the
 The ESP32-S3 dashboard should display temperature data from the Cargo ESP API.

 DS18B20 sensors are already implemented on the Cargo ESP/WebUI/API side. For v1, the dashboard should not directly own cargo/fridge DS18B20 wiring or sensor reads.
+
+## API Dependency
+
+The ESP32-S3 dashboard depends on the Cargo ESP API contract documented in `docs/cargo-api-contract.md`.
+
+For v1, the dashboard should consume:
+
+- System status
+- Battery/BMS telemetry
+- DS18B20 temperature telemetry
+- Relay/output state
+- Alarm/fault state
+
+The dashboard may request output changes through the Cargo ESP API, but the Cargo ESP remains the source of truth.