python-hilo 2021.12.1

A Python3, async interface to the Hilo API

python-hilo

python-hilo (aka pyhilo) is a Python 3.9, asyncio-driven interface to the unofficial Hilo API from Hydro Quebec. This is meant to be integrated into Home Assistant.

Nothing is fully functional right now except for the PoC. Before this package, the Hilo API was returning all information via some REST calls. Since the end of 2021, Hilo has deprecated some of the endpoints including the ones that returns the status of the devices. This was replaced with a websocket system using Google Firebase.

Running the PoC

$ python -m virtualenv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
$ cat << EOF > .env
export hilo_username="[e-mail]"
export hilo_password="secretpassword"
$ source .env
$ ./test.py

TODO

• Creating device classes for each types and map similarly to HA
• Light switches and dimmers
• Gateway
• Power Sensors
• Hilo Challenge events
• Type everything: almost done, got a few "type: ignore" to fix
• Home Assistant component integration
• Publish this package

Later?

• Full docstrings and doc generation
• Unit testing
• Functional testing

If anyone wants to contribute, feel free to submit a PR. If you'd like to sync up first, you can fire me an email [e-mail]