mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
Add procedure on configuring a cloud voice assistant (#29557)
* Add procedure on configuring a cloud voice assistant - make procedure on installing the openWakeWord add-on - a standalone procedure - reference this procedure in related procedures * Add missing link * Apply suggestions from code review Co-authored-by: Michael Hansen <hansen.mike@gmail.com> --------- Co-authored-by: Michael Hansen <hansen.mike@gmail.com>
This commit is contained in:
c0ffeeca7
GitHub
parent
05f87c72d6
commit
0f1d7c9c98
@ -14,7 +14,9 @@
|
||||
<ul class="divided sidebar-menu">
|
||||
<li>{% active_link /voice_control/using_voice_assistants_overview/ Voice assistants: Overview %}</li>
|
||||
<li>{% active_link /voice_control/voice_remote_local_assistant/ Configuring a local assistant %}</li>
|
||||
<li>{% active_link /voice_control/voice_remote_cloud_assistant/ Configuring a cloud assistant %}</li>
|
||||
<li>{% active_link /voice_control/voice_remote_expose_devices/ Exposing devices to voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/install_wake_word_add_on/ Installing the openWakeWord add-on %}</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/using_tts_in_automation/ Using Piper TTS in automations %}</li>
|
||||
|
||||
BIN
source/images/assist/assistants_ha_cloud.png
Normal file
BIN
source/images/assist/assistants_ha_cloud.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
24
source/voice_control/install_wake_word_add_on.markdown
Normal file
24
source/voice_control/install_wake_word_add_on.markdown
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Installing the openWakeWord add-on"
|
||||
---
|
||||
|
||||
To use wake words, you need to install the openWakeWord add-on.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Home Assistant version 2023.10 or later, installed with the Home Assistant Operating System
|
||||
|
||||
## Installing the openWakeWord add-on
|
||||
|
||||
1. Go to {% my supervisor_addon addon="core_openwakeword" title="**Settings** > **Add-ons** > **openWakeWord**" %} and select **Install**.
|
||||
2. Start the add-on.
|
||||
3. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
|
||||
- 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.
|
||||
5. If you do not like the available options, you can [create your own wake word](/voice_control/create_wake_word/).
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Create your own wake words](/voice_control/create_wake_word/)
|
||||
@ -18,32 +18,23 @@ your smart home. Issue commands and get responses!
|
||||
- [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
|
||||
|
||||
## Installing the openWakeWord add-on
|
||||
|
||||
As a first step, you need to install the openWakeWord add-on. This must be installed before setting up the ATOM Echo.
|
||||
|
||||
1. Go to {% my supervisor_addon addon="core_openwakeword" title="**Settings** > **Add-ons** > **openWakeWord**" %} and select **Install**.
|
||||
2. Start the add-on.
|
||||
3. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
|
||||
- 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.
|
||||
|
||||
## Adding a wake word to 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.
|
||||
1. Install the openWakeWord add-on:
|
||||
- Follow steps 1-3 of the procedure on [installing the openWakeWord add-on](/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).
|
||||
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**.
|
||||
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.
|
||||
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/).
|
||||
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/).
|
||||
|
||||
## Installing the software onto the ATOM Echo
|
||||
|
||||
|
||||
51
source/voice_control/voice_remote_cloud_assistant.markdown
Normal file
51
source/voice_control/voice_remote_cloud_assistant.markdown
Normal file
@ -0,0 +1,51 @@
|
||||
---
|
||||
title: "Creating a cloud Assist pipeline"
|
||||
---
|
||||
|
||||
In Home Assistant, the Assist pipelines are made up of various components that together form a voice assistant.
|
||||
|
||||
You can use Assist out of the box by typing into its text field. But the main goal is to use a voice command. A speech-to-text engine is used so that you can speak to the assistant. For Assist to be able to talk to you, you need to set up a text-to-speech engine. You can use these engines fully locally on your own hardware. To learn how, [follow this procedure](/voice_control/create_wake_word/).
|
||||
|
||||
If you have Home Assistant Cloud, there is a default assistant set up automatically. The advantage of using Home Assistant Cloud is that there is more powerful hardware at play. This makes for faster processing and an overall more smooth experience. This procedure shows how to tweak the settings of the assistant that is set up with Home Assistant Cloud.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- In this procedure, Home Assistant Cloud will be used
|
||||
- Home Assistant Cloud is a paid subscription. It helps run servers and pay for things like development and security audits. If you just want to try this for the fun of it, you can start a free 1 month trial and then cancel.
|
||||
|
||||
## Setting up a cloud Assist pipeline
|
||||
|
||||
To have the fastest processing voice assistant experience, follow these steps:
|
||||
|
||||
1. If you haven't done this already, [enable Home Assistant Cloud](https://www.nabucasa.com/config/).
|
||||
2. As soon as you're connected to Home Assistant Cloud, a voice assistant has been created for you.
|
||||
- This voice assistant is using text-to-speech and speech-to-text engines based on the region settings of your Home Assistant user.
|
||||
3. To view the settings, go to {% my voice_assistants title="**Settings** > **Voice assistants**" %} and under **Assist**, select **Home Assistant Cloud**.
|
||||
|
||||
|
||||
- **Troubleshooting**: If you do not see any assistants here, you are not using the default configuration. In this case, you need to add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
assist_pipeline:
|
||||
```
|
||||
4. If the predefined language settings work for you, skip the next step.
|
||||
5. If you want to make some changes:
|
||||
- If you like, change the name. You can pick any name that is meaningful to you.
|
||||
- If you do not agree with the predefined language, select the language that you want to speak.
|
||||
- Under **Conversation agent**, select **Home Assistant**.
|
||||
- Under **Speech-to-text**, select the language you want to speak.
|
||||
- Under **Text-to-speech**, select the language you want Assist to use when speaking to you.
|
||||
- Depending on your language, you may be able to select different language variants.
|
||||
- If you want to use a wake word, [install the openWakeWord add-on](/voice_control/install_wake_word_add_on/).
|
||||
|
||||
6. That's it. You can now speak to your device, and the device can answer in the language you defined.
|
||||
7. If you haven't done so yet, [expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices).
|
||||
- Otherwise you won't be able to control them by voice.
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Enable Home Assistant Cloud](https://www.nabucasa.com/config/)
|
||||
- [Installing the openWakeWord add-on](/voice_control/install_wake_word_add_on/)
|
||||
- [Create your own wake word](/voice_control/create_wake_word/)
|
||||
- [Expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices)
|
||||
Loading…
x
Reference in New Issue
Block a user