docs: audit stale dashboard references and clarify DS18B20 support
This commit is contained in:
+13
@@ -917,3 +917,16 @@ Example response:
|
|||||||
"ap_ip": "192.168.4.1",
|
"ap_ip": "192.168.4.1",
|
||||||
"message": "AP reset to default SSID with regenerated password."
|
"message": "AP reset to default SSID with regenerated password."
|
||||||
}
|
}
|
||||||
|
|
||||||
|
## Temperature Telemetry
|
||||||
|
|
||||||
|
DS18B20 temperature support is already implemented in the Cargo ESP/WebUI/API path.
|
||||||
|
|
||||||
|
Architecture expectation:
|
||||||
|
|
||||||
|
- Cargo ESP32 owns DS18B20 sensor reads.
|
||||||
|
- Cargo ESP32 exposes temperature telemetry through the API.
|
||||||
|
- WebUI displays temperature telemetry from Cargo ESP state.
|
||||||
|
- Dashboard ESP32-S3 consumes temperature telemetry from the Cargo ESP API.
|
||||||
|
|
||||||
|
The dashboard should not directly read cargo/fridge DS18B20 sensors for v1.
|
||||||
|
|||||||
@@ -250,3 +250,16 @@ Selected dashboard hardware:
|
|||||||
This replaces the earlier Pico dashboard concept as the active dashboard architecture.
|
This replaces the earlier Pico dashboard concept as the active dashboard architecture.
|
||||||
|
|
||||||
The Dashboard ESP32-S3 communicates with the Cargo ESP32 over WiFi/HTTP REST for v1. CAN/OBD-II support remains a future dashboard-side vehicle-visualization feature and is not part of the Cargo ESP32 role.
|
The Dashboard ESP32-S3 communicates with the Cargo ESP32 over WiFi/HTTP REST for v1. CAN/OBD-II support remains a future dashboard-side vehicle-visualization feature and is not part of the Cargo ESP32 role.
|
||||||
|
|
||||||
|
## Existing DS18B20 Temperature Support
|
||||||
|
|
||||||
|
DS18B20 temperature sensor support is already part of the Cargo ESP architecture.
|
||||||
|
|
||||||
|
Current responsibility split:
|
||||||
|
|
||||||
|
- Cargo ESP32 owns DS18B20 sensor reading.
|
||||||
|
- Cargo ESP32 exposes temperature state through the WebUI/API path.
|
||||||
|
- Dashboard ESP32-S3 should consume temperature data from the Cargo ESP API.
|
||||||
|
- Dashboard ESP32-S3 should not wire directly to cargo-area DS18B20 sensors for v1.
|
||||||
|
|
||||||
|
This means future dashboard work should display existing Cargo ESP temperature telemetry rather than reimplementing temperature sensing on the dashboard.
|
||||||
|
|||||||
@@ -167,3 +167,9 @@ Default validation should use the repo-local virtual environment:
|
|||||||
|
|
||||||
source .venv/bin/activate
|
source .venv/bin/activate
|
||||||
python run_tests.py
|
python run_tests.py
|
||||||
|
|
||||||
|
## DS18B20 Implementation Note
|
||||||
|
|
||||||
|
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.
|
||||||
|
|||||||
@@ -200,3 +200,16 @@ Key hardware notes:
|
|||||||
- Integrated CAN transceiver available for future vehicle integration
|
- Integrated CAN transceiver available for future vehicle integration
|
||||||
|
|
||||||
This is the active dashboard platform for the project. The previous Pico dashboard implementation has been archived and is reference-only.
|
This is the active dashboard platform for the project. The previous Pico dashboard implementation has been archived and is reference-only.
|
||||||
|
|
||||||
|
## DS18B20 Temperature Sensors
|
||||||
|
|
||||||
|
DS18B20 temperature sensors are already part of the Cargo ESP implementation and WebUI/API flow.
|
||||||
|
|
||||||
|
Current expectation:
|
||||||
|
|
||||||
|
- DS18B20 sensors connect to the Cargo ESP side.
|
||||||
|
- Cargo ESP owns sensor reads and temperature state.
|
||||||
|
- The WebUI displays the temperature data.
|
||||||
|
- The Dashboard ESP32-S3 will consume temperature data from the Cargo ESP API.
|
||||||
|
|
||||||
|
Do not move cargo/fridge temperature sensing to the dashboard controller unless the architecture is explicitly changed later.
|
||||||
|
|||||||
@@ -38,3 +38,6 @@ Archived documents are kept for history, but the primary documents above should
|
|||||||
|
|
||||||
- `../archive/legacy-pico-dashboard/` - Archived Pico dashboard implementation kept for reference only.
|
- `../archive/legacy-pico-dashboard/` - Archived Pico dashboard implementation kept for reference only.
|
||||||
- `../firmware/esp32-s3-dashboard/` - Current ESP32-S3 dashboard firmware placeholder.
|
- `../firmware/esp32-s3-dashboard/` - Current ESP32-S3 dashboard firmware placeholder.
|
||||||
|
|
||||||
|
- `repo-cleanup-audit.md` - Active repo audit for stale Pico/UART dashboard references and DS18B20 documentation status.
|
||||||
|
- `API.md` - High-level API notes and telemetry ownership.
|
||||||
|
|||||||
@@ -183,3 +183,9 @@ The Dashboard ESP32-S3 does not own:
|
|||||||
- Load-switching output ownership
|
- Load-switching output ownership
|
||||||
|
|
||||||
It may display state and request changes through the Cargo ESP HTTP API, but the Cargo ESP remains the source of truth.
|
It may display state and request changes through the Cargo ESP HTTP API, but the Cargo ESP remains the source of truth.
|
||||||
|
|
||||||
|
## Temperature Data Source
|
||||||
|
|
||||||
|
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.
|
||||||
|
|||||||
@@ -228,3 +228,15 @@ Current dashboard work should target the ESP32-S3 dashboard direction documented
|
|||||||
The current dashboard target is the Waveshare ESP32-S3 Touch LCD 5B with a 5-inch 1024x600 touchscreen.
|
The current dashboard target is the Waveshare ESP32-S3 Touch LCD 5B with a 5-inch 1024x600 touchscreen.
|
||||||
|
|
||||||
This replaces the earlier Pico dashboard concept. The Pico dashboard has been archived as reference-only material.
|
This replaces the earlier Pico dashboard concept. The Pico dashboard has been archived as reference-only material.
|
||||||
|
|
||||||
|
## Implemented DS18B20/WebUI Support
|
||||||
|
|
||||||
|
DS18B20 support is already implemented in the Cargo ESP/WebUI/API path.
|
||||||
|
|
||||||
|
This is not a future feature to add from scratch.
|
||||||
|
|
||||||
|
Future work should focus on:
|
||||||
|
|
||||||
|
- Keeping the API contract accurate
|
||||||
|
- Displaying existing temperature telemetry on the ESP32-S3 dashboard
|
||||||
|
- Preserving Cargo ESP ownership of cargo/fridge temperature sensors
|
||||||
|
|||||||
@@ -0,0 +1,53 @@
|
|||||||
|
# Repo Cleanup Audit
|
||||||
|
|
||||||
|
Last updated: 2026-06-09
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This audit checks active repository files for stale Pico/UART dashboard references after the Pico dashboard implementation was archived.
|
||||||
|
|
||||||
|
Excluded paths:
|
||||||
|
|
||||||
|
- `archive/`
|
||||||
|
- `.git/`
|
||||||
|
- `.venv/`
|
||||||
|
- build/cache folders
|
||||||
|
|
||||||
|
## Result
|
||||||
|
|
||||||
|
The following active references still mention Pico/UART dashboard terms.
|
||||||
|
|
||||||
|
These are not automatically wrong. Some may be intentional history or handoff notes, but each should be reviewed before the next baseline release.
|
||||||
|
|
||||||
|
| File | Line | Term | Text |
|
||||||
|
|---|---:|---|---|
|
||||||
|
| `tools/pico_desktop_sim.py` | 5 | `pico-dashboard` | sys.path.insert(0, str(ROOT / "pico-dashboard")) |
|
||||||
|
| `docs/project-state.md` | 185 | `Pico dashboard` | There is no planned Pico dashboard path. Existing Pico/UART files are legacy artifacts unless explicitly revived later. |
|
||||||
|
| `docs/project-state.md` | 215 | `UART dashboard` | - Not v1 communications: ESP-NOW, MQTT, UART dashboard link, or CAN between controllers. |
|
||||||
|
| `docs/project-state.md` | 218 | `Pico Dashboard` | ## Pico Dashboard Archive Cleanup |
|
||||||
|
| `docs/project-state.md` | 220 | `pico-dashboard` | The old `pico-dashboard/` implementation has been moved to `archive/legacy-pico-dashboard/`. |
|
||||||
|
| `docs/project-state.md` | 230 | `Pico dashboard` | This replaces the earlier Pico dashboard concept. The Pico dashboard has been archived as reference-only material. |
|
||||||
|
| `docs/HARDWARE.md` | 202 | `Pico dashboard` | This is the active dashboard platform for the project. The previous Pico dashboard implementation has been archived and is reference-only. |
|
||||||
|
| `docs/ARCHITECTURE.md` | 250 | `Pico dashboard` | This replaces the earlier Pico dashboard concept as the active dashboard architecture. |
|
||||||
|
| `docs/CHATGPT_HANDOFF.md` | 157 | `UART dashboard` | - ESP-NOW, MQTT, UART dashboard link, and CAN-between-controllers are not v1 architecture. |
|
||||||
|
| `docs/CHATGPT_HANDOFF.md` | 160 | `Pico Dashboard` | ## Legacy Pico Dashboard Archive |
|
||||||
|
| `docs/CHATGPT_HANDOFF.md` | 162 | `pico-dashboard` | The old Pico dashboard implementation has been archived at `archive/legacy-pico-dashboard/`. |
|
||||||
|
| `docs/dashboard-esp32s3.md` | 156 | `Pico dashboard` | No Pico dashboard is planned. Existing Pico/UART material is legacy unless explicitly revived for diagnostics or alternate hardware. |
|
||||||
|
| `docs/README.md` | 39 | `pico-dashboard` | - `../archive/legacy-pico-dashboard/` - Archived Pico dashboard implementation kept for reference only. |
|
||||||
|
| `docs/UART_PROTOCOL.md` | 7 | `Pico dashboard` | Keep this protocol for diagnostics, simulator work, service tools, or alternate clients. Do not treat it as evidence that a Pico dashboard is planned. |
|
||||||
|
| `docs/UART_PROTOCOL.md` | 164 | `Pico dashboard` | - No Pico dashboard is currently planned. |
|
||||||
|
| `firmware/esp32-s3-dashboard/README.md` | 44 | `Pico UART` | - Pico UART |
|
||||||
|
| `firmware/esp32-s3-dashboard/README.md` | 64 | `Pico dashboard` | This is the current active dashboard target. The archived Pico dashboard is not active firmware. |
|
||||||
|
| `firmware/esp32/overland-controller/config.h` | 21 | `UART dashboard` | // Legacy UART dashboard support is retired from active hardware use. |
|
||||||
|
|
||||||
|
## Current Dashboard Direction
|
||||||
|
|
||||||
|
Active dashboard work targets the Waveshare ESP32-S3 Touch LCD 5B with a 5-inch 1024x600 touchscreen.
|
||||||
|
|
||||||
|
The archived Pico dashboard is retained only for historical reference and should not be treated as active firmware.
|
||||||
|
|
||||||
|
## Existing DS18B20 Support
|
||||||
|
|
||||||
|
DS18B20 temperature sensor support is already implemented in the Cargo ESP/WebUI/API path.
|
||||||
|
|
||||||
|
Future work should focus on preserving and exposing that existing support cleanly through the API contract and dashboard client, not re-adding DS18B20 support from scratch.
|
||||||
Reference in New Issue
Block a user