# PHAL Linear LED Plugin
Enables interaction with LEDs in a one-dimensional physical arrangement.
## Standard LED Events
There are default LED animations that are shown when certain things happen. Note
that some of these behaviors are configurable while others are hard-coded so
users can be confident they know the device's state.
### Listening
This will always be a breathing animation. The color may be specified in settings
or will default to the theme color (same as the screen border when listening).
### Sleeping
This will always be a static LED ring color. The color may be specified in
settings or will default to Red.
### Muted
This will always be a static LED ring color. The color may be specified in
settings or will default to Burnt Orange.
### Microphone Muted Error
This will flash all LEDs 3 times in the microphone muted color. This happens if
the user tries to start listening while the mic is muted.
### Speech Input Error
This will flash all LEDs 1 time in the error color (default Red). The color may
be specified in settings.
### Skill Intent Error
This will flash all LEDs 4 times in the error color (default Red). The color may
be specified in settings.
### Utterance sent to skills
This is disabled by default, but when enabled will provide an animation in the
theme color when an utterance is emitted.
### Skill intent handler start
This is disabled by default, but when enabled will provide an animation in the
theme color when a skill intent starts.
## Configuration
For Neopixel devices, the plugin requires `root` permissions and must be enabled
explicitly in the system configuration in `/etc`.
```yaml
PHAL:
admin:
neon-phal-plugin-linear-led-neopixel:
enabled: true
```
>*Note*: If any other config is present here (i.e. colors), it will override
> all configuration in `PHAL.neon-phal-plugin-linear-led` for Neopixel devices.
> It is recommended to not include config here so that it applies to all linear
> LED classes.
### Colors
By default, the plugin will use theme colors for different events, but these
colors may also be overridden in configuration.
```yaml
PHAL:
neon-phal-plugin-linear-led:
listen_color: white
mute_color: burnt_orange
sleep_color: red
error_color: red
```
### Optional Event Animations
There are standard messagebus events that you can choose to show animations for.
These are disabled by default, but may be desirable to provide more user feedback
or troubleshoot specific error cases.
```yaml
PHAL:
neon-phal-plugin-linear-led:
utterance_animation: refill
handler_animation: bounce
```
## messagebus API
This plugin exposes messagebus listener `neon.linear_led.show_animation` to
trigger showing an animation. Any skill, plugin, or other integration can
request an LED ring animation by emitting a Message:
```python
from mycroft_bus_client import Message
Message("neon.linear_led.show_animation",
{'animation': 'chase',
'color': 'green',
'timeout': 10})
```
Note that the plugin may enforce a limit to how long the animation is displayed
and also may replace the animation with a different one that is triggered.
Raw data
{
"_id": null,
"home_page": "https://github.com/NeonGeckoCom/neon-phal-plugin-linear_led",
"name": "neon-phal-plugin-linear-led",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Neongecko",
"author_email": "developers@neon.ai",
"download_url": "https://files.pythonhosted.org/packages/6b/bd/14ae37a5d5130ac6bf5aa046cea581acafa3db71f3af95c0fc7a4ec205ac/neon-phal-plugin-linear_led-0.2.3.tar.gz",
"platform": null,
"description": "# PHAL Linear LED Plugin\nEnables interaction with LEDs in a one-dimensional physical arrangement.\n\n## Standard LED Events\nThere are default LED animations that are shown when certain things happen. Note\nthat some of these behaviors are configurable while others are hard-coded so\nusers can be confident they know the device's state.\n\n### Listening\nThis will always be a breathing animation. The color may be specified in settings\nor will default to the theme color (same as the screen border when listening).\n\n### Sleeping\nThis will always be a static LED ring color. The color may be specified in\nsettings or will default to Red.\n\n### Muted\nThis will always be a static LED ring color. The color may be specified in\nsettings or will default to Burnt Orange.\n\n### Microphone Muted Error\nThis will flash all LEDs 3 times in the microphone muted color. This happens if\nthe user tries to start listening while the mic is muted.\n\n### Speech Input Error\nThis will flash all LEDs 1 time in the error color (default Red). The color may\nbe specified in settings.\n\n### Skill Intent Error\nThis will flash all LEDs 4 times in the error color (default Red). The color may\nbe specified in settings.\n\n### Utterance sent to skills\nThis is disabled by default, but when enabled will provide an animation in the\ntheme color when an utterance is emitted.\n\n### Skill intent handler start\nThis is disabled by default, but when enabled will provide an animation in the\ntheme color when a skill intent starts.\n\n## Configuration\nFor Neopixel devices, the plugin requires `root` permissions and must be enabled\nexplicitly in the system configuration in `/etc`.\n```yaml\nPHAL:\n admin:\n neon-phal-plugin-linear-led-neopixel:\n enabled: true\n```\n>*Note*: If any other config is present here (i.e. colors), it will override \n> all configuration in `PHAL.neon-phal-plugin-linear-led` for Neopixel devices.\n> It is recommended to not include config here so that it applies to all linear\n> LED classes.\n\n### Colors\nBy default, the plugin will use theme colors for different events, but these\ncolors may also be overridden in configuration.\n```yaml\nPHAL:\n neon-phal-plugin-linear-led:\n listen_color: white\n mute_color: burnt_orange\n sleep_color: red\n error_color: red\n```\n\n### Optional Event Animations\nThere are standard messagebus events that you can choose to show animations for.\nThese are disabled by default, but may be desirable to provide more user feedback\nor troubleshoot specific error cases.\n```yaml\nPHAL:\n neon-phal-plugin-linear-led:\n utterance_animation: refill\n handler_animation: bounce\n```\n\n## messagebus API\nThis plugin exposes messagebus listener `neon.linear_led.show_animation` to \ntrigger showing an animation. Any skill, plugin, or other integration can \nrequest an LED ring animation by emitting a Message:\n```python\nfrom mycroft_bus_client import Message\n\nMessage(\"neon.linear_led.show_animation\",\n {'animation': 'chase',\n 'color': 'green',\n 'timeout': 10})\n```\n\nNote that the plugin may enforce a limit to how long the animation is displayed\nand also may replace the animation with a different one that is triggered.\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "Linear/Ring LED Interface",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/NeonGeckoCom/neon-phal-plugin-linear_led"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6053f0ca841a1dd6ddf66c5aab0f48fe544380fd4a3222de25df30da5bceeb25",
"md5": "24d6cf3e78dd1148edefa246aad92cde",
"sha256": "31eabb276ce1d5f7e3d8b5683abd8e1f0a883f2e0185073277d64e0ea6032aaa"
},
"downloads": -1,
"filename": "neon_phal_plugin_linear_led-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24d6cf3e78dd1148edefa246aad92cde",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11539,
"upload_time": "2024-04-22T18:47:06",
"upload_time_iso_8601": "2024-04-22T18:47:06.300669Z",
"url": "https://files.pythonhosted.org/packages/60/53/f0ca841a1dd6ddf66c5aab0f48fe544380fd4a3222de25df30da5bceeb25/neon_phal_plugin_linear_led-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6bbd14ae37a5d5130ac6bf5aa046cea581acafa3db71f3af95c0fc7a4ec205ac",
"md5": "605138652c95a067c8b41cc6e4e08c6f",
"sha256": "a051a138214afc4db204f50e7d6bc6d9a4f81e9abc90fabacf2020b55aae839f"
},
"downloads": -1,
"filename": "neon-phal-plugin-linear_led-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "605138652c95a067c8b41cc6e4e08c6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9167,
"upload_time": "2024-04-22T18:47:08",
"upload_time_iso_8601": "2024-04-22T18:47:08.115809Z",
"url": "https://files.pythonhosted.org/packages/6b/bd/14ae37a5d5130ac6bf5aa046cea581acafa3db71f3af95c0fc7a4ec205ac/neon-phal-plugin-linear_led-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 18:47:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeonGeckoCom",
"github_project": "neon-phal-plugin-linear_led",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neon-phal-plugin-linear-led"
}
JSON
