neohubapi/README.md

36 lines
849 B
Markdown
Raw Normal View History

2020-12-27 19:20:49 +00:00
<!--
SPDX-FileCopyrightText: 2020 Andrius Štikonas <andrius@stikonas.eu>
SPDX-License-Identifier: CC-BY-4.0
-->
2021-01-02 22:55:13 +00:00
# NeoHubAPI
2020-12-27 19:20:49 +00:00
This is a simple python wrapper around Heatmiser's Neohub API.
2021-01-02 22:55:13 +00:00
It's primary purpose is to be used via Home Assistant integration but
it can also be used as a standalone library.
2020-12-27 19:20:49 +00:00
## Usage example
```python
import asyncio
import neohubapi.neohub as neohub
async def run():
hub = neohub.NeoHub()
system = await hub.get_system()
2021-01-02 22:55:13 +00:00
hub_data, devices = await hub.get_live_data()
for device in devices['thermostats']:
2020-12-27 19:20:49 +00:00
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