# Home Assistant Neon Skill
Uses [PHAL Home Assistant plugin](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-homeassistant)
Available on PyPi: `pip install neon-homeassistant-skill`
## Installation on Neon
\***\*Note\*\***: This skill and the required PHAL plugin come pre-installed on Neon images for the Mycroft Mark II and Neon's published Docker images. These instructions are for custom development builds or creating your own Neon instance from scratch.
Install ovos-PHAL-plugin-homeassistant [per their documentation](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-homeassistant)
Then, you can `pip install neon-homeassistant-skill`, or handle the installation from the `~/.config/neon/neon.yaml` file if you prefer:
```yaml
skills:
default_skills:
# Jokes skill included because it cannot be pip installed to the image
- https://github.com/JarbasSkills/skill-icanhazdadjokes/tree/dev
- neon-homeassistant-skill # Optionally with a version, such as neon-homeassistant-skill==0.0.10
```
### Authenticating to Home Assistant
On a device with a screen, such as the Mycroft Mark II, you can say `open home assistant dashboard` and use the OAuth login flow to authenticate from the PHAL plugin. If you don't have a screen available or prefer to edit the configuration directly, read on.
---
The documentation for ovos-PHAL-plugin-homeassistant specifies which configuration file to put your Home Assistant hostname/port and API key. Note that Neon uses a YAML configuration, not a JSON file, so edit `~/.config/neon/neon.yaml` and make the following update for a minimal installation:
```yaml
PHAL:
ovos-PHAL-plugin-homeassistant:
host: http://<HA_IP_OR_HOSTNAME>:8123
api_key: <HA_LONG_LIVED_TOKEN>
```
On OVOS, you would update `~/.config/mycroft/mycroft.conf` to include the following:
```json
{
"PHAL": {
"ovos-PHAL-plugin-homeassistant": {
"host": "http://<HA_IP_OR_HOSTNAME>:8123",
"api_key": "<HA_LONG_LIVED_TOKEN>"
}
}
```
The `PHAL` node above should be at the root of the Neon user configuration file, appended to the end of file if existing content exists, and will merge with system configuration per [Neon Configuration Docs.](https://neongeckocom.github.io/neon-docs/quick_reference/configuration/)
Mycroft Mark II does not always support .local hostnames such as the default `homeassistant.local` DNS. You may need to use the IP of your Home Assistant instance instead. If you have a Nabu Casa subscription and don't mind traffic going out to the internet using your public Nabu Casa DNS is also a supported option. However, if your internet connectivity drops from your Neon instance, you will be unable to control your smart home devices from Neon. A local DNS/IP is preferable.
## Disabling Intents
If you don't want to have all of the intents enabled, which may be the case if you ship this skill by default in a voice assistant image, there is a setting available to disable intents. This can be done in the `settings.json` file for the skill. The path will be `~/.config/mycroft/skills/neon_homeassistant_skill.mikejgray/settings.json` or `~/.config/neon/skills/neon_homeassistant_skill/settings.json` for Neon.
```json
{
"__mycroft_skill_firstrun": false,
"disable_intents": false
}
```
## Upcoming Features
- Start OAuth workflow with voice
- Start an instance of the ovos-PHAL-plugin-homeassistant if PHAL isn't already running
- Vacuum functions
- HVAC functions
Raw data
{
"_id": null,
"home_page": null,
"name": "neon-homeassistant-skill",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "ovos, neon, home, assistant, phal, voice, interface, skill, plugin",
"author": "Mike Gray",
"author_email": "mike@graywind.org",
"download_url": "https://files.pythonhosted.org/packages/9d/5a/04e286b6c7cc6c44e1985108741bc89b87ffb74c3ee0356d6235f2ec01a3/neon_homeassistant_skill-0.0.22.tar.gz",
"platform": null,
"description": "# Home Assistant Neon Skill\n\nUses [PHAL Home Assistant plugin](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-homeassistant)\n\nAvailable on PyPi: `pip install neon-homeassistant-skill`\n\n## Installation on Neon\n\n\\***\\*Note\\*\\***: This skill and the required PHAL plugin come pre-installed on Neon images for the Mycroft Mark II and Neon's published Docker images. These instructions are for custom development builds or creating your own Neon instance from scratch.\n\nInstall ovos-PHAL-plugin-homeassistant [per their documentation](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-homeassistant)\n\nThen, you can `pip install neon-homeassistant-skill`, or handle the installation from the `~/.config/neon/neon.yaml` file if you prefer:\n\n```yaml\nskills:\n default_skills:\n # Jokes skill included because it cannot be pip installed to the image\n - https://github.com/JarbasSkills/skill-icanhazdadjokes/tree/dev\n - neon-homeassistant-skill # Optionally with a version, such as neon-homeassistant-skill==0.0.10\n```\n\n### Authenticating to Home Assistant\n\nOn a device with a screen, such as the Mycroft Mark II, you can say `open home assistant dashboard` and use the OAuth login flow to authenticate from the PHAL plugin. If you don't have a screen available or prefer to edit the configuration directly, read on.\n\n---\n\nThe documentation for ovos-PHAL-plugin-homeassistant specifies which configuration file to put your Home Assistant hostname/port and API key. Note that Neon uses a YAML configuration, not a JSON file, so edit `~/.config/neon/neon.yaml` and make the following update for a minimal installation:\n\n```yaml\nPHAL:\n ovos-PHAL-plugin-homeassistant:\n host: http://<HA_IP_OR_HOSTNAME>:8123\n api_key: <HA_LONG_LIVED_TOKEN>\n```\n\nOn OVOS, you would update `~/.config/mycroft/mycroft.conf` to include the following:\n\n```json\n{\n \"PHAL\": {\n \"ovos-PHAL-plugin-homeassistant\": {\n \"host\": \"http://<HA_IP_OR_HOSTNAME>:8123\",\n \"api_key\": \"<HA_LONG_LIVED_TOKEN>\"\n }\n}\n```\n\nThe `PHAL` node above should be at the root of the Neon user configuration file, appended to the end of file if existing content exists, and will merge with system configuration per [Neon Configuration Docs.](https://neongeckocom.github.io/neon-docs/quick_reference/configuration/)\n\nMycroft Mark II does not always support .local hostnames such as the default `homeassistant.local` DNS. You may need to use the IP of your Home Assistant instance instead. If you have a Nabu Casa subscription and don't mind traffic going out to the internet using your public Nabu Casa DNS is also a supported option. However, if your internet connectivity drops from your Neon instance, you will be unable to control your smart home devices from Neon. A local DNS/IP is preferable.\n\n## Disabling Intents\n\nIf you don't want to have all of the intents enabled, which may be the case if you ship this skill by default in a voice assistant image, there is a setting available to disable intents. This can be done in the `settings.json` file for the skill. The path will be `~/.config/mycroft/skills/neon_homeassistant_skill.mikejgray/settings.json` or `~/.config/neon/skills/neon_homeassistant_skill/settings.json` for Neon.\n\n```json\n{\n \"__mycroft_skill_firstrun\": false,\n \"disable_intents\": false\n}\n```\n\n## Upcoming Features\n\n- Start OAuth workflow with voice\n- Start an instance of the ovos-PHAL-plugin-homeassistant if PHAL isn't already running\n- Vacuum functions\n- HVAC functions\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "An OVOS/Neon.AI Skill for Home Assistant, which integrates with ovos-PHAL-plugin-homeassistant.",
"version": "0.0.22",
"project_urls": null,
"split_keywords": [
"ovos",
" neon",
" home",
" assistant",
" phal",
" voice",
" interface",
" skill",
" plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a090a0ed58a48f1c00a9373f4f629b96b94f78a84db39c589192cda8e33ad48",
"md5": "c125dc535d7a7a1746fc45ef6ed79744",
"sha256": "a2b405f5df6053ce56c48195019f050e4c64710a9dc91d803fe4f3ae9ba24412"
},
"downloads": -1,
"filename": "neon_homeassistant_skill-0.0.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c125dc535d7a7a1746fc45ef6ed79744",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 22673,
"upload_time": "2024-08-20T03:05:04",
"upload_time_iso_8601": "2024-08-20T03:05:04.461184Z",
"url": "https://files.pythonhosted.org/packages/8a/09/0a0ed58a48f1c00a9373f4f629b96b94f78a84db39c589192cda8e33ad48/neon_homeassistant_skill-0.0.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d5a04e286b6c7cc6c44e1985108741bc89b87ffb74c3ee0356d6235f2ec01a3",
"md5": "8196bd913395326bdc28fc4837d2b3dc",
"sha256": "70de8303f4b9f4de9e2fc257c6b540dfab207b7adffc5b29e43388c374e64dd6"
},
"downloads": -1,
"filename": "neon_homeassistant_skill-0.0.22.tar.gz",
"has_sig": false,
"md5_digest": "8196bd913395326bdc28fc4837d2b3dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 14494,
"upload_time": "2024-08-20T03:05:05",
"upload_time_iso_8601": "2024-08-20T03:05:05.830588Z",
"url": "https://files.pythonhosted.org/packages/9d/5a/04e286b6c7cc6c44e1985108741bc89b87ffb74c3ee0356d6235f2ec01a3/neon_homeassistant_skill-0.0.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 03:05:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "neon-homeassistant-skill"
}
JSON