dustynv/wyoming-openwakeword

openwakeword

容器 镜像 运行 构建

Home Assistant 插件，通过 wyoming协议 使用 https://github.com/rhasspy/wyoming-openwakeword%EF%BC%88huggingface%E6%BC%94%E7%A4%BA%EF%BC%89%E5%9C%A8 NVIDIA Jetson 设备上进行唤醒词检测。感谢 https://github.com/ms1design 贡献了这些Home Assistant和Wyoming容器！

特性

• 与 Jetson设备 上的 https://github.com/dusty-nv/jetson-containers/tree/master/packages/smart-home/homeassistant-core 容器以及不同主机上的Home Assistant兼容
• 支持自定义唤醒词，通过OPENWAKEWORD_PRELOAD_MODEL传递模型名称以预加载自定义模型。例如，/share/openwakeword模型目录中包含jetson（jets_un）唤醒词模型
• 支持 *.tflite CPU 唤醒词模型
• 支持 *.onnx CUDA 唤醒词模型 [开发中]

要求 Home Assistant 2023.9 或更高版本。

docker-compose 示例

如果要在 Jetson 设备上使用docker compose运行启用cuda的https://github.com/dusty-nv/jetson-containers/tree/master/packages/smart-home/homeassistant-core/ 语音助手管道，可参考完整示例 https://github.com/dusty-nv/jetson-containers/tree/master/packages/smart-home/wyoming/docker-compose.yaml%E3%80%82

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:
      - "10400:10400/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:

环境变量

配置

有关wyoming-openwakeword的配置详情，请参考官方文档：

训练自定义唤醒词

[!NOTE] 自定义模型目录（/share/openwakeword）中包含一个已训练的示例jetson（jets_un）唤醒词模型。要使用它，需在相应容器中将WAKEWORD_NAME设置为jets_un。

Home Assistant社区已https://github.com/fwartner/home-assistant-wakewords-collection%EF%BC%8C%E8%AF%A6%E6%83%85%E5%8F%AF%E5%8F%82%E8%80%83%E8%AF%A5GitHub%E4%BB%93%E5%BA%93%E3%80%82%E8%BF%99%E4%BA%9B%E6%A8%A1%E5%9E%8B%E4%B8%93%E4%B8%BA%60CPU%60%E8%AE%BE%E8%AE%A1%E3%80%82

若要训练新的CPU（*.tflite）或cuda（*.onnx）唤醒词模型，可参考https://github.com/dscripka%E7%9A%84https://github.com/dscripka/openWakeWord?tab=readme-ov-file#training-new-models%EF%BC%8C%E6%88%96%E7%9B%B4%E6%8E%A5%E4%BD%BF%E7%94%A8%E5%94%A4%E9%86%92%E8%AF%8D%E8%AE%AD%E7%BB%83%E7%8E%AF%E5%A2%83%E3%80%82

待办事项

• 基于启用gpu的onnxruntime容器从源码构建openWakeWord（目前openWakeWord仍使用tflite模型而非onnx）
• 开发支持自动合成数据生成的自定义唤醒词模型训练容器

支持

如有问题，可通过以下途径获取帮助：

一般Home Assistant支持：

• Home Assistant ***聊天服务器
• Home Assistant 社区论坛
• 加入Reddit子版块/r/homeassistant
• 如发现Home Assistant漏洞，请在https://github.com/home-assistant/addons/issues

NVIDIA Jetson设备上的Home Assistant支持：

• NVIDIA Jetson AI Lab 教程部分
• Jetson AI Lab - Home Assistant集成NVIDIA开发者论坛帖子
• 如发现jetson-containers漏洞，请在https://github.com/dusty-nv/jetson-containers/issues

[!NOTE] 本项目由Jetson AI Lab研究组创建。

bash
# 自动拉取或构建兼容的容器镜像
jetson-containers run $(autotag openwakeword)

# 或使用'docker run'（需指定镜像、挂载等）
sudo docker run --runtime nvidia -it --rm --network=host openwakeword:35.2.1

bash
jetson-containers run -v /主机路径:/容器路径 $(autotag openwakeword)

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

bash
jetson-containers build openwakeword