Skip to main content

A plugin to turn a LED on when a wakeword is detected

Project description

PHAL plugin - Wakeword LED

A light (LED) indicator when Open Voice OS is listening and/or speaking.

Video

About

This PHAL plugin interacts with a LED connected to a GPIO to let you know if Open Voice OS is listening. When a wake word is detected the LED turns on and when the audio output is over the LED turns off.

It also possible to configure the plugin to only turn the LED on and off during the listening (not the audio output).

Installation

pip install ovos-phal-plugin-ww-led

Configuration

The plugin configuration file is ~/.config/OpenVoiceOS/ovos-phal-plugin-ww-led.json.

Option Value Description
gpio_pin N/A GPIO PIN where the LED is connected
wakeword_only false Turn on the LED only during the wakeword detection
pulse true Make the LED pulse

Example

Configuration sample of ~/.config/OpenVoiceOS/ovos-phal-plugin-ww-led.json.

{
  "gpio_pin": 25,
  "wakeword_only": false,
  "pulse": true
}

Credits

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos-phal-plugin-ww-led-1.0.0.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

ovos_phal_plugin_ww_led-1.0.0-py3-none-any.whl (8.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page