-
Notifications
You must be signed in to change notification settings - Fork 5
/
hydroqc2mqtt.xml
48 lines (48 loc) · 4.93 KB
/
hydroqc2mqtt.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?xml version="1.0"?>
<Container version="2">
<Name>hydroqc2mqtt</Name>
<Repository>registry.gitlab.com/hydroqc/hydroqc2mqtt:latest</Repository>
<Registry>https://registry.gitlab.com/hydroqc/hydroqc2mqtt</Registry>
<Network>bridge</Network>
<MyIP/>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://forums.unraid.net/topic/129079-support-devzwf-hydroqc2mqtt</Support>
<Project>https://hydroqc.ca/</Project>
<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</Overview>
<Category>HomeAutomation:</Category>
<WebUI/>
<TemplateURL/>
<Icon>https://raw.githubusercontent.com/devzwf/unraid-docker-templates/main/images/hydroqc-logo.png</Icon>
<ExtraParams>--restart=always</ExtraParams>
<PostArgs/>
<CPUset/>
<DateInstalled>1664399852</DateInstalled>
<DonateText>Don't donate to me! Instead, please donate the creators of the apps, but if you insist </DonateText>
<DonateLink>https://ko-fi.com/devzwf</DonateLink>
<Requires/>
<Config Name="MQTT Username" Target="MQTT_USERNAME" Default="" Mode="" Description="Optional" Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="MQTT Password" Target="MQTT_PASSWORD" Default="" Mode="" Description="Optional" Type="Variable" Display="always" Required="false" Mask="true"></Config>
<Config Name="MQTT Host" Target="MQTT_HOST" Default="" Mode="" Description="" Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="MQTT Port" Target="MQTT_PORT" Default="1883" Mode="" Description="" Type="Variable" Display="always" Required="true" Mask="false">1883</Config>
<Config Name="Contract 0 Name" Target="HQ2M_CONTRACTS_0_NAME" Default="" Mode="" Description="Name of the contract, will appear in Home Assistant and in the hydroqc topics." Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Contract 0 Username" Target="HQ2M_CONTRACTS_0_USERNAME" Default="" Mode="" Description="Username for your HQ account" Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Contract 0 Password" Target="HQ2M_CONTRACTS_0_PASSWORD" Default="" Mode="" Description="Your HQ account password" Type="Variable" Display="always" Required="true" Mask="true"></Config>
<Config Name="Contract 0 Customer number" Target="HQ2M_CONTRACTS_0_CUSTOMER" Default="" Mode="" Description="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’" Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Contract 0 Account Number" Target="HQ2M_CONTRACTS_0_ACCOUNT" Default="" Mode="" Description="Account Number (Numéro de compte) from your invoice" Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Contract 0 Contract number" Target="HQ2M_CONTRACTS_0_CONTRACT" Default="" Mode="" Description="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’" Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Contract 0 Homeassistant websocket URL" Target="HQ2M_CONTRACTS_0_HOME_ASSISTANT_WEBSOCKET_URL" Default="" Mode="" Description="URL to your Home-Assistant installation websocket API" Type="Variable" Display="always" Required="true" Mask="false"></Config>
<Config Name="Contract 0 Homeassistant Token" Target="HQ2M_CONTRACTS_0_HOME_ASSISTANT_TOKEN" Default="" Mode="" Description="Long-lived Home-Assistant access token to be used to access the API" Type="Variable" Display="always" Required="true" Mask="true"></Config>
<Config Name="Contract 0 Hourly sync consumption Flag" Target="HQ2M_CONTRACTS_0_SYNC_HOURLY_CONSUMPTION_ENABLED" Default="true" Mode="" Description="Enable importing hourly consumption from Hydro-Quebec (last 24h)" Type="Variable" Display="advanced" Required="true" Mask="false">true</Config>
<Config Name="Contract 0 Log Level" Target="HQ2M_CONTRACTS_0_LOG_LEVEL" Default="INFO" Mode="" Description="" Type="Variable" Display="advanced-hide" Required="false" Mask="false">INFO</Config>
<Config Name="Contract 0 HTTP Log Level" Target="HQ2M_CONTRACTS_0_HTTP_LOG_LEVEL" Default="WARNING" Mode="" Description="" Type="Variable" Display="advanced-hide" Required="false" Mask="false">WARNING</Config>
<Changes>### 2020.09.30
- Update registry
- add changelog
### 2022.09.29
- Initial Release</Changes>
</Container>