openwakeword

CONTAINERS IMAGES RUN BUILD

Home Assistant add-on that uses openWakeWord (demo on huggingface) for wake word detection over the wyoming protocol on NVIDIA Jetson devices. Thank you to @ms1design for contributing these Home Assistant & Wyoming containers!

Features

• Works well with home-assistant-core container on Jetson devices as well as Home Assistant hosted on different hosts
• Use custom wake word's, pass model name as OPENWAKEWORD_PRELOAD_MODEL to preload custom model. For example you can find jetson (jets_un) wake word model included in /share/openwakeword models directory.
• Supports *.tflite CPU wake word models
• Supports *.onnx CUDA wake word models [WIP]

Requires Home Assistant 2023.9 or later.

docker-compose example

If you want to use docker compose to run Home Assistant Core Voice Assistant Pipeline on a Jetson device with cuda enabled, you can find a full example docker-compose.yaml here.

yaml
name: home-assistant-jetson
version: "3.9"
services:
  homeassistant:
    image: dustynv/homeassistant-core:latest-r36.2.0
    restart: unless-stopped
    init: false
    privileged: true
    network_mode: host
    container_name: homeassistant
    hostname: homeassistant
    ports:
      - "8123:8123"
    volumes:
      - ha-config:/config
      - /etc/localtime:/etc/localtime:ro
      - /etc/timezone:/etc/timezone:ro

  openwakeword:
    image: dustynv/wyoming-openwakeword:latest-r36.2.0
    restart: unless-stopped
    runtime: nvidia
    network_mode: host
    container_name: openwakeword
    hostname: openwakeword
    init: false
    ports:
      - "***:***/tcp"
    volumes:
      - ha-openwakeword-custom-models:/share/openwakeword
      - /etc/localtime:/etc/localtime:ro
      - /etc/timezone:/etc/timezone:ro
    environment:
      OPENWAKEWORD_CUSTOM_MODEL_DIR: /share/openwakeword
      OPENWAKEWORD_PRELOAD_MODEL: ok_nabu

volumes:
  ha-config:
  ha-openwakeword-custom-models:

Environment variables

Configuration

Read more how to configure wyoming-openwakeword in the official documentation:

Training custom wake word's

[!NOTE] You can find a custom trained, example jetson (jets_un) wake word model in the custom models directory (/share/openwakeword). To use it, set WAKEWORD_NAME to jets_un in appropriate containers.

The Home Assistant Community has trained numerous wake word models, as detailed in this GitHub repository. However, these models are specifically designed for use with CPU.

To train a new wake word model for CPU (*.tflite) or cuda (*.onnx), you can follow @dscripka documentation or just jump to the point and use wake word training environment.

TODO's

• Build openWakeWord from source based on onnxruntime gpu enabled container (currently openWakeWord is still using tflite models instead onnx)
• Custom Wake Word Models training container using automatic synthetic data creation

Support

Got questions? You have several options to get them answered:

For general Home Assistant Support:

• The Home Assistant *** Chat Server.
• The Home Assistant Community Forum.
• Join the Reddit subreddit in /r/homeassistant
• In case you've found an bug in Home Assistant, please open an issue on our GitHub.

For NVIDIA Jetson based Home Assistant Support:

• The NVIDIA Jetson AI Lab tutorials section.
• The Jetson AI Lab - Home Assistant Integration thread on NVIDIA's Developers Forum.
• In case you've found an bug in jetson-containers, please open an issue on our GitHub.

[!NOTE] This project was created by Jetson AI Lab Research Group.

bash
# automatically pull or build a compatible container image
jetson-containers run $(autotag openwakeword)

# or if using 'docker run' (specify image and mounts/ect)
sudo docker run --runtime nvidia -it --rm --network=host openwakeword:35.2.1

bash
jetson-containers run -v /path/on/host:/path/in/container $(autotag openwakeword)

bash
jetson-containers run $(autotag openwakeword) my_app --abc xyz

bash
jetson-containers build openwakeword