# PHAL plugin - Google AIY Voice Kit V2
A plugin to handle the button and LED from the famous Google AIY Voice Kit V2
## About
This PHAL plugin interacts with the button and the LED connected to AIY Voice Bonnet.
- When a wake word is detected the LED turns on and when the audio output is over the LED turns off.
- When the button is pressed, the default behaviour is to make the assistant listen and turn on the LED.
It also possible to configure the plugin to only turn the LED on and off during the listening (not the audio output).
## Installation
```shell
pip install ovos-phal-plugin-aiy-v2
```
## Configuration
The plugin configuration file is `~/.config/OpenVoiceOS/ovos-phal-plugin-aiy-v2.json`.
| Option | Value | Description |
| --------------- | -------------------- | ------------------------------------------------------------- |
| `color` | `green` | Define the color of the LED |
| `wakeword_only` | `false` | Turn on the LED only during the wakeword detection |
| `pulse` | `true` | Make the LED pulse |
| `button_event` | `mycroft.mic.listen` | Which event to send to message bus when the button is pressed |
### Example
Configuration sample of `~/.config/OpenVoiceOS/ovos-phal-plugin-aiy-v2.json`.
```json
{
"color": "green",
"wakeword_only": false,
"pulse": true,
"button_event": "mycroft.mic.listen"
}
```
## Credits
- [Smart'Gic](https://smartgic.io/)
Raw data
{
"_id": null,
"home_page": "https://github.com/smartgic/ovos-phal-plugin-aiy-v2",
"name": "ovos-phal-plugin-aiy-v2",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ga\u00ebtan Trellu (goldyfruit)",
"author_email": "gaetan.trellu@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d9/1d/ad249648d9326d31e81cdbb81e07d0204298535931c7ed8a721e1b306bd5/ovos-phal-plugin-aiy-v2-0.1.0.tar.gz",
"platform": null,
"description": "# PHAL plugin - Google AIY Voice Kit V2\n\nA plugin to handle the button and LED from the famous Google AIY Voice Kit V2\n\n## About\n\nThis PHAL plugin interacts with the button and the LED connected to AIY Voice Bonnet.\n\n- When a wake word is detected the LED turns on and when the audio output is over the LED turns off.\n- When the button is pressed, the default behaviour is to make the assistant listen and turn on the LED.\n\nIt also possible to configure the plugin to only turn the LED on and off during the listening (not the audio output).\n\n## Installation\n\n```shell\npip install ovos-phal-plugin-aiy-v2\n```\n\n## Configuration\n\nThe plugin configuration file is `~/.config/OpenVoiceOS/ovos-phal-plugin-aiy-v2.json`.\n\n| Option | Value | Description |\n| --------------- | -------------------- | ------------------------------------------------------------- |\n| `color` | `green` | Define the color of the LED |\n| `wakeword_only` | `false` | Turn on the LED only during the wakeword detection |\n| `pulse` | `true` | Make the LED pulse |\n| `button_event` | `mycroft.mic.listen` | Which event to send to message bus when the button is pressed |\n\n### Example\n\nConfiguration sample of `~/.config/OpenVoiceOS/ovos-phal-plugin-aiy-v2.json`.\n\n```json\n{\n \"color\": \"green\",\n \"wakeword_only\": false,\n \"pulse\": true,\n \"button_event\": \"mycroft.mic.listen\"\n}\n```\n\n## Credits\n\n- [Smart'Gic](https://smartgic.io/)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A plugin to handle Google AIY Voice Kit V2 button and LED",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/smartgic/ovos-phal-plugin-aiy-v2"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d259a26df83ec6a5ff1ffa671ec24a4ce90dafb9a20eba2b49f81300c363a82f",
"md5": "e24d5ecfa477eb4a9027ed2bbdf82e39",
"sha256": "5e75a49f6202b8df2cc4796f58ca603a4e968b42ab5b4d2704d59b0d911ad63c"
},
"downloads": -1,
"filename": "ovos_phal_plugin_aiy_v2-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e24d5ecfa477eb4a9027ed2bbdf82e39",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8317,
"upload_time": "2024-02-03T02:35:13",
"upload_time_iso_8601": "2024-02-03T02:35:13.011599Z",
"url": "https://files.pythonhosted.org/packages/d2/59/a26df83ec6a5ff1ffa671ec24a4ce90dafb9a20eba2b49f81300c363a82f/ovos_phal_plugin_aiy_v2-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d91dad249648d9326d31e81cdbb81e07d0204298535931c7ed8a721e1b306bd5",
"md5": "786444ce34fe7a7df7dae27dce5f7b47",
"sha256": "c35029fcc2a79e43e8a65e9565c9393000daa61aca31a0842c7f6ff5562253c0"
},
"downloads": -1,
"filename": "ovos-phal-plugin-aiy-v2-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "786444ce34fe7a7df7dae27dce5f7b47",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8027,
"upload_time": "2024-02-03T02:35:15",
"upload_time_iso_8601": "2024-02-03T02:35:15.428070Z",
"url": "https://files.pythonhosted.org/packages/d9/1d/ad249648d9326d31e81cdbb81e07d0204298535931c7ed8a721e1b306bd5/ovos-phal-plugin-aiy-v2-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 02:35:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smartgic",
"github_project": "ovos-phal-plugin-aiy-v2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiy-projects-python",
"specs": []
},
{
"name": "json_database",
"specs": []
},
{
"name": "ovos-bus-client",
"specs": []
},
{
"name": "ovos-plugin-manager",
"specs": []
}
],
"lcname": "ovos-phal-plugin-aiy-v2"
}
JSON
