Metadata-Version: 2.4
Name: aioafero
Version: 6.1.1
Summary: Talk to the Afero 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: Afero,Afero IoT,Hubspace,Myko
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
Requires-Dist: securelogging>=1.0.1
Provides-Extra: cli
Requires-Dist: click; extra == 'cli'
Provides-Extra: test
Requires-Dist: aioresponses; extra == 'test'
Requires-Dist: anyio[trio]; 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'
Requires-Dist: tox; 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.portable_acs``: Any device that matches a portable-ac. Can perform the following
  actions:

   * Everything is done through set_state

* ``bridge.switches``: Any device that matches a switch. Can perform the following
  actions:

   * turn_on
   * turn_off


* ``bridge.thermostats``: Any device that matches a thermostat. Can perform the following
  actions:

   * set_fan_mode
   * set_hvac_mode
   * set_target_temperature
   * set_temperature_range


* ``bridge.security_systems``: Any device that matches security-system. Can perform
  the following actions

   * alarm_trigger
   * arm_away
   * arm_home
   * disarm

* ``bridge.security_system_keypads``: Any device that matches security-system-keypad. Can perform
  the following actions

   * Everything is done through set_state


* ``bridge.security_system_sensors``: Sensors split from security-system. Can perform
  the following actions

   * Everything is done through set_state


* ``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, hide_secrets=False)
    # Query the API and populate the controllers
    await bridge.initialize()
    # If OTP is enabled on the account, it will need to be provided here
    await bridge.otp_login("<OTP_CODE>")
    # Turn on the light that matches id="84338ebe-7ddf-4bfa-9753-3ee8cdcc8da6"
    await bridge.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.


Creating multiple devices from a single device
==============================================

Sometimes a device can contain multiple devices that should be controlled individually
for ease-of-use within other integrations. This can be done by implementing the following
functionality:

 * Primary class (class of the non-split device): Fill out class attribute DEVICE_SPLIT_CALLBACKS
 * Model for the split class:

   * Initialization uses model._id instead of model._id. This should be unique and not the main class ID
   * Add the following properties to the model

     * id: Uses model._id
     * update_id: Device ID used during the update. This should match the parent class ID
     * (optional): Additional property to specify the "instance" of the split class
