docs: add waveshare 5b bring-up checklist

2026-06-09 15:23:15 -06:00
parent 16db75f41c
commit a93280fce3
5 changed files with 126 additions and 0 deletions
@@ -53,3 +53,5 @@ The LILYGO T-Relay-S3 6-way board has been ordered as a future Cargo ESP candida
 Current development remains on the 2-channel relay board while the API and docs are prepared for output-count-agnostic operation.

 - `api-v1-audit.md` - Audit of legacy API paths vs `/api/v1` namespace.
+
+- `waveshare-5b-bringup-checklist.md` - Bench bring-up checklist for the Waveshare ESP32-S3 Touch LCD 5B dashboard.
@@ -203,3 +203,17 @@ For v1, the dashboard should consume:
 - Alarm/fault state

 The dashboard may request output changes through the Cargo ESP API, but the Cargo ESP remains the source of truth.
+
+## Waveshare 5B Bring-Up
+
+Use `docs/waveshare-5b-bringup-checklist.md` when the Waveshare ESP32-S3 Touch LCD 5B arrives.
+
+First priority is standalone validation:
+
+- USB/serial detection
+- Display output
+- Touch input
+- Correct 1024x600 target
+- Basic LVGL/demo functionality
+
+Second priority is Cargo ESP API integration over WiFi using `/api/v1`.
@@ -277,3 +277,9 @@ Future planned profile:
    lilygo_t_relay_s3_6ch_wupp

 Current 2-channel testing should continue until the LilyGO board arrives and is bench tested.
+
+## Waveshare 5B Bring-Up Pending
+
+The Waveshare ESP32-S3 Touch LCD 5B is expected next.
+
+Next dashboard work should follow `docs/waveshare-5b-bringup-checklist.md` and start with standalone display/touch validation before any Cargo ESP or vehicle integration.
@@ -0,0 +1,87 @@
+# Waveshare ESP32-S3 Touch LCD 5B Bring-Up Checklist
+
+Use this checklist when the Waveshare ESP32-S3 Touch LCD 5B arrives.
+
+## Hardware Target
+
+Selected dashboard hardware:
+
+- Waveshare ESP32-S3 Touch LCD 5B
+- 5-inch touchscreen
+- 1024x600 display
+- ESP32-S3
+- USB-C
+- Capacitive touch
+- Integrated CAN transceiver available for future vehicle work
+
+## Bring-Up Goal
+
+Confirm the display works as a standalone dashboard platform before integrating it with the Cargo ESP.
+
+Do not connect it to vehicle CAN, WUPP, Cargo ESP wiring, or external sensors during first bring-up.
+
+## First Bench Test
+
+- [ ] Inspect board for shipping damage
+- [ ] Confirm exact board variant is 5B / 1024x600
+- [ ] Connect by USB-C only
+- [ ] Confirm Mac detects the serial/USB device
+- [ ] Flash or run a known-good Waveshare demo first
+- [ ] Confirm display backlight turns on
+- [ ] Confirm 1024x600 display output
+- [ ] Confirm touch input works
+- [ ] Confirm reset button works
+- [ ] Confirm bootloader mode works if needed
+
+Bootloader reminder:
+
+- Hold BOOT
+- Connect USB-C
+- Release BOOT
+- Flash firmware
+- Press RESET after flashing
+
+## Arduino Settings To Verify
+
+When using Arduino examples, verify settings match the 5B hardware:
+
+- Flash: 16MB
+- PSRAM: 8MB OPI / enabled
+- Board package supports ESP32-S3
+- Correct USB/serial port selected
+
+## ESP-IDF / LVGL Notes
+
+The 5B is large enough that UI performance matters.
+
+Early dashboard work should favor:
+
+- Simple LVGL screens
+- Large readable labels
+- Low redraw areas
+- Static layout before animation
+- API polling before complex live graphs
+
+## First Project-Specific Test
+
+Before building the full dashboard, create a simple local screen that shows:
+
+- Dashboard boot status
+- WiFi status placeholder
+- Cargo API base: `/api/v1`
+- Hardware: Waveshare 5B 1024x600
+- Touch test button
+
+## First Cargo ESP Integration Test
+
+After standalone display and touch are confirmed:
+
+- [ ] Connect dashboard to Cargo ESP WiFi AP
+- [ ] Request `/api/v1/status`
+- [ ] Request `/api/v1/config`
+- [ ] Display hardware profile
+- [ ] Display output count
+- [ ] Display relay/output list dynamically
+- [ ] Display DS18B20 temperature telemetry from Cargo ESP API
+
+The dashboard should consume Cargo ESP data. It should not directly own cargo/fridge DS18B20 sensors or relay authority.