NeoHubAPI
This is a simple python wrapper around Heatmiser's Neohub API. Up-to-date documentation for the API can be obtained from the Heatmiser Developer Portal. You will need to sign up for a free account.
The primary purpose of this module is to help with Home Assistant integration but it can also be used as a standalone library for other projects.
Connection methods
The API provides two connection methods. The so-called "legacy" method is by way of an unencrypted connection to port 4242 of the Neohub. The newer method uses an encrypted websocket on port 4243, but only works on a second generation hub (look for the sticker on the back).
To use the websocket connection, you need to obtain a token from the Heatmiser Neo app. Go to Settings > API > + in the app and create one.
On newer hubs, the legacy connection may be disabled by default. If you want to use it, go to Settings > API in the app, and enable it from there.
Usage example
import asyncio
import neohubapi.neohub as neohub
async def run():
# Legacy connection
hub = neohub.NeoHub()
# Or, for a websocket connection:
# hub = neohub.Neohub(port=4243, token='xxx-xxxxxxx')
system = await hub.get_system()
hub_data = await hub.get_devices_data()
devices = hub_data['neo_devices']
for device in devices:
print(f"Temperature in zone {device.name}: {device.temperature}")
await device.identify()
asyncio.run(run())
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.
$ neohub_cli.py --hub_ip=myneohub --hub_token=XXX get_system # Get system variables with websocket connection
1 maintainer
Release files for neohubapi 3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| neohubapi-3.2.tar.gz | 35.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| neohubapi-3.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 57.0 kB
Release files / neohubapi-3.2.tar.gz
| Download URL | neohubapi-3.2.tar.gz |
|---|---|
| Size | 35.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf45f4c2d6bfe19ea35915a6fb2b94ed35ecaa4195aec52328a8bb525677892a
|
|
BLAKE2b-256 checksum How to use checksums |
62a9bd9dbe656b8b2579b34d23e974aea441712173777548941829751dcb59fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / neohubapi-3.2-py3-none-any.whl
| Download URL | neohubapi-3.2-py3-none-any.whl |
|---|---|
| Size | 22.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0ad50c40d43888296c3015419d1063b9ca99412d691375601fbdfdec4ac810bf
|
|
BLAKE2b-256 checksum How to use checksums |
480b76af2dd08abab5fdd6cb217211e0318029d2e964d35b9be7a415534787ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
