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-05-07 03:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/voice_control/install_wake_word_add_on.markdown

3.3 KiB
Raw Blame History

title
title
Enabling a wake word

This tutorial shows how you can enable a wake word in Home Assistant. It does not describe how to use it.

To use the wake word, you need some extra hardware. A low cost option is the M5Stack ATOM Echo Development Kit. To set that up, follow the $13 voice assistant for Home Assistant.

To enable a wake word

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

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.

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 or a manually configured Assist pipeline.
  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.

Related topics

About wake words and assistants

Extra hardware to use wake word