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-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

S3-BOX-3: change on-device wake word procedure (#31554)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
c0ffeeca7 2024-02-22 12:52:30 +01:00 committed by GitHub
parent 0813461aee
commit c662e4586e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
source/voice_control/s3-box-customize.markdown
View File

@ -180,7 +180,12 @@ If your images have transparency, you can define the background color in the con
## Customizing on-device wake words (microWakeWord)
If you are running the latest version of ESPHome on your device, you can already process your wake word on your S3-BOX (instead of running it on the Home Assistant server). This is done using the [microWakeWord](https://github.com/kahrendt/microWakeWord) model. By default, the wake word then is *Okay Nabu*. If you want to change the on-device wake word to *Hey Jarvis* or *Alexa*, follow these steps.
You can change the on-device wake word (microWakeWord) that is used on your S3-BOX-3.
Do the following steps if one of the following options apply:
- **Option 1**: Your first installation of the S3-BOX-3 is ESPHome 2024.2. In this case, it already supports the on-device wake word *Hey Jarvis*. Follow these steps only if you want to change the wake word. The currently supported on-device wake words are *Okay Nabu*, *Hey Jarvis*, or *Alexa*.
- **Option 2**: You have an existing S3-BOX-3 running an older version of ESPHome. In this case, the S3-BOX-3 is not updated automatically to support on-device wake word. Follow these steps if you want to update the firmware to process your wake word on your S3-BOX-3, instead of running it on the Home Assistant server. This is done using the [microWakeWord](https://github.com/kahrendt/microWakeWord) model.
### Prerequisites
@ -188,12 +193,12 @@ If you are running the latest version of ESPHome on your device, you can already
- Successfully [installed ESPHome on the S3-BOX-3](/voice_control/s3_box_voice_assistant/)
- ESPHome 2024.2 or later
- Home Assistant server with at least 2&nbsp;GB of RAM
- The firmware needs to be compiled on the server before it is installed on the S3-BOX-*.
- The firmware needs to be compiled on the server before it is installed on the S3-BOX-3.
- Compiling requires a bit of RAM.
(It also works on the, now discontinued, S3-BOX and S3-BOX-Lite)_
*(It also works on the (now discontinued) S3-BOX and S3-BOX-Lite)*
### To customize the S3-BOX-* with on-device wake words
### To customize the S3-BOX-3 with on-device wake words
1. If you haven't done so already, [adopt the device in the ESPHome add-on](#adopting-the-device-in-the-esphome-add-on).
2. In Home Assistant, go to [**Settings** > **Add-ons** > **ESPHome**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome), and **Open Web UI**.
@ -212,8 +217,15 @@ If you are running the latest version of ESPHome on your device, you can already
5. Save the changes and in the top right corner, select **Install**.
- Depending on your environment, the installation process can take a while. (On Home Assistant Green, for example, it takes about 45 minutes.)
- On Home Assistant Green, for example, it takes about 45 minutes.86. Once the installation is complete, you can see the new image on the S3-BOX-3.
6. - Now, speak a command to test the new setting. For example, *OK Nabu, turn on the light*.
- On Home Assistant Green, for example, it takes about 45 minutes.
- Once the installation is complete, you can see the new image on the S3-BOX-3.
6. Select the **ESPHome** integration. Under **Devices**, you should see the **ESP32-S3-BOX** listed.
- On the ESP32-S3-BOX-3 entry, select **Device** to open the device page.
- Under **Wake word engine location**, select **On device**.
![ESP32-S3-BOX-3 on device wake word processing](/images/assist/wake_word_engine_location.png)
7. - Now, speak a command to test the new setting. For example, *OK Nabu, turn on the light*.
## Related topics