diff --git a/source/_includes/asides/voice_navigation.html b/source/_includes/asides/voice_navigation.html index 94db543939d..8baaa5ebab7 100644 --- a/source/_includes/asides/voice_navigation.html +++ b/source/_includes/asides/voice_navigation.html @@ -31,6 +31,7 @@ diff --git a/source/_includes/voice_assistant/install_esp_firmware.md b/source/_includes/voice_assistant/install_esp_firmware.md index 5933698676c..860705371dc 100644 --- a/source/_includes/voice_assistant/install_esp_firmware.md +++ b/source/_includes/voice_assistant/install_esp_firmware.md @@ -4,9 +4,7 @@ - In the pop-up window, view the available ports. - Plug the USB-C cable into the {{ product_name }} 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**. - - Depending on your computer, the entry might look different. - ![Select USB port](/images/assist/esp32-atom-flash-select-port.png) - - If no new port shows, your system may be missing a driver. Close the pop-up window. + - **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**. @@ -22,7 +20,7 @@ 5. Select **OK**. ![Set up ESPHome](/images/assist/esp32-atom-flash-07.png) -6. If, at this stage, a dialog opens, prompting you to enter the connection settings of your ESPHome node, it means there is already a configuration set up for that ESPHome device. +6. **Troubleshooting**: If, at this stage, a dialog opens, prompting you to enter the connection settings of your ESPHome node, it means there is already a configuration set up for that ESPHome device. - Close the dialog and perform the procedure on [deleting the {{ product_name }} configuration from ESPHome]({{ config_link }}). - Restart Home Assistant. - Then, under {% my integrations title="**Settings** > **Devices & Services**" %}, your {{ product_name }} should be discovered. diff --git a/source/_includes/voice_assistant/install_esp_firmware_delete_firmware.md b/source/_includes/voice_assistant/install_esp_firmware_delete_firmware.md index 07748325782..52bb43cfe11 100644 --- a/source/_includes/voice_assistant/install_esp_firmware_delete_firmware.md +++ b/source/_includes/voice_assistant/install_esp_firmware_delete_firmware.md @@ -6,6 +6,7 @@ 1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and select the ESPHome integration. - Under **Devices**, next to the **{{device_name_entry}}** entry, select the three-dots menu. - Select **Delete**. + ![Delete the S3_Box from the device list](/images/assist/esp32-devices-delete-01.png) 2. Make sure you have [access to the configuration files](/common-tasks/os/#configuring-access-to-files). - If you have never done this before, [install the file editor add-on](/common-tasks/os/#installing-and-using-the-file-editor-add-on). 3. Access the config files and open the **esphome** folder. diff --git a/source/images/assist/esp32-devices-delete-01.png b/source/images/assist/esp32-devices-delete-01.png new file mode 100644 index 00000000000..8732120eedd Binary files /dev/null and b/source/images/assist/esp32-devices-delete-01.png differ diff --git a/source/images/assist/s3-box-disable-screen.png b/source/images/assist/s3-box-disable-screen.png new file mode 100644 index 00000000000..cb0cce36201 Binary files /dev/null and b/source/images/assist/s3-box-disable-screen.png differ diff --git a/source/images/assist/wake_word_disable.png b/source/images/assist/wake_word_disable.png new file mode 100644 index 00000000000..fa7ea05db84 Binary files /dev/null and b/source/images/assist/wake_word_disable.png differ diff --git a/source/voice_control/s3_box_voice_assistant.markdown b/source/voice_control/s3_box_voice_assistant.markdown new file mode 100644 index 00000000000..879f060b3df --- /dev/null +++ b/source/voice_control/s3_box_voice_assistant.markdown @@ -0,0 +1,85 @@ +--- +title: "ESP32-S3-BOX-3 voice assistant" +product_name: ESP32-S3-BOX-3 +device_name_entry: ESP32-S3-BOX-3 +config_link: /voice_control/s3_box_voice_assistant/#to-delete-the-ESP32-S3-BOX-3-configuration-from-esphome +--- + +This tutorial will guide you to turn an ESP32-S3-BOX-3 into a Home Assistant voice assistant. + + + +## Prerequisites + +- Home Assistant 2023.12, installed with the Home Assistant Operating System +- [Home Assistant Cloud](https://www.nabucasa.com) or a manually configured [Assist Pipeline](/voice_control/voice_remote_local_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: + - [ESP32-S3-BOX-3](https://www.aliexpress.us/item/1005005920207976.html?gatewayAdapt=4itemAdapt) + - ESP32-S3-BOX or ESP32-S3-BOX-Lite (they are not currently on the market) +- USB-C cable to connect the ESP32-S3-BOX-3 + +{% include voice_assistant/add_wake_word_to_voice_assistant.md %} + +## Installing the software onto the ESP32-S3-BOX-3 + +If you have used the ESP32-S3-BOX-3 on Home Assistant before and have it installed via ESPHome add-on, you first need to remove its configuration. + +{% include voice_assistant/install_esp_firmware_delete_firmware.md %} + +### To install the software on your ESP32-S3-BOX-3 + +Before you can use this device with Home Assistant, you need to install a bit of software on it. + +1. While keeping this tutorial page open, open the [ESPHome projects page](https://esphome.io/projects/index.html) in a Chrome or Edge browser on a desktop. It does not work on a tablet or phone. + - In the **I want to create a** section, select **Voice assistant**. + - Select the image of the ESP32-S3-BOX-3. + - From the list, select the product variant that you have. + - Select the **Connect** button. If your browser does not support web serial, you will see a warning instead of a button. + - **For advanced users**: The configuration files are available on GitHub: + - [ESP32-S3-BOX](https://github.com/esphome/firmware/blob/main/voice-assistant/esp32-s3-box.yaml) + - [ESP32-S3-BOX-3](https://github.com/esphome/firmware/blob/main/voice-assistant/esp32-s3-box-3.yaml) + - [ESP32-S3-BOX-Lite](https://github.com/esphome/firmware/blob/main/voice-assistant/esp32-s3-box-lite.yaml) + +{% include voice_assistant/install_esp_firmware.md %} + +1. Select the **ESPHome** integration. Under **Devices**, you should see the **ESP32-S3-BOX-3** listed. + ![ESP32-S3-BOX-3 discovered](/images/assist/m5stack-atom-echo-discovered-new-03.png) + - Your ESP32-S3-BOX-3 is connected to Home Assistant over Wi-Fi. You can now move it to any place in your home with a USB power supply. +2. Congratulations! You can now voice control Home Assistant via a ESP32 device with a display. Now give some commands. + +## Controlling Home Assistant + +1. Say your wake word. For this tutorial, use "OK, Nabu". +2. Say a [supported voice command](/voice_control/builtin_sentences/). For example, *Turn on the light*. + - Once the intent has been processed, the LED lights up in green and Home Assistant confirms the action. + - Make sure you’re using the area name exactly as you defined it in Home Assistant. + - You can also ask a question, such as + - *Is the front door locked?* + - *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/). + +## Turning off microphone or screen + +1. If you do not want to Assist to listen for a while, you can turn off the microphone. + - Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration. + - Under **ESP32-S3-BOX-3**, select **1 device**. + - Enable **Mute**. + - The screen of the ESP32-S3-BOX-3 will turn off, too. + + ![Toggle to enable/disable Mute](/images/assist/wake_word_disable.png) +2. If you want to just use the wake word, but do not want to use see the screen, you can turn off the screen. + - Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration. + - Under **ESP32-S3-BOX-3**, select **1 device**. + - Disable **LCD Backlight**. + + ![Toggle to enable/disable wake word](/images/assist/s3-box-disable-screen.png) + +## Related topics + +- [Create your own wake words](/voice_control/create_wake_word/) +- [General troubleshooting section for Assist](/voice_control/troubleshooting/) +- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files) +- [Using a sentence trigger](/voice_control/custom_sentences/)