Add hydroquebec sensor documentation (home-assistant#1581)

titilambert · fabaff · commit ed1a976532ed · 2016-12-18T12:24:00.000+01:00
diff --git a/source/_components/sensor.hydroquebec.markdown b/source/_components/sensor.hydroquebec.markdown
@@ -0,0 +1,54 @@
+---
+layout: page
+title: "Hydro-Québec"
+description: "Instructions how to integrate Hydro-Québec consumption profile within Home Assistant."
+date: 2016-12-10 0:15
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: hydroquebec.svg
+ha_category: Energy
+ha_release: 0.35
+ha_iot_class: "Cloud Polling"
+---
+
+
+Integrate your [Hydro-Québec](https://www.hydroquebec.com/portail/) consumption profile information into Home Assistant.
+
+```yaml
+# Example configuration.yaml entry
+ensor:
+  - platform: hydroquebec
+    username: MYUSERNAME
+    password: MYPASSWORD
+    monitored_variables:
+     - period_total_bill
+     - period_length
+     - period_total_days
+     - period_mean_daily_bill
+     - period_mean_daily_consumption
+     - period_total_consumption
+     - period_lower_price_consumption
+     - period_higher_price_consumption
+     - yesterday_total_consumption
+     - yesterday_lower_price_consumption
+     - yesterday_higher_price_consumption
+```
+
+Configuration variables:
+
+- **username** (*Required*): The App Token for your account.
+- **password** (*Required*): The App Token for your account.
+- **monitored_variables** array (*Required*): Variables to monitor.
+  - **period_total_bill** : Current period bill
+  - **period_length**: Current period length
+  - **period_total_days**: Total number of days in this period
+  - **period_mean_daily_bill**: Period daily average bill
+  - **period_mean_daily_consumption**: Period daily average consumption
+  - **period_total_consumption**: Total Consumption
+  - **period_lower_price_consumption**: Period Lower price consumption
+  - **period_higher_price_consumption**: Period Higher price consumption
+  - **yesterday_total_consumption**: Yesterday total consumption
+  - **yesterday_lower_price_consumption**: Yesterday lower price consumption
+  - **yesterday_higher_price_consumption**: Yesterday higher price consumption
diff --git a/source/images/supported_brands/hydroquebec.svg b/source/images/supported_brands/hydroquebec.svg
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 19.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 200 65"  xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#FF9B00;}
+	.st1{fill:#003366;}
+</style>
+<g>
+	<path class="st0" d="M44.9,49.5C40.4,53,34.8,55,28.7,55C14,55,2.1,43.1,2.1,28.4C2.1,13.6,14,1.7,28.7,1.7
+		c14.7,0,26.6,11.9,26.6,26.6c0,6.1-2,11.7-5.5,16.2v0c1.3,1,7.4,5.5,8,6.3c-0.2-2.2-1-9.3-1-9.3l22.3,16.7l0.1,0.5l-16.5-7.3
+		L64.2,64L44.9,49.5L44.9,49.5z M38.5,44.5c-3.1-2.3-15.1-11-15.1-11h11.7c0.7,0.5,5.9,4.4,8.5,6.4l0,0c2.4-3.2,3.9-7.2,3.9-11.5
+		c0-10.5-8.4-19-18.8-19c-10.4,0-18.8,8.5-18.8,19c0,10.5,8.4,19,18.8,19C32.3,47.3,35.7,46.3,38.5,44.5L38.5,44.5z"/>
+	<g>
+		<g>
+			<path class="st1" d="M89.2,24.8L86,10.1h4.7l1,6.9c0.2,1.6,0.4,2.9,0.6,3.9h0.1c0.3-1,0.8-2.2,1.5-3.9l2.9-6.9h4.7L91.1,30.8
+				l-5.3,0L89.2,24.8z"/>
+			<path class="st1" d="M72.8,4.1l-1.6,8.5h8.1l1.6-8.5h4.5l-4.1,21.8h-4.5l1.7-9.2h-8.1l-1.7,9.2h-4.5l4.1-21.8H72.8z"/>
+			<path class="st1" d="M117.8,25.9l1.8-9.5c0.4-2.4,0.6-5,0.8-6.3h3.9c-0.1,1.1-0.2,2.1-0.3,3.3h0.1c1.1-2.1,2.9-3.6,5-3.6
+				c0.3,0,0.6,0,0.9,0l-0.9,4.4c-0.2,0-0.5,0-0.7,0c-2.9,0-4.4,2.7-4.9,5.8l-1.1,6H117.8z"/>
+			<path class="st1" d="M136,26.3c-4,0-6.7-2.6-6.7-6.5c0-5.4,3.8-10,9.4-10c4.2,0,6.7,2.9,6.7,6.5C145.4,21.9,141.4,26.3,136,26.3
+				L136,26.3z M136.6,22.8c2.6,0,4.1-3.8,4.1-6.5c0-1.5-0.7-3.1-2.6-3.1c-2.7,0-4.2,3.9-4.2,6.5C133.9,21.5,134.9,22.8,136.6,22.8
+				L136.6,22.8z"/>
+			<path class="st1" d="M118.3,3.6l-3.1,16.3c-0.4,2-0.7,4.2-0.7,6h-4.1l0.2-2.6h-0.1c-1.4,2.1-3.3,3-5.2,3c-2.7,0-4.9-2.1-4.9-5.9
+				c0-5.5,4-10.6,9.9-10.6c0.7,0,1.5,0.1,2.2,0.4l1.3-6.6H118.3z M111.9,13.7c-0.4-0.3-1.1-0.6-1.9-0.6c-2.9,0-4.9,3.3-4.9,6.4
+				c0,1.9,0.8,3.1,2.2,3.1c1.4,0,3.1-1.5,3.7-4.6L111.9,13.7z"/>
+		</g>
+		<g>
+			<path class="st1" d="M134,36.8l-2,10.7c-0.4,2-0.6,3.7-0.8,5.1h-4l0.3-2.6l-0.1,0c-1.6,2.1-3.5,3-5.4,3c-2.5,0-4.1-1.4-4.1-4.4
+				c0-0.9,0.1-1.8,0.3-2.9l1.7-8.8h4.5l-1.6,8.5c-0.1,0.7-0.2,1.5-0.2,2.1c0,1.1,0.4,1.9,1.7,1.9c1.6,0,3.3-1.9,3.9-5.1l1.4-7.4H134
+				z"/>
+			<path class="st1" d="M195.3,52.1c-1,0.5-2.6,0.8-4.5,0.8c-3.9,0-6.6-2.4-6.6-6.5c0-5.6,4.3-10,10.2-10c1.4,0,2.5,0.3,3.2,0.5
+				l-1.1,3.4c-0.6-0.2-1.2-0.4-2.2-0.4c-3.4,0-5.5,2.9-5.5,5.9c0,2.2,1.4,3.4,3.2,3.4c1.4,0,2.4-0.3,3.2-0.7L195.3,52.1z"/>
+			<g>
+				<path class="st1" d="M150.1,51.9l4.1-21.7l4.5,0l-1.6,8.6l0.1,0c0.9-1.4,2.9-2.5,4.9-2.5c3.3,0,4.9,2.5,4.9,5.5
+					C166.7,50.6,159.1,55.2,150.1,51.9z M155,49.3c4.1,1.8,7.1-2.9,7.1-6.6c0-1.6-0.8-2.8-2.1-2.8c-1.8,0-3.6,1.8-4.2,5.1L155,49.3z
+					"/>
+			</g>
+			<path class="st1" d="M182.7,44.9c0.7-3,0.6-8.5-5.4-8.5c-5.8,0-9.2,5.1-9.2,9.9c0,4,2.2,6.6,6.8,6.6c1.8,0,4.1-0.4,5.8-1.2
+				l-0.3-3.3c-1.2,0.8-7.8,2.6-8-2L182.7,44.9z M172.8,43.5c0.1-1.1,1.3-3.5,3.5-3.8c2.1-0.2,2.9,1.5,2.6,2.9L172.8,43.5z"/>
+			<path class="st1" d="M104.2,53c-3.7,0-8.7-2.3-8.7-9.2c0-6.6,4.2-13.3,11.9-13.3c6,0,8.7,4.3,8.7,9.1c0,5-3.2,8.9-5.2,10v0
+				c0.2,0,1.7-0.5,3.4-0.5c0,0,0.9,0,1.4,0l-0.7,3.5c-0.3,0-2.6,0-5.5,0C107.2,52.6,107.2,53,104.2,53z M104.9,49.2
+				c4,0,6.5-5.4,6.5-9.6c0-2.5-1-5.3-4.5-5.3c-4.1,0-6.6,5.5-6.6,9.6C100.2,46.9,101.7,49.2,104.9,49.2L104.9,49.2z"/>
+			<path class="st1" d="M149.4,30.2l-4,4.7h-3.2l3-4.7H149.4z M149.3,44.9c0.7-3,0.6-8.5-5.4-8.5c-5.8,0-9.2,5.1-9.2,9.9
+				c0,4,2.2,6.6,6.8,6.6c1.8,0,4.1-0.4,5.8-1.2l-0.3-3.3c-1.2,0.8-7.8,2.6-8-2L149.3,44.9z M139.3,43.5c0.1-1.1,1.3-3.5,3.5-3.8
+				c2.1-0.2,2.9,1.5,2.5,2.9L139.3,43.5z"/>
+		</g>
+	</g>
+</g>
+</svg>
