Hydro-Quebec-API-Wrapper 3.1.3

A wrapper library to access hydro quebec API and more

HydroQC - Hydro Quebec API wrapper

This is a library to use if you want to build your own solution. If you want a user-friendly implementation for your home automation system please use hydroqc2mqtt which provide a MQTT publisher, docker image and HASS addon.

This is a package to access some functionalities of Hydro Quebec API that are not documented.

We started a discord server for the project where you can come to discuss and find help with the project on our #development channel

Donations

We put a lot of heart and effort in this project, any contribution is greatly appreciated!

Tested Rates

Each account, contracts and rates are different and we do our best to integrate all available options. Currently the account combinations listed below are supported and tested automaticaly by our CI/CD pipeline. If your account scenario is not currently tested and listed as Needed feel free to reach out to us on our discord #development channel if you want to volunter for testing. We provide a way to setup CI/CD tests in your own account in a way that keep your account info private to you (more details here). Keep in mind that this process is a bit involved technicaly so it is best if you have some working knowledge with Gitlab.

Rate D

Base Rate	Rate Option	Tester	Test result	Last run	Comment
D	-	@weimdall
D	-	@mdallaire1
D	-	@devzwf			Hilo
D	CPC	@titilambert

Flex D (DPC)

Base Rate	Rate Option	Tester	Test result	Last run	Comment
DPC	-	@mdallaire1

Dual Energy (DT)

Base Rate	Rate Option	Tester	Test result	Last run	Comment
DT	-	@mdallaire1

Rate M

Base Rate	Rate Option	Tester	Test result	Last run	Comment
M	-	@hdenergy			HD Énergie
M	GDP	@hdenergy			HD Énergie

Thanks to HD Énergie for sponsoring developpement of the Rate M support.

Other plans

We don't have anyone to test with. Please reach out to us if you have this plan and want to help!

Documentation

Code documentation

https://hydroqc.readthedocs.io/

Architecture / concepts

If you need more information about the usage and current integrations of the library please see our website https://hydroqc.ca

Goal

Make it easy to fetch and manipulate data from Hydro-Quebec, especially the winter credit periods

Example folder

An example script that extracts the data available from Hydro-Quebec is available in the examples folder.

Basic setup

This uses python 3.10

1. Clone the repo

   git clone https://gitlab.com/hydroqc/hydroqc.git
   

2. Create a virtual-env

   python -m venv env
   . env/bin/activate
   pip install --editable .
   

3. Enter your hydro account credentials in the examples/hydro.py file (line 6)

4. Run

   examples/hydro.py
   

TODO

https://gitlab.com/groups/hydroqc/-/issues

Targeted architecture (might change in the future)

classDiagram
    WebUser <-- Customer
    WebUser <-- HydroClient

    Customer <-- Account

    Account <-- Contract

    Contract <-- HydroClient
    Contract <-- Period
    Contract <-- Event
    Contract <-- WinterCreditHelper

    WinterCreditHelper <-- HydroClient


    HydroClient <-- Authenticator

    class HydroClient{

    }
    class WinterCreditHelper{
    }

    class WebUser{
        -HydroClient _hydro_client
        +List~Customer~ customers
        +get_contracts()
    }

    class Customer{
        -HydroClient _hydro_client
        +List~Account~ accounts
    }

    class Account{
        -HydroClient _hydro_client
        +List~Contract~ contracts
    }

    class Config{
        -string config_file_path
    }

    class Contract{
        -HydroClient _hydro_client
        -int customer_id
        -int webuser_id
        +string subscription_type
        +float balance
        +list~Period~ periods
        +list~Event~ events
        +get_winter_credit()
        +fetch_periods()
        +fetch_summary()
    }

    class Period{
    }

    class Event{
    }