assist-microphone

CONTAINERS IMAGES RUN BUILD

Home Assistant add-on that uses wyoming-satellite for remote voice satellite using 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
• Uses the wyoming-openwakeword container to detect wake words
• Uses the wyoming-whisper container to handle STT
• Uses the wyoming-piper container to handle TTS

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

  assist-microphone:
    image: dustynv/wyoming-assist-microphone:latest-r36.2.0
    restart: unless-stopped
    network_mode: host
    container_name: assist-microphone
    hostname: assist-microphone
    runtime: nvidia
    init: false
    ports:
      - "***:***/tcp"
    devices:
      - /dev/snd:/dev/snd
      - /dev/bus/usb
    volumes:
      - ha-assist-microphone:/share
      - /etc/localtime:/etc/localtime:ro
      - /etc/timezone:/etc/timezone:ro
    environment:
      SATELLITE_AUDIO_DEVICE: "plughw:CARD=S330,DEV=0"
      SATELLITE_SND_VOLUME_MULTIPLIER: 0.3
      WAKEWORD_NAME: "ok_nabu"
      ASSIST_PIPELINE_NAME: "Home Assistant"

volumes:
  ha-config:
  ha-assist-microphone:

Environment variables

Configuration

Read more how to configure wyoming-assist-microphone in the official documentation.

Determine Audio Devices

Picking the correct microphone/speaker devices is critical for the satellite to work.

List your available microphones with:

bash
arecord -L

List your available speakers with:

bash
aplay -L

You should see similar output to below for both commands:

bash
plughw:CARD=seeed2micvoicec,DEV=0
    seeed-2mic-voicecard, bcm2835-i2s-wm8960-hifi wm8960-hifi-0
    Hardware device with all software conversions

Prefer ones that start with plughw: or just use default if you don't know what to use. It's recommended to choose Microphone and Speaker which has Hardware device with all software conversions notation. Set the environment variable SATELLITE_AUDIO_DEVICE to:

bash
plughw:CARD=seeed2micvoicec,DEV=0

wyoming-assist-microphone uses the same device for Mic as Speaker.

TODO's

• Investigate whether the user should see the transcription of voice commands and responses in the Home Assistant Assist Chat popup when the name of the conversational pipeline is passed as ASSIST_PIPELINE_NAME.
• Split SATELLITE_AUDIO_DEVICE into SATELLITE_MIC_DEVICE and SATELLITE_SND_DEVICE to allow selection of different audio hardware combinations.

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 assist-microphone)

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

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

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

bash
jetson-containers build assist-microphone