docs.md

Home Assistant add-on that uses wyoming-faster-whisper for speech-to-text system 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
• GPU accelerated on Jetson Devices thanks to faster-whisper container

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.

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

  whisper:
    image: dustynv/wyoming-whisper:latest-r36.2.0
    restart: unless-stopped
    runtime: nvidia
    network_mode: host
    container_name: faster-whisper
    hostname: faster-whisper
    init: false
    ports:
      - "10300:10300/tcp"
    volumes:
      - ha-whisper-models:/share/whisper
      - ha-whisper-data:/data
      - /etc/localtime:/etc/localtime:ro
      - /etc/timezone:/etc/timezone:ro

volumes:
  ha-config:
  ha-whisper-models:
  ha-whisper-data:

Environment variables

Variable	Type	Default	Description
WHISPER_PORT	str	10300	Port number to use on host
WHISPER_MODEL	str	tiny-int8	Name of faster-whisper model to use from supported models list
WHISPER_BEAM_SIZE	int	1	Beam size
WHISPER_LANGUAGE	str	en	Default language to set for transcription from supported languages list
WHISPER_DEBUG	bool	true	Log DEBUG messages

Configuration

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

TODO's

• Testing

Support

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

For general Home Assistant Support:

• The Home Assistant Discord 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.