Async library to communicate with Heatmiser NeoHub 2 API
Go to file
Andrius Štikonas d811131f8a Bump version to 0.8. 2021-06-23 20:27:11 +01:00
LICENSES Add minimal README.md. 2020-12-27 19:20:49 +00:00
neohubapi Lint and fix some subtle bugs 2021-06-23 11:58:21 +01:00
scripts Expand our own enums. 2021-01-31 21:16:32 +00:00
tests Add retries, close connection on timeout (fix #6) 2021-02-09 09:37:33 +00:00
.gitignore Add dependency on async_property. 2020-12-27 20:18:22 +00:00
.gitlab-ci.yml Add a few tests for NeoHub._send 2021-02-07 18:37:16 +00:00
README.md Resolve "Add README for CLI" 2021-01-31 21:15:36 +00:00
example.py Initial support for timeclocks. 2021-01-02 22:42:56 +00:00
setup.py Bump version to 0.8. 2021-06-23 20:27:11 +01:00

README.md

NeoHubAPI

This is a simple python wrapper around Heatmiser's Neohub API.

It's primary purpose is to be used via Home Assistant integration but it can also be used as a standalone library.

Usage example

import asyncio
import neohubapi.neohub as neohub


async def run():
    hub = neohub.NeoHub()
    system = await hub.get_system()
    hub_data, devices = await hub.get_live_data()
    for device in devices['thermostats']:
        print(f"Temperature in zone {device.name}: {device.temperature}")
        await device.identify()


asyncio.run(run())

NeoHub API documentation

API documentation can be found from various places online or you can request the latest version from support@heatmiser.com

neohub_cli.py

This package includes a CLI for performing common tasks.

$ neohub_cli.py help  # Shows all commands
$ neohub_cli.py help set_time  # Displays help for the set_time function
$ neohub_cli.py --hub_ip=myneohub set_time "2021-01-31 15:43:00"  # Specify times like this
$ neohub_cli.py --hub_ip=myneohub set_lock 1234 "Living Room"  # Name NeoStats like this.