diogos88 / pyhydroquebec

Get your consumption data from your HydroQuebec account (www.hydroquebec.com)

PyHydroQuebec

TODO

• Add automated tests

Installation

pip install pyhydroquebec

Usage

Print your current data

pyhydroquebec -u MYACCOUNT -p MYPASSWORD

List your current contracts

pyhydroquebec -u MYACCOUNT -p MYPASSWORD -l

Print help

usage: pyhydroquebec [-h] [-u USERNAME] [-p PASSWORD] [-j] [-i] [-c CONTRACT]
                    [-l] [-H] [-t TIMEOUT] [-V] [--detailled-energy]
                    [--start-date START_DATE] [--end-date END_DATE]

optional arguments:
    -h, --help                          show this help message and exit
    -u USERNAME, --username USERNAME    Hydro Quebec username
    -p PASSWORD, --password PASSWORD    Password
    -j, --json                          Json output
    -i, --influxdb                      InfluxDb output
    -c CONTRACT, --contract CONTRACT    Contract number
    -l, --list-contracts                List all your contracts
    -H, --hourly                        Show yesterday hourly consumption
    -t TIMEOUT, --timeout TIMEOUT       Request timeout
    -V, --version                       Show version

Detailled-energy raw download option:
    --detailled-energy                  Get raw json output download
    --start-date START_DATE             Start date for detailled-output
    --end-date END_DATE                 End date for detailled-output

MQTT DAEMON

Create configuration file.

mkdir -p /docker/pyhydroquebec
cp config.yaml.sample /docker/pyhydroquebec/config.yaml

Edit configuration parameters [username, password, id].

# THIS YAML CAN CHANGE IN THE FUTURE
timeout: 30
# 6 hours
frequency: 8640
accounts:
- username: USERNAME@EMAIL
  password: PASSWORD
  contracts:
    - id: CONTRACT_ID

Edit docker-compose parameters [MQTT_USERNAME, MQTT_PASSWORD, MQTT_HOST, MQTT_PORT].

nano docker-compose.yaml

Deploy with docker-compose.

docker-compose -f docker-compose.yaml up -d

Docker

Docker image list: https://gitlab.com/ttblt-hass/pyhydroquebec/container_registry

docker run -e PYHQ_USER=*** -e PYHQ_PASSWORD=*** registry.gitlab.com/ttblt-hass/pyhydroquebec/cli:master

Docker variables

PYHQ_USER - Required

-e PYHQ_USER=myusername

PYHQ_PASSWORD - Required

-e PYHQ_PASSWORD=mypassword

PYHQ_OUTPUT

• -e PYHQ_OUTPUT=TEXT - Default
• -e PYHQ_OUTPUT=JSON
• -e PYHQ_OUTPUT=INFLUXDB
• -e PYHQ_OUTPUT=CONTRACT

PYHQ_CONTRACT

-e PYHQ_CONTRACT=332211223

Dev env

make env

Run test

USERNAME=myhydrousername PASSWORD=myhydropassword tox