Skip to content

docs: clarify M5Burner WiFi setup - #4

Merged
DrDavidDa merged 1 commit into
mainfrom
agents/sync-with-latest-github-repo
Sep 14, 2026
Merged

DrDavidDa merged 1 commit into
mainfrom
agents/sync-with-latest-github-repo

Conversation

@DrDavidDa

@DrDavidDa DrDavidDa commented Sep 14, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • document phone-based WiFi provisioning for M5Burner users
  • add offline mode instructions and SD card config template
  • include exact paths, filename, FAT32, and config.ini.txt troubleshooting

Validation

  • pio run (success)
  • hardware firmware already flashed and serial responsive

Note

Medium Risk
Changes boot WiFi behavior and stores WiFi passwords in NVS/SD via a new HTTP provisioning surface; mistakes could affect connectivity or credential precedence vs script-written config.

Overview
Adds on-device WiFi provisioning so M5Burner users can configure network from a phone without a PC, SD prep, or reflash.

Firmware starts a SoftAP (PaperColor-XXXXXX) with captive portal (WebServer + DNSServer), scan/save form at http://192.168.4.1, on-screen QR code (ricmoo/QRCode), and a connection state machine (NTP/RTC sync on success, auto-exit after 10s). Entry: boot with no credentials, QR page long-press B, or serial #WIFIAP. Credentials persist in NVS and mirror to SD config.ini; #CFGDONE clears NVS so SD stays authoritative. Offline mode (short C on setup page) skips future auto-provisioning.

Boot fix: setup() now queues wifiReconnectPending when credentials exist (NVS then SD/config), instead of only connecting after standby wake.

Docs: docs/m5burner-quick-start.md, config.ini.example, and README/CHANGELOG updated for phone-first setup vs SD backup.

Reviewed by Cursor Bugbot for commit 3b918bc. Bugbot is set up for automated code reviews on this repo. Configure here.

Add a beginner-friendly phone provisioning guide and a verified SD config template. Clarify offline use, SD card paths, file naming, and the fact that M5Burner does not configure WiFi automatically.\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@DrDavidDa
DrDavidDa merged commit 90571eb into main Sep 14, 2026
1 check passed
@cursor

cursor Bot commented Sep 14, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_868c8a82-75dc-4194-b30d-4bcc7fd9166e)

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