Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
valleedelisle authored Dec 19, 2023
1 parent d88e029 commit 1db9e21
Showing 1 changed file with 3 additions and 20 deletions.
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,8 @@
# 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 Microsoft SignalR.

## Running the PoC

```
$ python -m virtualenv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
$ cat << EOF > .env
export hilo_username="[email protected]"
export hilo_password="secretpassword"
$ source .env
$ ./test.py
```
`python-hilo` (aka `pyhilo`) is a Python 3.11, `asyncio`-driven interface to the unofficial
Hilo API from Hydro Quebec. This is meant to be integrated into Home Assistant but can also
be used as a standalone library.

Home assistant integration is available [here](https://github.com/dvd-dev/hilo)

Expand Down

0 comments on commit 1db9e21

Please sign in to comment.