ATOM Echo: replace steps by wizard #39294

c0ffeeca7 · 2025-05-28T13:43:02Z

Proposed change

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Updated setup instructions to describe a wizard for customizing the wake word and voice selection.
- Generalized example wake word to reflect user configuration.
- Corrected and clarified navigation paths and setting names for silence detection.
- Streamlined and renumbered steps for improved clarity.

netlify · 2025-05-28T13:43:06Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`b0f07ec`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/683712e827816d0008aff96d
😎 Deploy Preview	https://deploy-preview-39294--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-05-28T13:43:09Z

📝 Walkthrough

Walkthrough

The setup instructions for the ATOM Echo device in Home Assistant were updated to describe a wizard-based customization process, clarify device connection steps, generalize the wake word example, and correct minor textual details regarding configuration navigation and terminology.

Changes

File	Change Summary
source/voice_control/thirteen-usd-voice-remote.markdown	Updated setup instructions to describe a customization wizard, generalized wake word example, and corrected navigation/setting names.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant ATOM_Echo

    User->>HomeAssistant: Start device setup
    HomeAssistant->>User: Launch customization wizard
    User->>HomeAssistant: Define wake word and choose voice
    User->>HomeAssistant: Select "Done"
    HomeAssistant->>ATOM_Echo: Connect over Wi-Fi
    ATOM_Echo-->>HomeAssistant: Confirm connection
    HomeAssistant->>User: Display confirmation and next steps

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

source/voice_control/thirteen-usd-voice-remote.markdown (2)
73-73: Fix grammar in wizard description.

The sentence “This starts the a wizard to customize the your voice assistant.” contains redundant determiners. It should read:
6. This starts a wizard to customize your voice assistant.
🧰 Tools

🪛 LanguageTool

[grammar] ~73-~73: Two determiners in a row. Choose either “the” or “a”.
Context: ...sp32-atom-flash-07.png) 6. This starts the a wizard to customize the your voice assi...

(DT_DT)

[grammar] ~73-~73: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “your”?
Context: .... This starts the a wizard to customize the your voice assistant. - Follow the wizard...

(A_MY)

81-81: Improve example emphasis.

For consistency with other docs, consider using backticks or italics for the example wake word. E.g.:
1. Say the wake word you configured. For example, use _OK, Nabu_.

📜 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

📥 Commits

Reviewing files that changed from the base of the PR and between 0e54fd7 and b0f07ec.

⛔ Files ignored due to path filters (1)

source/images/assist/esp32-atom_silence_detection_01.png is excluded by !**/*.png

📒 Files selected for processing (1)

source/voice_control/thirteen-usd-voice-remote.markdown (2 hunks)

🧰 Additional context used

🪛 LanguageTool

source/voice_control/thirteen-usd-voice-remote.markdown

[grammar] ~73-~73: Two determiners in a row. Choose either “the” or “a”.
Context: ...sp32-atom-flash-07.png) 6. This starts the a wizard to customize the your voice assi...

(DT_DT)

[grammar] ~73-~73: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “your”?
Context: .... This starts the a wizard to customize the your voice assistant. - Follow the wizard...

(A_MY)

🔇 Additional comments (2)

source/voice_control/thirteen-usd-voice-remote.markdown (2)

74-75: Approve wizard steps formatting.

The new instructions to follow the wizard steps and select Done are clear and consistent with the updated setup flow.

93-94: Verify integration path and setting names.

Please confirm that the macro {% my integrations title="**Settings** > **Devices & services**" %} and the label Finished speaking detection match exactly what users see in the UI.

frenck

Thanks, @c0ffeeca7 👍

../Frenck

ATOM Echo: replace steps by wizard

b0f07ec

home-assistant bot added the current This PR goes into the current branch label May 28, 2025

coderabbitai bot reviewed May 28, 2025

View reviewed changes

frenck approved these changes May 28, 2025

View reviewed changes

frenck merged commit 7a43fe1 into current May 28, 2025
9 checks passed

frenck deleted the atom-echo-replace-steps-by-wizard branch May 28, 2025 15:09

github-actions bot locked and limited conversation to collaborators May 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

ATOM Echo: replace steps by wizard #39294

ATOM Echo: replace steps by wizard #39294

Uh oh!

c0ffeeca7 commented May 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented May 28, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 28, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

frenck left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ATOM Echo: replace steps by wizard #39294

ATOM Echo: replace steps by wizard #39294

Uh oh!

Conversation

c0ffeeca7 commented May 28, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

netlify bot commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

c0ffeeca7 commented May 28, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented May 28, 2025 •

edited

Loading

coderabbitai bot commented May 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)