Skip to main content

Talk to the HubSpace API asynchronously

Project description

Creates a session to HubSpace and handles authentication

This project was designed to asynchronously connect to the HubSpace API and retrieve data. The implementation was based on jdeath/Hubspace-Homeassistant but converted to async and cleaned up.

Examples

These examples provide sample usage when running from the python shell. If the code is running within an async loop, gathering the loop and telling it to run is not required.

Gather all devices from the API

import logging

import hubspace_async
import asyncio


# TRACE messages in logs
hubspace_async.logger.setLevel(logging.HS_TRACE)
hubspace_async.logger.addHandler(logging.StreamHandler())

try:
    loop = asyncio.get_event_loop()
except RunTimeError:
    loop = asyncio.new_event_loop()

username = "<username>"
password = "<password>

async def get_devices(username, password):
    connection = hubspace_async.HubSpaceConnection(username, password)
    return await connection.devices



loop.run_until_complete(get_devices(username, password))

A sample output would look like

[{"id": "blah1"}, {"id": "blah2"}]

After running this code, the following attributes will be populated:

  • homes: Dictionary of all homes from the API response

  • rooms: Dictionary of all rooms from the API response

  • devices: Dictionary of all devices from the API response

Updating a devices state

In this example we will turn a light on. The request requires the use of functionInstance for it to work. However some updates may not require this field.

from hubspace_async import connection, HubSpaceState
import asyncio


conn = connection.HubSpaceConnection("username", "password")
state = HubSpaceState(
     functionClass="power",
     functionInstance="light-power",
     value="on",
 )
child_id = "abc123"
loop.run_until_complete(conn.set_device_state(child_id, new_states))

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

hubspace_async-0.1.1.tar.gz (24.5 kB view hashes)

Uploaded Source

Built Distribution

hubspace_async-0.1.1-py3-none-any.whl (12.1 kB view hashes)

Uploaded Python 3

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