A wrapper library to access hydro quebec API and more
Project description
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
Account Scenarios
Each account and contracts 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 | EPP* | Tester | Test result | Last run | Multi Contract | Multi Customer | Comment |
---|---|---|---|---|---|---|---|---|
D | No | @weimdall | Yes | |||||
D | Yes | @devzwf | ||||||
D | CPC** | Yes | @zepiaf | |||||
D | CPC** | No | @titilambert | Yes |
*EPP = Equal Payment Plan
**CPC = Crédit Pointe Critique (Winter Credits)
Flex D (DPC)
Base Rate | EPP | Tester | Test result | Last run | Multi contract | Multi Customer | Comment |
---|---|---|---|---|---|---|---|
DPC | No | @mdallaire1 | No | No | Flex-D specifics not tested yet |
*EPP = Equal Payment Plan
Dual Energy (DT)
Base Rate | EPP | Tester | Test result | Last run | Multi contract | Multi Customer | Comment |
---|---|---|---|---|---|---|---|
DT | Yes | @mdallaire1 | No | No | DT specifics No tested yet |
*EPP = Equal Payment Plan
Rate M
Base Rate | Rate Option | Tester | Test result | Last run | Multi contract | Multi Customer | Comment |
---|---|---|---|---|---|---|---|
M | - | @hdenergy | Yes | Yes | HD Énergie | ||
M | GDP | @hdenergy | Yes | Yes | 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 (tested with 3.8)
-
Clone the repo
git clone https://gitlab.com/hydroqc/hydroqc.git
-
Create a virtual-env
python -m venv env . env/bin/activate pip install --editable .
-
Enter your hydro account credentials in the examples/hydro.py file (line 6)
-
Run
examples/hydro.py
Available features
- Services.getWinterCredit() to get raw winter credit data
- Services.getTodayHourlyConsumption() to get raw hourly consumption for current day
- Services.getHourlyConsumption(date = 'YYYY-MM-DD') to get hourly consumption for specific day
- Services.getDailyConsumption(start_date = 'YYYY-MM-DD',end_date = 'YYYY-MM-DD') to get a range of daily consumption
- WinterCredit.getFutureEvents() to get a list of JSON object with future peak events
NOTES
As per issue https://github.com/zepiaf/hydroqc/issues/11 the full certificate chain for "session.hydroquebec.com" is not provided completely by Hydro-Quebec, resulting in a failed SSL verification. We are providing it in the "hydro-chain.pem" file and the code is using this file to validate the certificate in queries to "session.hydroquebec.com".
We would very much like for this to be either fixed by Hydro-Quebec or for this chain to be dynamicaly built at run time. Any help to make this happen would be greatly appreciated.
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{
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Hydro-Quebec-API-Wrapper-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 139ab9de35b4b20483d2b5bc3a2ca5e213b2e830f1fb12f637b5668b5cb8902b |
|
MD5 | 6a45ef4a4e1233a22516d28774d3f6d8 |
|
BLAKE2b-256 | 6ec1b354821ae25e60e694f823eb333964a4677b631954d08edb841d4a3fa344 |
Hashes for Hydro_Quebec_API_Wrapper-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a25536f01f1f7a6eb676124021847d10205885c67bd61456deb6bc5c4b4cba6 |
|
MD5 | c9a5fa4d54c3fa53bd092c2d3cf695cd |
|
BLAKE2b-256 | 85c6b25b4c6c4eefae65ccb126d0df2acfb87b873349ef6c48ec8210b6d084eb |