diff --git a/source/_includes/voice_assistant/add_wake_word_to_voice_assistant.md b/source/_includes/voice_assistant/add_wake_word_to_voice_assistant.md deleted file mode 100644 index 2be59e4c672..00000000000 --- a/source/_includes/voice_assistant/add_wake_word_to_voice_assistant.md +++ /dev/null @@ -1,16 +0,0 @@ - -1. Install the openWakeWord add-on: - - Follow steps 1-3 of the procedure on [enabling a wake word](/voice_control/install_wake_word_add_on). -2. Go to {% my voice_assistants title="**Settings** > **Voice assistants**" %} and select **Add assistant**. -3. Give your assistant a name, for example the wake word you are going to use. -4. Select the language you are going to use to speak to Home Assistant. - - If the **Text-to-speech** and **Speech-to-text** sections do not provide language selectors, this means you do not have an Assist pipeline set up. - - Set up [Home Assistant Cloud](https://www.nabucasa.com) or a manually configured [Assist pipeline](/voice_control/voice_remote_local_assistant). -5. Under **Text-to-speech**, select the language and voice you want Home Assistant to use when speaking to you. -6. To define the wake word engine, under **Wake word**, select **openWakeWord**. - - Then, select **ok nabu**. - - If you created a new assistant, select **Create**. - - If you edited an existing assistant, select **Update**. - - **Result**: You now have a voice assistant that listens to a wake word. -7. For the first run, it is recommended to use **ok nabu**, just to test the setup. - - Once you have it all set up, you can [create your own wake words](/voice_control/create_wake_word/). diff --git a/source/images/assist/s32-s3-box-3-discovered.png b/source/images/assist/s32-s3-box-3-discovered.png new file mode 100644 index 00000000000..ecbe0cc5551 Binary files /dev/null and b/source/images/assist/s32-s3-box-3-discovered.png differ diff --git a/source/voice_control/install_wake_word_add_on.markdown b/source/voice_control/install_wake_word_add_on.markdown index d13b723e2ec..36e60a45d31 100644 --- a/source/voice_control/install_wake_word_add_on.markdown +++ b/source/voice_control/install_wake_word_add_on.markdown @@ -2,11 +2,15 @@ title: "Enabling a wake word" --- -To use wake words, you need to install the openWakeWord add-on. +Enabling a wake word consists of 2 steps: + +1. Installing the openWakeWord add-on. +2. Enabling the wake word for a specific voice assistant. ## Prerequisites - Home Assistant version 2023.10 or later, installed with the Home Assistant Operating System +- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/) or a manually configured [local Assist pipeline](/voice_control/voice_remote_local_assistant) ## Installing the openWakeWord add-on @@ -16,12 +20,26 @@ To use wake words, you need to install the openWakeWord add-on. - Under **Discovered**, you should now see the **Wyoming** integration. - Select **Configure** and **Submit**. - **Result**: You have successfully installed the openWakeWord add-on and Wyoming integration. -4. Under {% my voice_assistants title="**Settings** > **Voice assistants**" %}, when you select a voice assistant, in the **Wake word** section, you should now see the wake word options that are available out of the box. - ![Select wake word](/images/blog/2023-10-12-year-of-the-voice-chapter-4/pick-wake-word.png) -5. If you do not like the available options, you can [create your own wake word](/voice_control/create_wake_word/). + +## Enabling wake word for your voice assistant + +1. Go to {% my voice_assistants title="**Settings** > **Voice assistants**" %} and select **Add assistant**. +2. Give your assistant a name, for example the wake word you are going to use. +3. Select the language you are going to use to speak to Home Assistant. + - If the **Text-to-speech** and **Speech-to-text** sections do not provide language selectors, this means you do not have an Assist pipeline set up. + - Set up [Home Assistant Cloud](https://www.nabucasa.com) or a manually configured [Assist pipeline](/voice_control/voice_remote_local_assistant). +4. Under **Text-to-speech**, select the language and voice you want Home Assistant to use when speaking to you. +5. To define the wake word engine, under **Wake word**, select **openWakeWord**. + - Then, select **ok nabu**. + - If you created a new assistant, select **Create**. + - If you edited an existing assistant, select **Update**. + - **Result**: You now have a voice assistant that listens to a wake word. +6. For the first run, it is recommended to use **ok nabu**, just to test the setup. + - Once you have it all set up, you can [create your own wake words](/voice_control/create_wake_word/). ## Related topics - [Create your own wake words](/voice_control/create_wake_word/) - [About wake words](/voice_control/about_wake_word/) - [Create a cloud assistant](/voice_control/voice_remote_cloud_assistant/) +- [Create a local assistant](/voice_control/voice_remote_local_assistant) diff --git a/source/voice_control/s3_box_voice_assistant.markdown b/source/voice_control/s3_box_voice_assistant.markdown index e806ee91e90..0f405d5802c 100644 --- a/source/voice_control/s3_box_voice_assistant.markdown +++ b/source/voice_control/s3_box_voice_assistant.markdown @@ -13,7 +13,8 @@ This tutorial will guide you to turn an ESP32-S3-BOX-3 into a Home Assistant voi ## 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) +- [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: @@ -21,10 +22,6 @@ This tutorial will guide you to turn an ESP32-S3-BOX-3 into a Home Assistant voi - ESP32-S3-BOX or ESP32-S3-BOX-Lite (not currently on the market) - USB-C cable to connect the ESP32-S3-BOX-3 -## Adding a wake word to your voice assistant - -{% include voice_assistant/add_wake_word_to_voice_assistant.md %} - ## Installing the software onto the ESP32-S3-BOX-3 Before you can use this device with Home Assistant, you need to install a bit of software on it. @@ -44,10 +41,12 @@ Before you can use this device with Home Assistant, you need to install a bit of {% include voice_assistant/install_esp_firmware.md %} -9. 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. -10. Congratulations! You can now voice control Home Assistant via a ESP32 device with a display. Now give some commands. +9. Select the **ESPHome** integration. Under **Devices**, you should see the **ESP32-S3-BOX-3** listed. + ![ESP32-S3-BOX-3 discovered](/images/assist/s32-s3-box-3-discovered.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. + +10. Congratulations! You can now voice control Home Assistant via a ESP32 device with a display. Now give some commands. ## Controlling Home Assistant @@ -69,7 +68,7 @@ Before you can use this device with Home Assistant, you need to install a bit of - 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. +2. If you want to just use the wake word, but do not want to use the screen, you can turn it off. - Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration. - Under **ESP32-S3-BOX-3**, select **1 device**. - Disable **LCD Backlight**. @@ -78,9 +77,8 @@ Before you can use this device with Home Assistant, you need to install a bit of ## Related topics -- [Create your own wake words](/voice_control/create_wake_word/) +- [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) -- [Using a sentence trigger](/voice_control/custom_sentences/) diff --git a/source/voice_control/thirteen-usd-voice-remote.markdown b/source/voice_control/thirteen-usd-voice-remote.markdown index a6f68421640..7ef240c91fc 100644 --- a/source/voice_control/thirteen-usd-voice-remote.markdown +++ b/source/voice_control/thirteen-usd-voice-remote.markdown @@ -15,16 +15,13 @@ your smart home. Issue commands and get responses! ## Prerequisites - Home Assistant 2023.10, 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) +- [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 a Chromium-based browser like Edge) on desktop (not Android/iOS) - [M5Stack ATOM Echo Development Kit](https://shop.m5stack.com/products/atom-echo-smart-speaker-dev-kit?ref=NabuCasa) - USB-C cable to connect the ATOM Echo -## Adding a wake word to your voice assistant - -{% include voice_assistant/add_wake_word_to_voice_assistant.md %} - ## Installing the software onto the ATOM Echo Before you can use this device with Home Assistant, you need to install a bit of software on it. @@ -108,7 +105,10 @@ Are things not working as expected? ## Related topics +- [Enable a wake word](/voice_control/install_wake_word_add_on/) - [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/) +- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/) +- [Manually configured Assist pipeline](/voice_control/voice_remote_local_assistant) \ No newline at end of file