aioafero 2.0.0__tar.gz

aioafero-2.0.0/.coveragerc

@@ -0,0 +1,27 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source = aioafero
+
+[paths]
+source =
+    src/
+    */site-packages/
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

aioafero-2.0.0/.github/workflows/cicd.yaml

@@ -0,0 +1,43 @@
+name: Execute tests and linting
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+    - main
+  pull_request:
+
+jobs:
+  run_tests:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install requirements
+        run: |
+          pip install .[test]
+      - name: Execute Tests
+        run: |
+          python -m pytest --cov --cov-branch --cov-report=xml --junitxml=junit.xml -o junit_family=legacy
+      - name: Execute linting
+        if: matrix.python-version == '3.12'
+        run: |
+          pip install pre-commit
+          pre-commit run --all-files
+      - name: Upload coverage reports to Codecov
+        if: matrix.python-version == '3.13'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }} && matrix.python-version == '3.13'
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

aioafero-2.0.0/.github/workflows/release.yaml

@@ -0,0 +1,47 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+
+jobs:
+  run_tests:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install requirements
+        run: |
+          pip install .[test]
+      - name: Execute Tests
+        run: |
+          python -m pytest
+      - name: Execute linting
+        if: matrix.python-version == '3.12'
+        run: |
+          pip install pre-commit
+          pre-commit run --all-files
+
+  pypi-publish:
+    needs: [run_tests]
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    if: github.ref_name == github.event.repository.default_branch
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Create files
+        run: |
+          pip install tox
+          tox -e build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

aioafero-2.0.0/.gitignore

@@ -0,0 +1,54 @@
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+tags
+
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.coverage.*
+.tox
+junit*.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_rst/*
+docs/_build/*
+cover/*
+MANIFEST
+
+# Per-project virtualenvs
+.venv*/
+.conda*/
+.python-version

aioafero-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/jorisroovers/gitlint.git
+    rev: v0.19.1
+    hooks:
+      - id: gitlint
+
+  - repo: https://github.com/ambv/black.git
+    rev: 24.4.2
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/PyCQA/flake8.git
+    rev: 7.1.0
+    hooks:
+      - id: flake8
+        additional_dependencies: [flake8-bugbear, "importlib-metadata<5.0"]
+
+  - repo: https://github.com/pycqa/isort.git
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks.git
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: debug-statements

aioafero-2.0.0/.readthedocs.yml

@@ -0,0 +1,27 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - {path: ., method: pip}

aioafero-2.0.0/CHANGELOG.rst

@@ -0,0 +1,175 @@
+=========
+Changelog
+=========
+
+Version 2.0.0
+=============
+
+ * Migration from aiohubspace to aioafero to support the Aefro IoT Cloud
+
+Version 1.2.0
+=============
+
+ * Enable auth to re-use a previously generated token
+
+Version 1.1.3
+=============
+
+ * Fix an issue where devices could be properly identified
+
+Version 1.1.2
+=============
+
+ * Fix an issue where water valves were showing as fans
+
+Version 1.1.1
+=============
+
+ * Fix an issue where 500's could stop polling
+
+Version 1.1.0
+=============
+
+ * Added an event type for invalid auth during token refresh
+ * Added a check to ensure the token is valid during refresh time. If invalid,
+   the event invalid_auth is emitted.
+
+Version 1.0.4
+=============
+
+ * Add additional logging around issues when querying Hubspace API
+
+
+Version 1.0.3
+=============
+
+ * Fixed an issue where a new device could be generated prior to an element
+
+
+Version 1.0.2
+=============
+
+ * Fixed an issue where an updated sensor could use an incorrect value
+
+
+Version 1.0.1
+=============
+
+ * Fixed an issue where passwords could be logged to debug logs
+
+
+Version 1.0.0
+=============
+
+ * Solidify API
+ * Fix an issue where the loop would break during collection
+ * Increase code coverage
+
+
+Version 0.7.0
+=============
+
+ * Add support for glass-doors
+
+
+Version 0.6.4
+=============
+
+ * Fix an issue where locks were not being managed by LockController
+ * Fix an issue with Fans not correctly setting presets
+ * Less greedy updates - Only forward updates if something has changed
+   on the resource
+ * Create additional unit tests to ensure functionality
+
+
+Version 0.6.3
+=============
+
+ * Fix an issue with Binary sensors to ensure the state is obvious
+
+
+Version 0.6.2
+=============
+
+ * Fix an issue with fan's preset not correctly identifying its state
+
+
+Version 0.6.1
+=============
+
+ * Fix an issue with binary sensors to ensure they return True / False
+
+
+Version 0.6.0
+=============
+
+ * Add the ability to send raw states to Hubspace and have the tracked device update
+
+
+Version 0.5.1
+=============
+
+ * Fixed an issue where the account ID wouldnt be set during a partial initialization
+
+
+Version 0.5.0
+=============
+
+ * Only emit updates to subscribers if values have changed
+ * Fixed an issue where the logger was always in debug
+
+
+Version 0.4.1
+=============
+
+ * Adjusted logic for how HubspaceDevice modified models
+ * Fixed an issue around Device initialization
+
+
+Version 0.4.0
+=============
+
+ * Added tracking for BLE and MAC addresses
+ * Added binary sensors
+
+
+Version 0.3.7
+=============
+
+ * Fixed an issue around subscribers with deletion
+
+
+Version 0.3.6
+=============
+
+ * Fixed an issue around switches not properly subscribing to updates
+ * Fixed an issue where Hubspace could return a session reauth token when preparing a new session
+ * Added models for HPSA11CWB and HPDA110NWBP
+
+
+Version 0.3.0
+=============
+
+ * Fixed an issue around subscribers with deletion
+
+
+
+Version 0.2
+===========
+
+ * Added support for Binary Sensors
+ * Fixed an issue where a dimmer switch could not be dimmed
+
+
+Version 0.2
+===========
+
+ * Added support for Sensors
+
+
+Version 0.1
+===========
+
+ * Initial implementation
+ * Rename from hubspace_async to aiohubspace
+ * Utilize the concept of a bridge instead of raw connection

aioafero-2.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chris Dohmen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aioafero-2.0.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: aioafero
+Version: 2.0.0
+Summary: Talk to the Hubspace API asynchronously
+Project-URL: Repository, https://github.com/Expl0dingBanana/aioafero
+Project-URL: Changelog, https://github.com/Expl0dingBanana/aioafero/CHANGELOG.md
+Author-email: Chris Dohmen <chris.dohmen11@gmail.com>
+Maintainer: tpural
+Maintainer-email: Chris Dohmen <chris.dohmen11@gmail.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2024 Chris Dohmen
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE.txt
+Keywords: Hubspace
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Requires-Dist: aiohttp
+Requires-Dist: beautifulsoup4
+Provides-Extra: cli
+Requires-Dist: click; extra == 'cli'
+Provides-Extra: test
+Requires-Dist: aioresponses; extra == 'test'
+Requires-Dist: anyio; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-aioresponses; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
+Description-Content-Type: text/x-rst
+
+========
+aioafero
+========
+
+
+    Connects to Afero cloud API and provides an easy way to interact
+    with devices.
+
+
+This project was designed to asynchronously connect to the Afero IOT API. It
+has the ability to retrieve the devices and set new states.
+
+
+.. image:: https://github.com/Expl0dingBanana/aioafero/actions/workflows/cicd.yaml/badge.svg?branch=main
+   :target: https://github.com/Expl0dingBanana/aioafero/actions/workflows/cicd.yaml
+
+.. image:: https://codecov.io/github/Expl0dingBanana/aioafero/graph/badge.svg?token=NP2RE4I4XK
+   :target: https://codecov.io/github/Expl0dingBanana/aioafero
+
+Overview
+========
+All data is stored within a "bridge" that knows of all of the devices aligned
+with the Afero IOT account. This bridge contains multiple controllers for each
+device type. These controllers know how to interact with the Afero IOT devices.
+Each controller manages the device's states. To retrieve a device, you must
+query ``bridge.<controller>.get_device(<device_id>)`` which will return
+a model containing all the states. Any changes to the model will not
+update Afero IOT as the correct call needs to be made.
+
+Controllers
+===========
+
+The following controllers are implemented:
+
+* ``bridge.devices``: Top-level devices (such as a ceiling-fan, or light that
+   is not associated with another device). These entities also contain their
+   respective sensors and binary sensors. This is purely an informational
+   controller and cannot set any states.
+
+* ``bridge.fans``: Any device that matches a fan. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+   * set_speed
+   * set_direction
+   * set_preset
+
+* ``bridge.lights``: Any device that matches a fan. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+   * set_color_temperature
+   * set_brightness
+   * set_rgb
+   * set_effect
+
+* ``bridge.locks``: Any device that matches a lock. Can perform the following
+  actions:
+
+   * lock
+   * unlock
+
+* ``bridge.switches``: Any device that matches a switch. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+
+* ``bridge.valves``: Any device that matches a valves. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+
+
+Example Usage
+=============
+All examples assume you entered the shell with ``python -m asyncio``
+
+.. code-block:: python
+
+    from aioafero import v1
+    import logging
+    logging.getLogger("aioafero").setLevel(logging.DEBUG)
+    USERNAME="" # Afero IOT username
+    PASSWORD="" # Afero IOT password
+    POLLING_INTERVAL=30 # Number of seconds between polling cycles
+    # Create the bridge
+    bridge = v1.AferoBridgeV1(USERNAME, PASSWORD, polling_interval=POLLING_INTERVAL)
+    # Query the API and populate the controllers
+    await bridge.initialize()
+    # Turn on the light that matches id="84338ebe-7ddf-4bfa-9753-3ee8cdcc8da6"
+    await conn.lights.turn_off("84338ebe-7ddf-4bfa-9753-3ee8cdcc8da6")
+
+
+Troubleshooting
+===============
+
+* Device shows incorrect model
+
+  * Afero IoT does not always report all the pertinent information through the API.
+    To resolve this, open a PR to ``src/aioafero/device.py`` and update the dataclass
+    ``AferoDevice.__post_init__`` function to correctly identify the device.
+
+* Afero IoT is slow to update
+
+  * The API rate-limits request. If other things are hitting the API (such as the phone app
+    or Home Assistant), you may need to stop using one to ensure a better connection.

aioafero-2.0.0/README.rst

@@ -0,0 +1,110 @@
+========
+aioafero
+========
+
+
+    Connects to Afero cloud API and provides an easy way to interact
+    with devices.
+
+
+This project was designed to asynchronously connect to the Afero IOT API. It
+has the ability to retrieve the devices and set new states.
+
+
+.. image:: https://github.com/Expl0dingBanana/aioafero/actions/workflows/cicd.yaml/badge.svg?branch=main
+   :target: https://github.com/Expl0dingBanana/aioafero/actions/workflows/cicd.yaml
+
+.. image:: https://codecov.io/github/Expl0dingBanana/aioafero/graph/badge.svg?token=NP2RE4I4XK
+   :target: https://codecov.io/github/Expl0dingBanana/aioafero
+
+Overview
+========
+All data is stored within a "bridge" that knows of all of the devices aligned
+with the Afero IOT account. This bridge contains multiple controllers for each
+device type. These controllers know how to interact with the Afero IOT devices.
+Each controller manages the device's states. To retrieve a device, you must
+query ``bridge.<controller>.get_device(<device_id>)`` which will return
+a model containing all the states. Any changes to the model will not
+update Afero IOT as the correct call needs to be made.
+
+Controllers
+===========
+
+The following controllers are implemented:
+
+* ``bridge.devices``: Top-level devices (such as a ceiling-fan, or light that
+   is not associated with another device). These entities also contain their
+   respective sensors and binary sensors. This is purely an informational
+   controller and cannot set any states.
+
+* ``bridge.fans``: Any device that matches a fan. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+   * set_speed
+   * set_direction
+   * set_preset
+
+* ``bridge.lights``: Any device that matches a fan. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+   * set_color_temperature
+   * set_brightness
+   * set_rgb
+   * set_effect
+
+* ``bridge.locks``: Any device that matches a lock. Can perform the following
+  actions:
+
+   * lock
+   * unlock
+
+* ``bridge.switches``: Any device that matches a switch. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+
+* ``bridge.valves``: Any device that matches a valves. Can perform the following
+  actions:
+
+   * turn_on
+   * turn_off
+
+
+Example Usage
+=============
+All examples assume you entered the shell with ``python -m asyncio``
+
+.. code-block:: python
+
+    from aioafero import v1
+    import logging
+    logging.getLogger("aioafero").setLevel(logging.DEBUG)
+    USERNAME="" # Afero IOT username
+    PASSWORD="" # Afero IOT password
+    POLLING_INTERVAL=30 # Number of seconds between polling cycles
+    # Create the bridge
+    bridge = v1.AferoBridgeV1(USERNAME, PASSWORD, polling_interval=POLLING_INTERVAL)
+    # Query the API and populate the controllers
+    await bridge.initialize()
+    # Turn on the light that matches id="84338ebe-7ddf-4bfa-9753-3ee8cdcc8da6"
+    await conn.lights.turn_off("84338ebe-7ddf-4bfa-9753-3ee8cdcc8da6")
+
+
+Troubleshooting
+===============
+
+* Device shows incorrect model
+
+  * Afero IoT does not always report all the pertinent information through the API.
+    To resolve this, open a PR to ``src/aioafero/device.py`` and update the dataclass
+    ``AferoDevice.__post_init__`` function to correctly identify the device.
+
+* Afero IoT is slow to update
+
+  * The API rate-limits request. If other things are hitting the API (such as the phone app
+    or Home Assistant), you may need to stop using one to ensure a better connection.