ATOM Echo: remove Wi-Fi creds from device #39291
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new section was added to the documentation, detailing the procedure for removing Wi-Fi credentials from the ATOM Echo device without affecting the installed firmware. The instructions guide users through connecting the device via USB-C and using a web interface to erase user data. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Browser
participant ATOM_Echo
User->>Browser: Open web page in Chromium-based browser
User->>ATOM_Echo: Connect via USB-C
User->>Browser: Click web serial connection button
Browser->>User: Show serial port selection dialog
User->>Browser: Select ATOM Echo serial port
Browser->>ATOM_Echo: Establish serial connection
User->>Browser: Select "Erase user data" option
Browser->>ATOM_Echo: Send erase command
ATOM_Echo-->>Browser: Confirm Wi-Fi credentials erased
Browser-->>User: Notify completion (firmware remains)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/voice_control/thirteen-usd-voice-remote.markdown (2)
112-114: Avoid Repetition of Prerequisite StepsStep 1 in this section (“Make sure this page is opened…”) duplicates earlier instructions in “Installing the software.” Consider referencing the previous section instead of repeating, for DRYness—e.g.:
“Follow steps 1–3 in Installing the software above.”
118-122: Improve User Guidance for Erase ActionAfter connecting, step 3 simply says “select Erase user data.” Adding a screenshot of the dialog or clarifying where that option lives (e.g., in the pop-up menu under the “Actions” dropdown) would help users locate it more easily.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/voice_control/thirteen-usd-voice-remote.markdown(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/voice_control/thirteen-usd-voice-remote.markdown (3)
108-109: Consistent Heading Level and SpacingThe new section uses a
##heading, which aligns with other top-level subsections like “Prerequisites.” Good presence of a blank line after the heading for readability.
115-117: Verify Web Serial Button BehaviorYou’re reusing the
<esp-web-install-button>with the same manifest to trigger “Erase user data.” Please confirm that this control supports the erase flow out of the box and not just flashing firmware. If not, you may need to switch to a different component or add amode="erase"attribute.
123-124: Clear Outcome DescriptionStating that “Your Wi-Fi credentials are deleted… The firmware stays on the device.” succinctly clarifies the result. This aligns with user expectations.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit