neohubapi/README.md

36 lines
849 B
Markdown

<!--
SPDX-FileCopyrightText: 2020 Andrius Štikonas <andrius@stikonas.eu>
SPDX-License-Identifier: CC-BY-4.0
-->
# 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
```python
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