Repository navigation
docs: clarify M5Burner WiFi setup - #4
Merged
Merged
Conversation
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>
Bugbot couldn't run - usage limit reachedBugbot 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
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 athttp://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 SDconfig.ini;#CFGDONEclears NVS so SD stays authoritative. Offline mode (short C on setup page) skips future auto-provisioning.Boot fix:
setup()now queueswifiReconnectPendingwhen 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.