Reference
- OpenAPI specification: served live by the running backend at
/docs/api.json(Scramble, generated from the controllers) - App communication (REST + WebSocket events, payloads, client flow): App Communication Guide
- Canonical protocol contract (AsyncAPI + JSON schemas):
docs/asyncapi/ - Topic structure and message/transaction IDs: ADR-0002
- Typed outbound publishers in the backend: ADR-0008
- Broker authentication:
mosquitto-go-authagainst/api/mosq/*
Hardware
Section titled “Hardware”- Bill of Materials (BOM): see Hardware
- The Modbus relay board must be the Waveshare board listed there (verified flash and digital-input behavior, see ADR-0004)
- KiCad designs:
hardware/
Architecture decision records
Section titled “Architecture decision records”All architecture decisions are documented as ADRs:
docs/adr/
Internal documents
Section titled “Internal documents”Further internal documentation (integration plans, detailed analyses) lives in
the repository under
docs/.