mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
S3-BOX: update installation tutorial to reflect current firmware (#31513)
* S3-BOX: update installation tutorial to reflect current firmware * Fix typo * Add steps on customizing on-device wake word * Fix markdown * Customize: add prereqs - add reference to microWakeWord - Streamline on-device vs local terminology * S3-BOX tutorial: amend prereqs and steps * Update 'About wake word' topic * Fix markdown * Tweaks to align with blog post * Shorten intro section * Fix link * Fix terminology * Improve cohesion * fix terminology * Fix links * Fix more links * Streamline terminology on S3-BOX-3 * Apply suggestions from code review Co-authored-by: JLo <jlpouffier@hey.com> * Restructure side TOC * Add aliases to side TOC * Remove illustration * Delete source/images/assist/assist_open-vs-micro-wake-word.png --------- Co-authored-by: JLo <jlpouffier@hey.com> Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
This commit is contained in:
c0ffeeca7
GitHub
parent
6d99427bba
commit
49093492e7
@ -20,6 +20,7 @@
|
||||
<li>{% active_link /voice_control/about_wake_word/ About wake words %}</li>
|
||||
<li>{% active_link /voice_control/builtin_sentences/ Built-in sentences %}</li>
|
||||
<li>{% active_link /voice_control/custom_sentences/ Custom sentences %}</li>
|
||||
<li>{% active_link /voice_control/aliases/ Using aliases %}</li>
|
||||
<li>{% active_link /voice_control/using_tts_in_automation/ Using Piper TTS in automations %}</li>
|
||||
<li>{% active_link /voice_control/assist_create_open_ai_personality/ Creating a personality with OpenAI %}</li>
|
||||
</ul>
|
||||
@ -28,10 +29,10 @@
|
||||
<div class="section">
|
||||
<h1 class="title delta">Projects</h1>
|
||||
<ul class="divided sidebar-menu">
|
||||
<li>{% active_link /voice_control/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/thirteen-usd-voice-remote/ Tutorial: $13 voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/s3_box_voice_assistant/ Tutorial: ESP32-S3-BOX voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/s3-box-customize/ Tutorial: Customize the S3-BOX with your own illustrations %}</li>
|
||||
<li>{% active_link /voice_control/s3-box-customize/ Tutorial: Customize the S3-BOX %}</li>
|
||||
<li>{% active_link /voice_control/thirteen-usd-voice-remote/ Tutorial: $13 voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/create_wake_word/ Tutorial: Create your own wake word %}</li>
|
||||
<li>{% active_link /voice_control/assist_daily_summary/ Tutorial: Your daily summary by Assist %}</li>
|
||||
</ul>
|
||||
|
||||
@ -3,9 +3,9 @@
|
||||
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).
|
||||
- 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)
|
||||
- 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 %}
|
||||
|
||||
BIN
source/images/assist/wake_word_engine_location.png
Normal file
BIN
source/images/assist/wake_word_engine_location.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
@ -78,9 +78,28 @@ How wake words integrate into Home Assistant
|
||||
|
||||
As an example, we’re also making the **Porcupine (v1)** wake word engine available. It supports 29 wake words across English, French, Spanish, and German. The wake words include *Computer*, *Framboise*, *Manzana*, and *Stachelschwein*.
|
||||
|
||||
## About on-device wake word processing (microWakeWord)
|
||||
|
||||
The [microWakeWord](https://github.com/kahrendt/microWakeWord) created by [Kevin Ahrendt](https://www.kevinahrendt.com/) enables ESPHome to detect wake words on devices like the ESP32-S3-BOX-3.
|
||||
|
||||
Because openWakeWord is too large to run on low-power devices like the S3-BOX-3, openWakeWord runs wake word detection on the Home Assistant server.
|
||||
|
||||
Doing wake word detection on Home Assistant allows low-power devices like the [M5 ATOM Echo Development Kit](/voice_control/thirteen-usd-voice-remote/) to simply stream audio and let all of the processing happen elsewhere.
|
||||
The downside is that adding more voice assistants requires more CPU usage in Home Assistant as well as more network traffic.
|
||||
|
||||
Enter *microWakeWord*; a more light-weight model based on [Google's Inception neural network](https://towardsdatascience.com/a-simple-guide-to-the-versions-of-the-inception-network-7fc52b863202). Because his new model is not as large, it can be run on low-power devices with an ESP32 chip, such as the ESP32-S3 chip inside the S3-BOX-3! _(It also works on the, now discontinued, S3-BOX and S3-BOX-Lite)_.
|
||||
|
||||
Currently, there are [three models](https://github.com/esphome/micro-wake-word-models/tree/main/models) trained for microWakeWord:
|
||||
|
||||
- *okay nabu*
|
||||
- *hey jarvis*
|
||||
- *alexa*
|
||||
|
||||
## Try it!
|
||||
|
||||
To try wake words today, follow the guide to the [$13 voice assistant][13-tutorial].
|
||||
Right now, there are two easy options to get started with wake words:
|
||||
- Follow the guide to the [$13 voice assistant][13-tutorial]. This tutorial is using the tiny ATOM Echo, detecting wake words with openWakeWord.
|
||||
- Follow the guide to set up an [ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/). This tutorial is using the bigger S3-BOX-3 device which features a display. It can detect wake words using openWakeWord. But it can also do on-device wake word detection using microWakeWord.
|
||||
|
||||
## Related topics
|
||||
|
||||
|
||||
@ -1,9 +1,11 @@
|
||||
---
|
||||
title: "Customize the S3-BOX-3 with your own illustrations"
|
||||
title: "Customize the S3-BOX-3"
|
||||
product_name: ESP32-S3-BOX-3
|
||||
device_name_entry: ESP32-S3-BOX-3
|
||||
---
|
||||
|
||||
## Customize the S3-BOX-3 with your own illustrations
|
||||
|
||||
This tutorial will show you how to replace the Home Assistant status illustrations on the Espressif [ESP32-S3-BOX-3](https://www.espressif.com/en/news/ESP32-S3-BOX-3) with your own images.
|
||||
|
||||
You can either prepare your own illustrations or import some from a community repository.
|
||||
@ -11,7 +13,7 @@ You can either prepare your own illustrations or import some from a community re
|
||||
<lite-youtube videoid="HQQfaXTbhvc" videotitle="Okay Frenck! Open-source voice assistant running on an Espressif ESP32-S3-Box
|
||||
"></lite-youtube>
|
||||
|
||||
## ESP32-S3-BOX-3 voice assistant status illustrations
|
||||
### ESP32-S3-BOX-3 voice assistant status illustrations
|
||||
|
||||
The ESP32-S3-BOX-3 voice assistant has 6 illustrations to indicate its state:
|
||||
|
||||
@ -22,14 +24,14 @@ The ESP32-S3-BOX-3 voice assistant has 6 illustrations to indicate its state:
|
||||
|
||||
The chart shows the default illustrations. The next steps show you how to change those.
|
||||
|
||||
## Prerequisites
|
||||
### Prerequisites
|
||||
|
||||
- Latest version of Home Assistant, installed with the Home Assistant Operating System
|
||||
- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/) or a manually configured [Assist Pipeline](/voice_control/voice_remote_local_assistant)
|
||||
- [ESP32-S3-BOX-3](https://www.aliexpress.us/item/1005005920207976.html?gatewayAdapt=4itemAdapt). The ESP32-S3-BOX-Lite or the ESP32-S3-BOX also work, but they are not currently on the market.
|
||||
- Successfully completed the [ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/) tutorial
|
||||
|
||||
## Adopting the device in the ESPHome add-on
|
||||
### Adopting the device in the ESPHome add-on
|
||||
|
||||
Before you can import new illustrations, you need to install the ESPHome add-on and adopt the device in the add-on.
|
||||
|
||||
@ -47,12 +49,12 @@ Before you can import new illustrations, you need to install the ESPHome add-on
|
||||
- [Option 1: Using images from a community repository](#option-1-using-images-from-a-community-repository)
|
||||
- [Option 2: Using your own images](#option-2-using-your-own-illustrations)
|
||||
|
||||
## Option 1: Using images from a community repository
|
||||
### Option 1: Using images from a community repository
|
||||
|
||||
If you want new images but don't want to create your own, you can use images from the community.
|
||||
If you want to use your own images, skip this procedure and go to [Option 2: Using your own imagess](#option-2-using-your-own-illustrations) instead.
|
||||
|
||||
### To use images from the community
|
||||
#### To use images from the community
|
||||
|
||||
1. On the **ESP32-S3-BOX-3** add-on, select edit.
|
||||
- **Result**: An editor opens, showing the configuration file.
|
||||
@ -79,18 +81,18 @@ If you want to use your own images, skip this procedure and go to [Option 2: Usi
|
||||
5. Once the installation is complete, you can see the new image on the ESP32-S3-BOX-3.
|
||||
- Now, speak a command to test the new setting. For example, *OK Nabu, turn off the living room lights*.
|
||||
|
||||
## Option 2: Using your own illustrations
|
||||
### Option 2: Using your own illustrations
|
||||
|
||||
There are 2 parts to this:
|
||||
|
||||
- [Preparing your own illustrations](#to-prepare-your-own-images)
|
||||
- [Adding your illustrations to the configuration](#to-add-your-images-to-the-configuration)
|
||||
|
||||
### About the image specifications
|
||||
#### About the image specifications
|
||||
|
||||
Here's what you need to know to get the best result on your ESP32-S3-BOX-3 screen.
|
||||
|
||||
#### Using light and dark image background
|
||||
##### Using light and dark image background
|
||||
|
||||
In the [overview diagram](#esp32-s3-box-3-voice-assistant-status-illustrations), you can see that the default images use different background colors. This is to make it easier to recognize a state change when you look at your screen.
|
||||
|
||||
@ -102,12 +104,12 @@ In your images, you could use 2 different background colors:
|
||||
|
||||
If your images have transparency, you can define the background color in the configuration. The procedure below shows how to change the background.
|
||||
|
||||
#### Image dimensions and file format
|
||||
##### Image dimensions and file format
|
||||
|
||||
- **Dimensions**: The screen is 320 x 240 pixels. If the image you provide is not in a 4:3 ratio, the remaining area will be filled with background color.
|
||||
- **File format**: PNG, JPEG, or SVG
|
||||
|
||||
### To prepare your own images
|
||||
#### To prepare your own images
|
||||
|
||||
1. Create your own images according to the specifications defined in the section [About the image specifications](#about-the-image-specifications).
|
||||
- You could even draw your own!
|
||||
@ -121,7 +123,7 @@ If your images have transparency, you can define the background color in the con
|
||||
- Copy your image folder in there.
|
||||
|
||||
|
||||
### To add your images to the configuration
|
||||
#### To add your images to the configuration
|
||||
|
||||
1. In Home Assistant, go to [**Settings** > **Add-ons** > **ESPHome**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome), and **Open Web UI**.
|
||||
2. On the **ESP32-S3-BOX-3** add-on, select edit.
|
||||
@ -176,6 +178,43 @@ If your images have transparency, you can define the background color in the con
|
||||
- Snap a picture of each.
|
||||
- [Follow these steps](#to-prepare-your-own-images) to bring them onto your Voice Assistant.
|
||||
|
||||
## 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.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Home Assistant 2024.2, installed with the Home Assistant Operating System. If you do not have Home Assistant installed yet, refer to the [installation page](/installation/) for instructions.
|
||||
- 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 GB of RAM
|
||||
- The firmware needs to be compiled on the server before it is installed on the S3-BOX-*.
|
||||
- Compiling requires a bit of RAM.
|
||||
|
||||
(It also works on the, now discontinued, S3-BOX and S3-BOX-Lite)_
|
||||
|
||||
### To customize the S3-BOX-* 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**.
|
||||
3. On the **ESP32-S3-BOX-3** entry, select edit.
|
||||
- **Result**: An editor opens, showing the configuration file.
|
||||
|
||||
|
||||
4. To change the wake word, add the following line into the `substitutions` block.
|
||||
- Instead of `okay_nabu`, you can also use `alexa` or `hey_jarvis`.
|
||||
|
||||
```yaml
|
||||
substitutions:
|
||||
...
|
||||
micro_wake_word_model: okay_nabu
|
||||
```
|
||||
|
||||
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*.
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Community image repository](https://github.com/jlpouffier/home-assistant-s3-box-community-illustrations/tree/main)
|
||||
@ -185,3 +224,7 @@ If your images have transparency, you can define the background color in the con
|
||||
- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
|
||||
- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
|
||||
- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
|
||||
- [microWakeWord](https://github.com/kahrendt/microWakeWord)
|
||||
|
||||
[microWakeWord]: https://github.com/kahrendt/microWakeWord
|
||||
[Kevin Ahrendt]: https://www.kevinahrendt.com/
|
||||
@ -12,9 +12,8 @@ This tutorial will guide you to turn an ESP32-S3-BOX, ESP32-S3-BOX-3, or an ESP3
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Home Assistant 2023.12, 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.12 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 GHz Wi-Fi network
|
||||
- Chrome or Edge browser on a desktop (not Android/iOS)
|
||||
- One of the three Espressif ESP32-S3-BOX variants:
|
||||
@ -46,7 +45,18 @@ Before you can use this device with Home Assistant, you need to install a bit of
|
||||
|
||||
- Your ESP32-S3-BOX 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 via a ESP32 device with a display. Now give some commands.
|
||||
10. If you want, you can process the wake word on the ESP32-S3 device, rather than on your Home Assistant server. (The server is the device where Home Assistant is installed, for example on Home Assistant Green).
|
||||
- Under **Devices**, on the ESP32-S3-BOX-3 entry, select **Device** to open the device page.
|
||||
- Under **Wake word engine location**, select **On device**, if you want your wake word to be processed on the device itself, and not in Home Assistant.
|
||||
- Local processing is faster.
|
||||
- The wake word is now *Okay Nabu*.
|
||||
|
||||
|
||||
|
||||
11. If you chose on-device wake word, but you do not want to use *Okay Nabu*, you can change the on-device wake word.
|
||||
- Currently, *Hey Jarvis* or *Alexa* are the supported alternatives.
|
||||
- To change your wake word, follow the steps in [Customizing the S3-BOX-3 with on-device wake words](/voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword).
|
||||
12. Congratulations! You can now voice control Home Assistant via a ESP32 device with a display. Now give some commands.
|
||||
|
||||
## Controlling Home Assistant
|
||||
|
||||
@ -77,8 +87,8 @@ Before you can use this device with Home Assistant, you need to install a bit of
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Enable a wake word](/voice_control/install_wake_word_add_on/)
|
||||
- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
|
||||
- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
|
||||
- [ESPHome projects page](https://esphome.io/projects/index.html)
|
||||
- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
|
||||
- [Customizing the S3-BOX with on-device wake words](/voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user