/ha-openwakeword-installer

Home Assistant Integration to install openWakeWord´s from fwartner/home-assistant-wakewords-collection

Primary LanguagePythonMIT LicenseMIT

hacs_badge Validate GitHub all releases GitHub GitHub issues by-label GitHub contributors

OpenWakeWord Installer Integration for Home Assistant

The OpenWakeWord Installer integration for Home Assistant allows you to easily manage and update wake words for your smart home setup. This integration periodically checks a specified GitHub repository for new wake words and updates them automatically.

Features

  • 🔄 Automatic Updates: Periodically check for and update wake words from a GitHub repository.
  • 📁 Customizable Folder Path: Specify a subfolder within the repository to narrow down the search for wake words.
  • 🔍 Sensor Status: Monitor the update status with a dedicated sensor.
  • 🛠️ Manual Update Service: Trigger manual updates through Home Assistant services.

Installation

Installation via HACS

  1. Ensure HACS is Installed

    Make sure you have the Home Assistant Community Store (HACS) installed. If not, follow the instructions on the HACS website to install it.

  2. Add Custom Repository

    • Open HACS in your Home Assistant instance.
    • Go to Integrations.
    • Click on the three dots in the top right corner and select Custom repositories.
    • Add the following URL to the repository field: https://github.com/fwartner/ha-openwakeword-installer and select Integration as the category.
    • Click Add.

  3. Install the Integration

    • Search for OpenWakeWord in the HACS Integrations section.
    • Click Install.

  4. Restart Home Assistant

    Restart Home Assistant to load the new integration.

  5. Configure the Integration

    • Go to Configuration -> Integrations.
    • Click on the "+" button and search for "WakeWord Installer".
    • Follow the setup instructions to configure the repository URL and optional folder path.

Manual Installation

  1. Download the Integration

    Download the openwakeword directory and place it in the custom_components directory within your Home Assistant configuration directory.

    custom_components/
    wakeword_installer/
        ├── __init__.py
        ├── config_flow.py
        ├── const.py
        ├── update.py
        ├── manifest.json
        ├── services.yaml
        └── translations/
            ├── en.json
            ├── de.json
            ├── it.json
            ├── es.json
            └── nl.json

  2. Install Dependencies

    Ensure the required dependencies are installed by running:

    pip install gitpython

  3. Restart Home Assistant

    Restart Home Assistant to load the new integration.

  4. Configure the Integration

    • Go to Configuration -> Integrations.
    • Click on the "+" button and search for "WakeWord Installer".
    • Follow the setup instructions to configure the repository URL and optional folder path.

Configuration

Configuration Options

  • Repository URL: URL of the GitHub repository containing the wake words.
  • Folder Path: (Optional) Subfolder within the repository to search for wake words.