apyhiveapi

An async Python library for the Hive smart home platform. It exists to power tomwilkie/ha-hive, a fork of the Hive integration for Home Assistant, and exposes exactly what that integration needs: Hive heating and hot water.

This library is a hard fork of Pyhass/Pyhive, cut down to what the ha-hive integration needs and restarted at version 0.0.1. It was called pyhive-integration until v0.1.5; that name on PyPI belongs to the upstream project, so this one is published as apyhiveapi, which is also the import name.

Features

• Async only, built on aiohttp
• AWS Cognito SRP authentication with SMS two-factor authentication support
• Automatic token refresh at 90% of token lifetime, with a silent re-login when the refresh token is rejected
• Mirrors Hive's own API: get_nodes() is GET /nodes/all, and each command (set_mode, set_target_temperature, set_heating_boost, set_hot_water_boost) is one POST /nodes/{type}/{id}. There is no polling timer and no cached state; the caller decides when to fetch
• Typed, frozen snapshots of heating and hot water products and devices, using Hive's own field names and values
• File-based offline mode for development and testing without live credentials

Supported Devices

Lights, smart plugs, sensors and the hub are not supported: the ha-hive integration does not use them.

Installation

From PyPI, or the current main:

pip install apyhiveapi
pip install "apyhiveapi @ git+https://github.com/tomwilkie/apyhiveapi"

Every release is also attached to its GitHub Release as a wheel and sdist.

Requires Python 3.13+.

Quick Start

import asyncio
import getpass

from aiohttp import ClientSession
from apyhiveapi import SMS_REQUIRED, Auth, Hive


async def main():
    username = input("Hive email: ")
    password = getpass.getpass("Hive password: ")

    auth = Auth(username=username, password=password)
    tokens = await auth.login()
    if tokens.get("ChallengeName") == SMS_REQUIRED:
        tokens = await auth.sms_2fa(input("SMS code: "), tokens)
        await auth.device_registration()

    async with ClientSession() as websession:
        hive = Hive(websession)
        hive.new_session(
            {
                "username": username,
                "password": password,
                "tokens": tokens,
                "device_data": auth.get_device_data(),
            }
        )
        nodes = await hive.get_nodes()
        for product in nodes.products.values():
            print(product.type, product.name, product.mode)


asyncio.run(main())

Authentication

Authentication uses the AWS Cognito SRP flow. On the first login login() returns a ChallengeName of SMS_MFA (the SMS_REQUIRED constant) when the account has SMS two-factor authentication enabled; pass the code to sms_2fa(code, tokens). Then call device_registration() to register the machine as a trusted device and save the credentials get_device_data() returns, so later sessions can log in without an SMS.

Note: Only the Hive account owner is supported. Guest accounts cannot be used.

Standalone login example

examples/example_login.py is a complete runnable script. The first run asks for your email, password and SMS code, registers the machine as a trusted device and saves the device credentials to hive_device.json. Later runs log in with that file and skip the SMS. Both runs list the account's heating and hot water products and devices.

pip install apyhiveapi
python examples/example_login.py

Reading and Controlling Devices

new_session() only loads the saved credentials; nothing is sent until the first call. get_nodes() fetches GET /nodes/all and returns a Nodes snapshot: user, products and devices, each keyed by Hive ID. Products are HeatingProduct (heating) or HotWaterProduct (hotwater); devices are Device (hub, thermostatui, boilermodule). Fields keep Hive's names and values: a heating mode can be BOOST, a previous_mode can be False. A value Hive left out or sent with an unexpected type is None.

Each command takes a product from the snapshot and sends one POST /nodes/{type}/{id}:

There is no boost-off call: end a boost with set_mode and the mode it returns to (the product's previous_mode, where False means OFF). The library does not check argument values; Hive does.

nodes = await hive.get_nodes()
heating = nodes.products["<heating id>"]
print(heating.temperature, heating.target, heating.mode, heating.online)

await hive.set_target_temperature(heating, 21.0)
await hive.set_heating_boost(heating, 30, 22.0)
await hive.set_mode(heating, "SCHEDULE")

Errors

Every exception the library raises is a subclass of HiveError, grouped by what the caller should do about it. aiohttp and botocore exceptions never escape the library.

get_nodes() and the commands raise on every failure and keep nothing between calls; retrying is up to the caller.

Offline / File-Based Testing

Set username="use@file.com" to load device state from the bundled JSON fixture in src/apyhiveapi/data/ instead of making live API calls. Useful for development without real Hive credentials.

async with Hive(username="use@file.com", password="") as hive:
    hive.new_session({})
    nodes = await hive.get_nodes()

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run linters
pre-commit run --all-files

# Run tests
pytest tests/

Links

• ha-hive, the Home Assistant integration this library powers
• Releases
• Source
• Issue Tracker

License

MIT License — see LICENSE for details. The original work is copyright Pyhive; the changes in this fork are copyright Tom Wilkie.