jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Assist: update ATOM Echo tutorial (#34263)

Browse Source
This commit is contained in:
c0ffeeca7 2024-08-12 14:57:56 +02:00 committed by GitHub
parent 2e0db60ac3
commit 9374fd5bc2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 35 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/_includes/voice_assistant/install_esp_firmware.md
View File

@ -1,33 +0,0 @@
{% capture product_name %}{{ include.name | default: page.product_name }}{% endcapture %}
2. To connect the {{ product_name }} to your computer, follow these steps:
- In the pop-up window, view the available ports.
- Plug the USB-C cable into the {{ product_name }} and connect it to your computer.{% if page.product_name == 'ESP32-S3-BOX' %}
- If you have an ESP32-S3-BOX-3, plug it into the box directly, not into the docking station (not into the blue part).
- **Troubleshooting**: If your ESP32-S3-BOX-3 does not appear in the list of devices presented by your browser, you need to manually invoke "flash mode":
- Hold the "boot" button (left side upper button) as you tap the "reset" button (left side lower button).
- After a few seconds, the ESP32-S3-BOX-3 should appear in the list of USB devices presented by your browser.
- Follow the steps until step 3. After selecting the **Next** button, on the S3-Box, tap the "Reset" button again.
- Then, select the blue **Connect button** again, select the USB device and follow the prompts to configure the Wi-Fi.{% endif %}
- In the pop-up window, there should now appear a new entry. Select this USB serial port and select **Connect**.{% if page.product_name == 'ATOM Echo' %}
- **Troubleshooting**: If no new port shows, your system may be missing a driver. Close the pop-up window.
- In the dialog, select the CH342 driver, install it, then **Try again**.
![Open My link](/images/assist/esp32-atom-flash-no-port.png){% endif %}
3. Select **Install Voice Assistant**, then **Install**.
- Once the installation is complete, select **Next**.
- Add the {{ product_name }} to your Wi-Fi:
- When prompted, select your network from the list and enter the credentials to your 2.4 GHz Wi-Fi network.
- Select **Connect**.
- The {{ product_name }} now joined your network. Select **Add to Home Assistant**.
4. This opens the **My** link to Home Assistant.
- If you have not used My Home Assistant before, you will need to configure it. If your Home Assistant URL is not accessible on `http://homeassistant.local:8123`, replace it with the URL to your Home Assistant instance.
- Open the link.
![Open My link](/images/assist/esp32-atom-flash-06.png)
5. Select **OK**.
![Set up ESPHome](/images/assist/esp32-atom-flash-07.png)
6. To add the newly discovered device, select the {{ product_name }} from the list.
- Add your {{ product_name }} to a room and select **Finish**.
7. You should now see the **ESPHome** integration.
![New ESPHome device discovered](/images/assist/m5stack-atom-echo-discovered-33.png)

BIN
source/images/assist/esp32-atom_silence_detection_01.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 49 KiB

57
source/voice_control/thirteen-usd-voice-remote.markdown
View File

@ -20,8 +20,7 @@ related:
title: Access to your configuration files
---
This tutorial will guide you to turn an ATOM Echo into the
world's most private voice assistant. Pick up the tiny device to talk to
This tutorial will guide you to turn an ATOM Echo into a voice assistant. Pick up the tiny device to talk to
your smart home. Issue commands and get responses!
<lite-youtube videoid="ziebKt4XLZQ" videotitle="Wake word demo on $13 ATOM Echo in Home Assistant
@ -29,7 +28,7 @@ your smart home. Issue commands and get responses!
## Prerequisites
- Home Assistant 2023.10, installed with the Home Assistant Operating System. If you do not have Home Assistant installed yet, refer to the [installation page](/installation/) for instructions.
- Home Assistant 2023.10 or later, installed with the Home Assistant Operating System. If you do not have Home Assistant installed yet, refer to the [installation page](/installation/) for instructions.
- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/) or a manually configured [Assist Pipeline](/voice_control/voice_remote_local_assistant)
- Have [enabled a wake word](/voice_control/install_wake_word_add_on/) for your voice assistant
- The password to your 2.4&nbsp;GHz Wi-Fi network
@ -48,11 +47,37 @@ Before you can use this device with Home Assistant, you need to install a bit of
<esp-web-install-button manifest="https://firmware.esphome.io/wake-word-voice-assistant/m5stack-atom-echo/manifest.json"></esp-web-install-button>
- **For advanced users**: The configuration file is available on [GitHub](https://github.com/esphome/wake-word-voice-assistants/blob/main/m5stack-atom-echo/m5stack-atom-echo.yaml).
{% include voice_assistant/install_esp_firmware.md %}
9. Select the **ESPHome** integration. Under **Devices**, you should see the **M5Stack Atom Echo** listed.
2. To connect the ATOM Echo to your computer, follow these steps:
- In the pop-up window, view the available ports.
- Plug the USB-C cable into the ATOM Echo and connect it to your computer.
- In the pop-up window, there should now appear a new entry. Select this USB serial port and select **Connect**.
- **Troubleshooting**: If no new port shows, your system may be missing a driver. Close the pop-up window.
- In the dialog, select the CH342 driver, install it, then **Try again**.
![Open My link](/images/assist/esp32-atom-flash-no-port.png)
3. Select **Install Voice Assistant**, then **Install**.
- Once the installation is complete, select **Next**.
- Add the ATOM Echo to your Wi-Fi:
- When prompted, select your network from the list and enter the credentials to your 2.4&nbsp;GHz Wi-Fi network.
- Select **Connect**.
- The ATOM Echo now joined your network. Select **Add to Home Assistant**.
4. This opens the **My** link to Home Assistant.
- If you have not used My Home Assistant before, you will need to configure it. If your Home Assistant URL is not accessible on `http://homeassistant.local:8123`, replace it with the URL to your Home Assistant instance.
- Open the link.
![Open My link](/images/assist/esp32-atom-flash-06.png)
5. Select **OK**.
![Set up ESPHome](/images/assist/esp32-atom-flash-07.png)
6. To add the newly discovered device, select the ATOM Echo from the list.
- Add your ATOM Echo to a room and select **Finish**.
7. You should now see the **ESPHome** integration.
![New ESPHome device discovered](/images/assist/m5stack-atom-echo-discovered-33.png)
8. Select the **ESPHome** integration. Under **Devices**, you should see the **M5Stack Atom Echo** listed.
![ATOM Echo discovered](/images/assist/m5stack-atom-echo-discovered-new-03.png)
- Your ATOM Echo is connected to Home Assistant over Wi-Fi. You can now move it to any place in your home with a USB power supply.
10. Congratulations! You can now voice control Home Assistant using a button with a built-in microphone. Now give some commands.
9. Congratulations! You can now voice control Home Assistant. Now give some commands.
## Controlling Home Assistant over the ATOM Echo
@ -67,24 +92,12 @@ Before you can use this device with Home Assistant, you need to install a bit of
- *Which lights are on in the living room?*
3. Your command is not supported? Add your own commands using [a sentence trigger](/voice_control/custom_sentences/).
4. You find ATOM Echo takes too long to start processing your command?
- Adjust the silence detection settings. This setting defines how much silence is needed for Assist to find you're done speaking and it can start processing your command.
- Adjust the silence detection settings.
- Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration.
- Under **M5Stack ATOM Echo**, select **1 device**.
![Open My link](/images/assist/esp32-atom_silence_detection_01.png)
- Under **M5Stack ATOM Echo**, select **1 device**. Under **Configuration**, change the **Finish speaking detection**.
- This setting defines how much silence is needed for Assist to find you're done speaking and it can start processing your command.
## Disabling wake word and use push-to-talk
1. If you do not want to use a wake word, but prefer to use the microphone by pressing a button, you can disable the wake word.
2. Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration.
- Under **M5Stack ATOM Echo**, select **1 device**.
3. Disable **Use wake word**.
![Toggle to enable/disable wake word](/images/assist/wake_word_disable_on_atom_echo.png)
4. To start using push-to-talk, press the flat button with rounded shape on your ATOM Echo.
- The rectangular button on the side is the reset button. Do not press that one.
- As soon as you press the button, the LED will start blinking in blue. If it does not light up, press again.
- While you are speaking, the blue LED is pulsing.
- Once the intent has been processed, the LED lights up in green and Home Assistant confirms the action.
![Open My link](/images/assist/esp32-atom_silence_detection_01.png)
## Troubleshooting