Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fwartner/ha-openwakeword-installer
Home Assistant Integration to install openWakeWord´s from fwartner/home-assistant-wakewords-collection
https://github.com/fwartner/ha-openwakeword-installer
homeassistant homeassistant-integration openwakeword
Last synced: 2 months ago
JSON representation
Home Assistant Integration to install openWakeWord´s from fwartner/home-assistant-wakewords-collection
- Host: GitHub
- URL: https://github.com/fwartner/ha-openwakeword-installer
- Owner: fwartner
- License: mit
- Created: 2024-05-28T13:14:08.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-23T14:01:23.000Z (6 months ago)
- Last Synced: 2024-11-01T00:22:59.246Z (2 months ago)
- Topics: homeassistant, homeassistant-integration, openwakeword
- Language: Python
- Homepage: https://wartner.io/introducing-the-openwakeword-installer-integration-for-home-assistant/
- Size: 85.9 KB
- Stars: 14
- Watchers: 1
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/hacs/integration)
[](https://github.com/fwartner/ha-openwakeword-installer/actions/workflows/validate.yml)
# 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)](https://hacs.xyz/) 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.
```plaintext
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:
```bash
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.