Skip to content

Assist Pipeline

Donny F edited this page May 23, 2024 · 6 revisions

The Assist Pipeline provides the text to speech, text to speech, and wake word detection for using voice control in Home Assistant. Below are the instructions for installing and configuring. These services are available as HASSOS Addons and Docker containers

Installation

Official Home Assistant version of these instructions: https://www.home-assistant.io/voice_control/voice_remote_local_assistant/

Add the Add-ons

Three add-ons are required for the Assist pipeline. Instructions are for HASSOS but these can also be standard Docker containers.

To start go to Settings > Add-Ons > Add-On Store

Piper

  • Search for Piper (text to speech)
  • Click Piper
  • Click Install
  • When installed, click Start (keep default settings)
  • Once Started, click the Back button to go back to the Add-on Store

Whisper

  • Search for Whisper (speech to text)
  • Click Whisper
  • Click Install
  • When installed, click Start (keep default settings)
  • Once Started, click the Back button to go back to the Add-on Store

openWakeWord

  • Search for openWakeWord (wake)
  • Click openWakeWord
  • Click Install
  • When installed, click Start (keep default settings)
  • Once Started, click the Back button to go back to the Add-on Store

Configure the Integrations

Once the Add-ons are established they will then need to be configured.

To start, click Settings > Devices and Services > Add Integration

Piper

  • Search for Wyoming Protocol and click Wyoming Protocol
  • In "Want to add these discovered devices?", click Piper
  • When prompted to confirm "Do you want to configure Home Assistant to connect to the Wyoming service provided by the add-on: Piper?", click Submit
  • Click Finish on the Success! information box

Whisper

  • Click Add Integration
  • Search for Wyoming Protocol and click Wyoming Protocol
  • In "Want to add these discovered devices?", click Whisper
  • When prompted to confirm "Do you want to configure Home Assistant to connect to the Wyoming service provided by the add-on: Whisper?", click Submit
  • Click Finish on the Success! information box

openWakeWord

  • Click Add Integration
  • Search for Wyoming Protocol and click Wyoming Protocol
  • In "Want to add these discovered devices?", click openWakeWord
  • When prompted to confirm "Do you want to configure Home Assistant to connect to the Wyoming service provided by the add-on: openWakeWord?", click Submit
  • Click Finish on the Success! information box

Configure the Assist Pipeline

In the final step we will pull everything together with the Assist Voice Assistant configuration

To start, click Settings > Voice Assistants > Either use the existing Home Assistant or create a new Assistant

Configuration

  • Give your assistant a name or leave it as Home Assistant
  • Choose Language (default is English)

Conversation Agent

  • Choose Home Assistant
  • Choose Language (default is English)

Speech-to-text

  • Choose faster-whisper

Text-to-speech

  • Choose piper
  • Choose language (default is en_US)
  • Choice voice (any will do, try them using the Try Voice button)

Wakeword

  • Choose openWakeWord for the engine
  • Choose any wake word you want (default is ok nabu)

Click Create or Update when done


Special thanks to @mngarchow for the written instructions and continued support

View Assist Old Wiki

Clone this wiki locally