aiohubspace 1.0.0

Talk to the Hubspace API asynchronously

Connects to Hubspace API and provides an easy way to interact with devices.

This project was designed to asynchronously connect to the Hubspace API. It has the ability to retrieve the devices and set new states. It was updated from hubspace_async and merged with concepts from aiohue.

Overview

All data is stored within a “bridge” that knows of all of the devices aligned with the Hubspace account. This bridge contains multiple controllers for each device type. These controllers know how to interact with the Hubspace devices. Each controller manages the device’s states. To retrieve a device, you must query bridge.<controller>.get_device(<hubspace_id>) which will return a model containing all the states. Any changes to the model will not update Hubspace 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

from aiohubspace import v1
import logging
logging.getLogger("aiohubspace").setLevel(logging.DEBUG)
USERNAME="" # Hubspace username
PASSWORD="" # Hubspace password
POLLING_INTERVAL=30 # Number of seconds between polling cycles
# Create the bridge
bridge = v1.HubspaceBridgeV1(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

• Hubspace Device shows incorrect model

  • Hubspace does not always report all the pertinent information through the API. To resolve this, open a PR to src/aiohubspace/device.py and update the dataclass HubspaceDevice.__post_init__ function to correctly identify the device.

• Hubspace 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.