Andreas Johannsen
aee7106fd5
- keep_docs_dir: false removes the spurious docs/ prefix from URLs (pages now at /lcgui/LCGUI-SPEC/ instead of /lcgui/docs/LCGUI-SPEC/) - Add local lcgui/index.md landing page (mirror repo can't be written) - Fix index.md LCGUI link case: LCGUI/ → lcgui/ Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
# LCGUI
|
|
|
|
**LCGUI** is the LC15 engineering dashboard — a desktop Python GUI that connects to the LC15 inverter firmware over UDP and provides live telemetry, FSM state, fault decoding, command control, and data logging at 100 Hz.
|
|
|
|
## Documents
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Specification](LCGUI-SPEC.md) | Full implementation spec: architecture, widgets, data flow |
|
|
| [Design System](DESIGN.md) | Visual language and UI design reference |
|
|
| [External Contract](EXTERNAL_IMPL.md) | External implementation contract for conforming GUIs |
|
|
| [UDP Injector](INJECTOR.md) | Synthetic telemetry injection for testing |
|
|
| [LC15 HW Communications](LC15-HW-COMMS.md) | Hardware communication layer reference |
|
|
| [Telemetry Interface](telemetry-interface.md) | Telemetry frame format and integration |
|
|
| [UI Spec](15-UI-SPEC.md) | UI component specification |
|
|
|
|
## Protocol Reference
|
|
|
|
Generated from the firmware protocol definitions:
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Protocol Overview](generated/protocol-overview.md) | End-to-end protocol summary |
|
|
| [Telemetry Frame](generated/telemetry-frame.md) | 63-byte telemetry frame spec |
|
|
| [Command Frame](generated/command-frame.md) | Command frame format |
|
|
| [Calibration Frame](generated/calibration-frame.md) | Calibration data frame |
|
|
| [CRC Specification](generated/crc-specification.md) | CRC16-CCITT details |
|
|
| [Derived Metrics](generated/derived-metrics.md) | Computed fields from raw telemetry |
|
|
| [Test Vectors](generated/test-vectors.md) | Protocol test vectors |
|