Checkpoint current docs, BLE setup workflow, and generic config refactor

2026-06-04 04:03:00 -06:00
parent cb7a98080c
commit ff39a06ff4
4 changed files with 1164 additions and 54 deletions
@@ -0,0 +1,208 @@
+# CHANGELOG.md
+
+# Changelog
+
+All notable changes to Overland Controller will be documented in this file.
+
+The format loosely follows Keep a Changelog principles.
+
+---
+
+# [0.3.0] - 2026-06-04
+
+## Major Changes
+
+### Project Renaming
+
+- Renamed project from Xterra Controller to Overland Controller
+- Updated firmware naming
+- Updated repository naming
+- Updated documentation naming
+- Began removal of vehicle-specific assumptions
+
+### Generic Configuration Architecture
+
+Removed hardcoded installation-specific values from firmware.
+
+Firmware now uses generic identifiers:
+
+Relays:
+
+text id="4xvc8l" relay_1 relay_2 
+
+Temperature sensors:
+
+text id="xq2e8v" temp_1 temp_2 temp_3 temp_4 temp_5 temp_6 temp_7 temp_8 
+
+Installation-specific names now belong in saved configuration.
+
+### JSON Status API Improvements
+
+Reworked status response format.
+
+Changed from:
+
+json id="k8l5yx" {   "temps": {     "outside": 72.0   } } 
+
+To:
+
+json id="k3g0ey" {   "temps": [     {       "id": "temp_1",       "name": "Outside",       "temperature_f": 72.0     }   ] } 
+
+Benefits:
+
+- Dynamic sensor support
+- Generic architecture
+- Easier dashboard integration
+- Better future scalability
+
+### Relay Status Improvements
+
+Relay reporting converted to structured arrays.
+
+Example:
+
+json id="wh1f5k" {   "id": "relay_1",   "name": "Aux Power",   "state": false } 
+
+### BMS Integration
+
+Implemented:
+
+- JBD BLE communication
+- Xiaoxiang compatibility
+- Cell voltage reporting
+- SOC reporting
+- Current reporting
+- Capacity reporting
+- Temperature reporting
+- Cycle count reporting
+
+### BLE Setup Workflow
+
+Added:
+
+- Setup mode
+- BLE device scanning
+- BMS selection
+- Persistent BMS storage
+
+Known limitation:
+
+- Some BMS devices advertise infrequently and may require multiple scans before appearing.
+
+### Documentation
+
+Added:
+
+- README.md
+- API.md
+- SERIAL_COMMANDS.md
+- HARDWARE.md
+- ARCHITECTURE.md
+- CHANGELOG.md
+
+---
+
+# [0.2.x]
+
+## Initial Controller Development
+
+Implemented:
+
+- ESP32 firmware framework
+- Relay control
+- Configuration storage
+- Access Point mode
+- Web server
+- UART communications
+- JSON status reporting
+
+---
+
+# [0.1.x]
+
+## Project Foundation
+
+Initial proof-of-concept work.
+
+Implemented:
+
+- Repository structure
+- ESP32 firmware skeleton
+- Basic relay testing
+- Initial dashboard communications concept
+
+---
+
+# Upcoming
+
+## Planned for 0.4.x
+
+### Dashboard Development
+
+- Pico 2 W integration
+- Dashboard communications
+- Touchscreen support
+- Relay control interface
+
+### Temperature System
+
+- Sensor assignment workflow
+- Sensor discovery workflow
+- Improved diagnostics
+
+### Configuration System
+
+- Expanded configuration API
+- Additional runtime configuration
+- Improved validation
+
+### Documentation
+
+- Installation guide
+- Wiring guide
+- Development guide
+
+---
+
+## Planned for 0.5.x
+
+### Vehicle Integration
+
+Potential support for:
+
+- OBD-II
+- ELM327
+- CAN Bus
+
+### Data Logging
+
+Potential support for:
+
+- Historical battery data
+- Historical temperature data
+- Event logging
+
+### Integrations
+
+Potential support for:
+
+- MQTT
+- Home Assistant
+- Grafana
+- InfluxDB
+
+---
+
+## Long-Term Roadmap
+
+Potential future capabilities:
+
+- GPS support
+- Route logging
+- Multi-controller support
+- OTA updates
+- Alerting system
+- Mobile-friendly dashboard
+- Remote monitoring
+
+The roadmap is intentionally flexible and may change as the project evolves.