Skip to content

docs: add settings reference with access channels and safety flags#88

Merged
basmeerman merged 1 commit intomasterfrom
work/settings-reference
Mar 19, 2026
Merged

docs: add settings reference with access channels and safety flags#88
basmeerman merged 1 commit intomasterfrom
work/settings-reference

Conversation

@basmeerman
Copy link
Copy Markdown
Owner

Summary

Add comprehensive settings reference appendix to docs/configuration.md with:

  • Access channel matrix for every setting: LCD, Web UI, REST API, MQTT — read/write per channel
  • 14 safety-relevant settings flagged with ⚠ warnings and explanations (MODE, MAX, MIN, MAINS, CIRCUIT, MaxSumMains, PWR SHARE, CONTACT 2, LOCK, RCMON, MAX TEMP, Override current, CP PWM override, MainsMeter timeout)
  • 14 setting categories: charging control, current limits, solar/smart, access/security, phase control, meters, hardware, scheduling, network/MQTT, OCPP, LED colors, diagnostics, read-only status, persistence
  • NVS persistence info — which settings survive reboot and which don't
  • Safety recommendation — configure safety-critical settings via LCD during installation

This was intended to be part of PR #87 but was missed during merge.

Test plan

  • Documentation-only change — no code modified
  • Settings cross-checked against source code (main.h, mqtt_parser.c, http_api.c, esp32.cpp)

🤖 Generated with Claude Code

Add complete settings reference covering all SmartEVSE settings with:
- Access channel matrix (LCD, Web UI, REST API, MQTT) per setting
- Read/write capability per channel
- Safety-relevant settings flagged with warnings
- NVS persistence info (survives reboot or not)
- Read-only status values section
- Safety summary with recommendations

14 categories covering charging control, current limits, solar/smart,
access/security, phase control, meters, hardware, scheduling, network,
OCPP, LED colors, diagnostics, and status values.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@basmeerman basmeerman merged commit 37fadff into master Mar 19, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant