Back to appsSubmit
hydroqc2mqtt

hydroqc2mqtt

Docker app from ZappyZap's Repository

Overview

This project was created to provide a way to access Hydro-Québec account and winter credit data in Home-Assistant. This module use the hydroqc library to fetch all pertinent account information and winter credit signals to be sent to MQTT. It also provide Home-Assistant discovery topics to create all the relevant sensors in Home-Assistant. It also includes a separate logic that sends the hourly consumption statistics to Home-Assitant via websocket

Runtime arguments

Network
bridge
Shell
sh
Privileged
false
Extra Params
--restart=unless-stopped

Template configuration

MQTT UsernameVariable

Optional

Target
MQTT_USERNAME
MQTT PasswordVariable

Optional

Target
MQTT_PASSWORD
MQTT HostVariable
Target
MQTT_HOST
MQTT PortVariable
Target
MQTT_PORT
Default
1883
Value
1883
Contract 0 NameVariable

Name of the contract, will appear in Home Assistant and in the hydroqc topics.

Target
HQ2M_CONTRACTS_0_NAME
Contract 0 UsernameVariable

Username for your HQ account

Target
HQ2M_CONTRACTS_0_USERNAME
Contract 0 PasswordVariable

Your HQ account password

Target
HQ2M_CONTRACTS_0_PASSWORD
Contract 0 Customer numberVariable

Customer number (Numéro de client) from your invoice. 10 digits, you may need to add a leading 0 to the value Ex: ‘987 654 321’ will be ‘0987654321’

Target
HQ2M_CONTRACTS_0_CUSTOMER
Contract 0 Account NumberVariable

Account Number (Numéro de compte) from your invoice

Target
HQ2M_CONTRACTS_0_ACCOUNT
Contract 0 Contract numberVariable

Contract Number (Numéro de contrat) from your invoice. 10 digits, you may need to add a leading 0 to the value. Ex: ‘123 456 789’ will be ‘0123456789’

Target
HQ2M_CONTRACTS_0_CONTRACT
Contract 0 Homeassistant websocket URLVariable

URL to your Home-Assistant installation websocket API

Target
HQ2M_CONTRACTS_0_HOME_ASSISTANT_WEBSOCKET_URL
Contract 0 Homeassistant TokenVariable

Long-lived Home-Assistant access token to be used to access the API

Target
HQ2M_CONTRACTS_0_HOME_ASSISTANT_TOKEN
Contract 0 Hourly sync consumption FlagVariable

Enable importing hourly consumption from Hydro-Quebec (last 24h)

Target
HQ2M_CONTRACTS_0_SYNC_HOURLY_CONSUMPTION_ENABLED
Default
true
Value
true
Contract 0 RateVariable

Your rate

Target
HQ2M_CONTRACTS_0_RATE
Default
D
Contract 0 Rate OptionVariable

Rate option for the contract must be 'NONE' if you do not have one.

Target
HQ2M_CONTRACTS_0_RATE_OPTION
Default
CPC
Contract 0 Preheat durationVariable

Duration of the pre-heat period in minute

Target
HQ2M_CONTRACTS_0_PREHEAT_DURATION_MINUTES
Default
180
Contract 0 Log LevelVariable
Target
HQ2M_CONTRACTS_0_LOG_LEVEL
Default
INFO
Value
INFO
Contract 0 HTTP Log LevelVariable
Target
HQ2M_CONTRACTS_0_HTTP_LOG_LEVEL
Default
WARNING
Value
WARNING

Categories

Home Automation

Links

TemplateSupportRegistryProject

Details

Repository
registry.gitlab.com/hydroqc/hydroqc2mqtt:latest
Registry
https://registry.gitlab.com/hydroqc/hydroqc2mqtt
Last Updated2026-06-01
First Seen2022-09-29

Run Hydroqc2mqtt on Unraid.

Hydroqc2mqtt is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS