skill-homeassistant 0.1.0__tar.gz

skill_homeassistant-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

skill_homeassistant-0.1.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.3
+Name: skill-homeassistant
+Version: 0.1.0
+Summary: A unified OVOS/Neon.AI Skill for Home Assistant.
+License: Apache-2.0
+Keywords: ovos,neon,home,assistant,voice,interface,skill,plugin
+Author: Mike Gray
+Author-email: mike@oscillatelabs.net
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: test
+Requires-Dist: nested-lookup (>=0.2,<1.0)
+Requires-Dist: ovos-bus-client (>=0.0.8)
+Requires-Dist: ovos-config (>=0.0.5)
+Requires-Dist: ovos-phal-plugin-oauth (>=0.0.3)
+Requires-Dist: ovos-plugin-manager (>=0.0.23)
+Requires-Dist: ovos-utils (>=0.0.27)
+Requires-Dist: ovos-workshop (>=0.0.15)
+Requires-Dist: setuptools (>=75.0.0,<76.0.0)
+Description-Content-Type: text/markdown
+
+# Home Assistant Skill
+
+Control your Home Assistant smart home devices through OVOS or Neon.AI voice assistants.
+
+This unified skill is a replacement for the `neon-homeassistant-skill` and `ovos-PHAL-plugin-homeassistant` skill/plugin. Most features are supported, but please report any issues you encounter. **_Note: Do not install both this skill and the previous skills/plugins._**
+
+## Features
+
+- Control lights (on/off, brightness, color)
+- Control switches and outlets
+- Monitor sensors
+- Control covers (open/close, position)
+- Silent mode for specific devices
+- Support for Home Assistant Assist API
+
+## Installation on Neon
+
+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:
+    - skill-homeassistant # Optionally with a version, such as skill-homeassistant==0.1.0
+```
+
+## Configuration
+
+### Authentication Using a Long-lived Token
+
+We recommend using a [long-lived token for Home Assistant](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token). This provides persistent access without requiring re-authentication. Configure it in your skill settings file:
+
+- OVOS: `~/.config/mycroft/skills/skill-homeassistant/settings.json`
+- Neon: `~/.config/neon/skills/neon_homeassistant_skill/settings.json`
+
+```json
+{
+  "api_key": "<HA_LONG_LIVED_TOKEN>",
+  "host": "<HA_IP_OR_HOSTNAME>"
+}
+```
+
+### Configuration Options
+
+All available settings with their defaults:
+
+```jsonc
+{
+  "host": "", // Home Assistant instance URL - required, no default
+  "api_key": "", // Long-lived access token - required, no default
+  "disable_intents": false, // Disable all Home Assistant intents. In most cases, you should just uninstall the skill instead of setting this to true.
+  "silent_entities": [], // List of entities to control without voice confirmation
+  "brightness_increment": 10, // Percentage to change brightness by
+  "search_confidence_threshold": 0.5, // Minimum confidence for entity matching, from 0 to 1 (correlates to a percentage)
+  "assist_only": true, // Only pull entities exposed to Home Assistant Assist
+  "timeout": 5, // Timeout for Home Assistant API requests in seconds
+  "log_level": "INFO" // Logging level (DEBUG, INFO, WARNING, ERROR)
+}
+```
+
+### Legacy Configuration Support
+
+If you're migrating from the previous neon-homeassistant-skill with ovos-PHAL-plugin-homeassistant, the skill will automatically detect and use configuration from your `mycroft.conf` or `neon.yaml`. However, we recommend migrating to the new settings.json location.
+
+### Hostname Considerations
+
+Mycroft Mark II may not support `.local` hostnames (e.g., `homeassistant.local`). Options include:
+
+1. Use the IP address of your Home Assistant instance (recommended for local access)
+2. Use your Nabu Casa DNS if you have a subscription (requires internet connectivity)
+3. Use a local DNS server that resolves to your Home Assistant instance
+
+## Usage
+
+### Voice Commands
+
+#### Lights
+
+- "Turn on/off [device name]"
+- "Set [device name] brightness to [X] percent"
+- "Increase/decrease [device name] brightness"
+- "What color is [device name]?"
+- "Set [device name] color to [color]"
+- "What's the brightness of [device name]?"
+
+#### Switches
+
+- "Turn on/off [device name]"
+- "Toggle [device name]"
+
+#### Covers
+
+- "Open/Close [device name]"
+- "Set [device name] position to [X] percent"
+- "Stop [device name]"
+
+#### Sensors
+
+- "What's the temperature in [sensor name]?"
+- "What's the status of [sensor name]?"
+
+#### Home Assistant Assist
+
+- "Ask Home Assistant [command]" (passes command directly to HA Assist API)
+
+### Silent Mode
+
+Add devices to the `silent_entities` list to control them without voice feedback:
+
+```json
+{
+  "silent_entities": ["light.kitchen", "switch.office"]
+}
+```
+
+### Disabling Intents
+
+If you don't want the skill's intents enabled (e.g., when shipping in a voice assistant image), set `disable_intents` to true:
+
+```json
+{
+  "disable_intents": true
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Connection Failures**
+
+   - Verify your Home Assistant instance is reachable
+   - Check the host URL format (should include protocol, e.g., `https://`)
+   - Ensure your token has the required permissions
+
+2. **Entity Not Found**
+
+   - Check if the entity is exposed to Home Assistant Assist
+   - Verify the entity name matches exactly
+   - Try using the entity's friendly name
+
+3. **Authentication Issues**
+   - For long-lived tokens: Verify the token is valid and not expired
+   - For OAuth: Try re-authenticating with "connect to home assistant"
+
+### Debug Mode
+
+Enable debug logging for more detailed information:
+
+```json
+{
+  "debug": true,
+  "log_level": "DEBUG"
+}
+```
+
+## Upcoming Features
+
+- Vacuum functions
+- HVAC functions
+- Media player control
+- Camera integration
+
+## Contributing
+
+Contributions are very welcome! Please read our contributing guidelines and submit pull requests to our GitHub repository.
+
+## License
+
+Apache License 2.0
+

skill_homeassistant-0.1.0/README.md

@@ -0,0 +1,169 @@
+# Home Assistant Skill
+
+Control your Home Assistant smart home devices through OVOS or Neon.AI voice assistants.
+
+This unified skill is a replacement for the `neon-homeassistant-skill` and `ovos-PHAL-plugin-homeassistant` skill/plugin. Most features are supported, but please report any issues you encounter. **_Note: Do not install both this skill and the previous skills/plugins._**
+
+## Features
+
+- Control lights (on/off, brightness, color)
+- Control switches and outlets
+- Monitor sensors
+- Control covers (open/close, position)
+- Silent mode for specific devices
+- Support for Home Assistant Assist API
+
+## Installation on Neon
+
+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:
+    - skill-homeassistant # Optionally with a version, such as skill-homeassistant==0.1.0
+```
+
+## Configuration
+
+### Authentication Using a Long-lived Token
+
+We recommend using a [long-lived token for Home Assistant](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token). This provides persistent access without requiring re-authentication. Configure it in your skill settings file:
+
+- OVOS: `~/.config/mycroft/skills/skill-homeassistant/settings.json`
+- Neon: `~/.config/neon/skills/neon_homeassistant_skill/settings.json`
+
+```json
+{
+  "api_key": "<HA_LONG_LIVED_TOKEN>",
+  "host": "<HA_IP_OR_HOSTNAME>"
+}
+```
+
+### Configuration Options
+
+All available settings with their defaults:
+
+```jsonc
+{
+  "host": "", // Home Assistant instance URL - required, no default
+  "api_key": "", // Long-lived access token - required, no default
+  "disable_intents": false, // Disable all Home Assistant intents. In most cases, you should just uninstall the skill instead of setting this to true.
+  "silent_entities": [], // List of entities to control without voice confirmation
+  "brightness_increment": 10, // Percentage to change brightness by
+  "search_confidence_threshold": 0.5, // Minimum confidence for entity matching, from 0 to 1 (correlates to a percentage)
+  "assist_only": true, // Only pull entities exposed to Home Assistant Assist
+  "timeout": 5, // Timeout for Home Assistant API requests in seconds
+  "log_level": "INFO" // Logging level (DEBUG, INFO, WARNING, ERROR)
+}
+```
+
+### Legacy Configuration Support
+
+If you're migrating from the previous neon-homeassistant-skill with ovos-PHAL-plugin-homeassistant, the skill will automatically detect and use configuration from your `mycroft.conf` or `neon.yaml`. However, we recommend migrating to the new settings.json location.
+
+### Hostname Considerations
+
+Mycroft Mark II may not support `.local` hostnames (e.g., `homeassistant.local`). Options include:
+
+1. Use the IP address of your Home Assistant instance (recommended for local access)
+2. Use your Nabu Casa DNS if you have a subscription (requires internet connectivity)
+3. Use a local DNS server that resolves to your Home Assistant instance
+
+## Usage
+
+### Voice Commands
+
+#### Lights
+
+- "Turn on/off [device name]"
+- "Set [device name] brightness to [X] percent"
+- "Increase/decrease [device name] brightness"
+- "What color is [device name]?"
+- "Set [device name] color to [color]"
+- "What's the brightness of [device name]?"
+
+#### Switches
+
+- "Turn on/off [device name]"
+- "Toggle [device name]"
+
+#### Covers
+
+- "Open/Close [device name]"
+- "Set [device name] position to [X] percent"
+- "Stop [device name]"
+
+#### Sensors
+
+- "What's the temperature in [sensor name]?"
+- "What's the status of [sensor name]?"
+
+#### Home Assistant Assist
+
+- "Ask Home Assistant [command]" (passes command directly to HA Assist API)
+
+### Silent Mode
+
+Add devices to the `silent_entities` list to control them without voice feedback:
+
+```json
+{
+  "silent_entities": ["light.kitchen", "switch.office"]
+}
+```
+
+### Disabling Intents
+
+If you don't want the skill's intents enabled (e.g., when shipping in a voice assistant image), set `disable_intents` to true:
+
+```json
+{
+  "disable_intents": true
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Connection Failures**
+
+   - Verify your Home Assistant instance is reachable
+   - Check the host URL format (should include protocol, e.g., `https://`)
+   - Ensure your token has the required permissions
+
+2. **Entity Not Found**
+
+   - Check if the entity is exposed to Home Assistant Assist
+   - Verify the entity name matches exactly
+   - Try using the entity's friendly name
+
+3. **Authentication Issues**
+   - For long-lived tokens: Verify the token is valid and not expired
+   - For OAuth: Try re-authenticating with "connect to home assistant"
+
+### Debug Mode
+
+Enable debug logging for more detailed information:
+
+```json
+{
+  "debug": true,
+  "log_level": "DEBUG"
+}
+```
+
+## Upcoming Features
+
+- Vacuum functions
+- HVAC functions
+- Media player control
+- Camera integration
+
+## Contributing
+
+Contributions are very welcome! Please read our contributing guidelines and submit pull requests to our GitHub repository.
+
+## License
+
+Apache License 2.0

skill_homeassistant-0.1.0/pyproject.toml

@@ -0,0 +1,88 @@
+[build-system]
+requires = ["poetry_core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "skill-homeassistant"
+version = "0.1.0"
+description = "A unified OVOS/Neon.AI Skill for Home Assistant."
+authors = ["Mike Gray <mike@oscillatelabs.net>"]
+readme = "README.md"
+license = "Apache-2.0"
+include = ["skill_homeassistant/locale/*"]
+keywords = [
+    "ovos",
+    "neon",
+    "home",
+    "assistant",
+    "voice",
+    "interface",
+    "skill",
+    "plugin",
+]
+
+[tool.poetry.extras]
+test = ["neon-minerva"]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+ovos-bus-client = ">=0.0.8"
+ovos-workshop = ">=0.0.15"
+setuptools = "^75.0.0"
+ovos-plugin-manager = ">=0.0.23"
+ovos-utils = ">=0.0.27"
+ovos-config = ">=0.0.5"
+ovos-phal-plugin-oauth = ">=0.0.3"
+nested-lookup = ">=0.2,<1.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "*"
+pylint = "*"
+flake8 = "*"
+pydocstyle = "*"
+pycodestyle = "*"
+black = "*"
+mypy = "*"
+bandit = "*"
+types-pyyaml = "*"
+ovos-utils = { version = "*", allow-prereleases = true }
+padacioso = { version = "*", allow-prereleases = true }
+adapt-parser = { git = "https://github.com/mycroftai/adapt" }
+ovos-core = ">=0.0.7"
+poethepoet = "^0.32.1"
+pytest-cov = "^6.0.0"
+toml = "^0.10.2"
+neon-minerva = { version = "~=0.2.0", allow-prereleases = true }
+mock = "^5.1.0"
+
+[tool.ruff]
+line-length = 119
+
+[tool.black]
+line-length = 119
+
+[tool.mypy]
+exclude = ["test"]
+
+[tool.isort]
+profile = "black"
+
+[tool.poe.tasks.test]
+help = "Run the test suite"
+cmd = "pytest --cov=skill_homeassistant --cov-report term-missing -vv test/"
+
+[tool.poe.tasks.format]
+help = "Run code formatters"
+shell = "black --line-length=119 skill_homeassistant && isort --overwrite-in-place skill_homeassistant"
+
+[tool.poetry.scripts]
+"neon-homeassistant-skill" = "skill_homeassistant:HomeAssistantSkill"
+
+[tool.poetry.plugins."ovos.plugin.skill"]
+"skill_homeassistant.oscillatelabsllc" = "skill_homeassistant:HomeAssistantSkill"
+
+[tool.pylint.messages_control]
+disable = [
+    "W0718", # broad-except
+    "C0415", # import-outside-toplevel
+]