Skip to main content

An OVOS/Neon.AI Skill for Home Assistant, which integrates with ovos-PHAL-plugin-homeassistant.

Project description

Home Assistant Neon Skill

Uses PHAL Home Assistant plugin

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

Then, you can pip install neon-homeassistant-skill, or handle the installation from the ~/.config/neon/neon.yaml file if you prefer:

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:

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:

{
  "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.

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.

{
  "__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

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

neon_homeassistant_skill-0.0.19.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

neon_homeassistant_skill-0.0.19-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file neon_homeassistant_skill-0.0.19.tar.gz.

File metadata

  • Download URL: neon_homeassistant_skill-0.0.19.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.4.0

File hashes

Hashes for neon_homeassistant_skill-0.0.19.tar.gz
Algorithm Hash digest
SHA256 dbda30572f284a97f75e63794fce5d8aee8cb1767ae0492e7e65a551a1360ba4
MD5 d9927ebfa5883eac1d166f83a694dfe0
BLAKE2b-256 2ed7f7a3064521ca8dd2736a72c3c10a288f82257b39acde916de20f4689ffac

See more details on using hashes here.

Provenance

File details

Details for the file neon_homeassistant_skill-0.0.19-py3-none-any.whl.

File metadata

File hashes

Hashes for neon_homeassistant_skill-0.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 d9328b4d4f846bb8f3bba5ee737defd244979aa9f54dedb06d0c8d25a671745f
MD5 e38c1866eb647cb0020c0141e69d7972
BLAKE2b-256 6bfa64fff2d2d861489405dc7ad35e0caa812c5fca144d79c0a9fc6dd927fa2c

See more details on using hashes here.

Provenance

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