Skip to content

smartgic/ovos-phal-plugin-ww-led

Repository files navigation

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