docs: define cargo esp api contract

This commit is contained in:
2026-06-09 15:02:44 -06:00
parent 19538781e8
commit f1683897bc
6 changed files with 166 additions and 0 deletions
+6
View File
@@ -173,3 +173,9 @@ Default validation should use the repo-local virtual environment:
DS18B20 temperature support is already implemented in the Cargo ESP/WebUI/API path.
Do not suggest adding DS18B20 support as if it is missing. Future work should preserve existing Cargo ESP temperature ownership and expose/display that telemetry through the API and ESP32-S3 dashboard.
## Cargo API Contract Guardrail
The Cargo ESP API contract is documented in `docs/cargo-api-contract.md`.
Before making dashboard firmware changes, inspect the current API tests and this contract. Do not move relay, BMS, DS18B20, alarm, or configuration ownership from the Cargo ESP to the dashboard.