Merge pull request #844 from fabaff/climate

Climate

source/_components/climate.ecobee.markdown

@@ -0,0 +1,15 @@
+---
+layout: page
+title: "Ecobee Thermostat"
+description: "Instructions how to setup the Ecobee thermostats within Home Assistant."
+date: 2016-08-26 18:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: ecobee.png
+ha_category: Climate
+ha_release: 0.9
+---
+
+To get your Ecobee thermostats working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).

source/_components/climate.eq3btsmart.markdown

@@ -0,0 +1,64 @@
+---
+layout: page
+title: "EQ3 Bluetooth Smart Thermostats"
+description: "Instructions how to integrate EQ3 Bluetooth Smart Thermostats into Home Assistant."
+date: 2016-04-18 22:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: eq3.gif
+ha_category: Climate
+ha_iot_class: "Local Poll"
+---
+
+
+The `eq3btsmart` climate platform allows you to integrate EQ3 Bluetooth Smart Thermostats.
+
+The only functionality is to set the temperature, there doesn't seem to be any way to query the temperature sensor or battery level ([read more](https://forum.fhem.de/index.php/topic,39308.15.html)).
+
+Setup is a bit more cumbersome than for most other thermostats. It has to be paired first:
+
+```bash
+bluetoothctl
+scan on
+<Wait for the thermostat to be found, which looks like this: [NEW] Device 00:11:22:33:44:55 CC-RT-BLE>
+scan off
+<Set the thermostat to pairing mode.>
+pair <MAC>
+trust <MAC>
+disconnect <MAC>
+exit
+```
+
+Then check with gatttool if the connection works as expected:
+
+```bash
+gatttool -b 00:11:22:33:44:55 -I
+[00:11:22:33:44:55][LE]> connect
+Attempting to connect to 00:11:22:33:44:55
+Connection successful
+[00:11:22:33:44:55][LE]> char-write-req 0x0411 03
+Characteristic value was written successfully
+Notification handle = 0x0421 value: 02 01 09 14 04 2d
+[00:11:22:33:44:55][LE]> disconnect
+[00:11:22:33:44:55][LE]> exit
+```
+
+Important: For gatttool or homeassistant to work, the thermostat needs to be disconnected from bluetoothd, so I found it best to modify the hass-daemon startscript by adding:
+
+```bash
+/usr/bin/bt-device -d CC-RT-BLE
+```
+
+to the start function of /etc/init.d/hass-daemon.
+
+
+```yaml
+# Example configuration.yaml entry
+climate:
+  platform: eq3btsmart
+    devices:
+      room1:
+        mac: '00:11:22:33:44:55'
+```

source/_components/climate.generic_thermostat.markdown

@@ -0,0 +1,45 @@
+---
+layout: page
+title: "Generic Thermostat"
+description: "Turn Home Assistant into a thermostat"
+date: 2015-03-23 19:59
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: heat-control.png
+ha_category: Climate
+---
+
+
+The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater under the hood. If the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when required temperature is reached.
+
+```yaml
+# Example configuration.yaml entry
+climate:
+  platform: heat_control
+  name: Study
+  heater: switch.study_heater
+  target_sensor: sensor.study_temperature
+  min_temp: 15
+  max_temp: 21
+  target_temp: 15
+  min_cycle_duration:
+  # At least one of these must be specified:
+     days: 2
+     hours: 1
+     minutes: 10
+     seconds: 5
+     milliseconds: 20
+```
+
+Configuration variables:
+
+- **name** (*Required*): Name of thermostat
+- **heater** (*Required*: `entity_id` for heater switch, must be a toggle device.
+- **target_sensor** (*Required*): `entity_id` for a temperature sensor, target_sensor.state must be temperature.
+- **min_temp** (*Optional*): Set minimum set point available (default: 7)
+- **max_temp** (*Optional*): Set maximum set point available (default: 35)
+- **target_temp** (*Required*): Set intital target temperature. Failure to set this variable will result in target temperature being set to null on startup.
+- **ac_mode** (*Optional*): Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device.
+- **min_cycle_duration** (*Optional*): Set a minimum amount of time that the switch specified in the *heater* option must be in it's current state prior to being switched either off or on.

source/_components/climate.heatmiser.markdown

@@ -0,0 +1,41 @@
+---
+layout: page
+title: "Heatmiser Thermostat"
+description: "Instructions how to integrate Heatmiser thermostats within Home Assistant."
+date: 2015-12-11 12:35
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: heatmiser.png
+ha_category: Climate
+ha_release: "0.10"
+---
+
+
+The `heatmiser` climate platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](http://www.heatmisershop.co.uk/heatmiser-slimline-programmable-room-thermostat/) thermostats from Heatmiser.  The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
+
+Further work would be required to get this setup to connect over Wifi, but the HeatmiserV3 python module being used is a full implementation of the V3 protocol.  If you would like to contribute to making this work over wifi, please contact @andylockran on github.
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+climate:
+  platform: heatmiser
+  ipaddress: YOUR_IPADDRESS
+  port:  YOUR_PORT
+  tstats:
+    1:
+    id: THERMOSTAT_ID
+    name: THERMOSTAT_NAME
+```
+
+A single interface can handle up to 32 connected devices.
+
+Configuration variables:
+
+- **ipaddress** (*Required*): The ip address of your interface.
+- **port** (*Required*): The port that the interface is listening on.
+- **tstats** (*Required*): A list of thermostats activated on the gateway.
+- **id** (*Required*): The id of the thermostat as configured on the device itself
+- **name** (*Required*): A friendly name for the themostat

source/_components/climate.homematic.markdown

@@ -0,0 +1,19 @@
+---
+layout: page
+title: "Homematic Thermostats"
+description: "Instructions how to integrate Homematic thermostats within Home Assistant."
+date: 2016-06-28 08:30
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: homematic.png
+ha_category: Climate
+ha_release: 0.23
+ha_iot_class: "Local Push"
+---
+
+
+The `homematic` cliamte platform lets you control [Homematic](http://www.homematic.com/) thermostats through Home Assistant.
+
+Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

source/_components/climate.honeywell.markdown

@@ -0,0 +1,32 @@
+---
+layout: page
+title: "Honeywell Thermostat"
+description: "Instructions how to integrate Honeywell thermostats within Home Assistant."
+date: 2016-02-07 22:01
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: honeywell.png
+ha_category: Climate
+---
+
+
+The `honeywell` cliamte platform let you control [Honeywell Connected](http://getconnected.honeywell.com/en/) thermostats from Home Assistant.
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+cliamte:
+  platform: honeywell
+  username: YOUR_USERNAME
+  password:  YOUR_PASSWORD
+  region: REGION
+```
+
+Configuration variables:
+
+- **username** (*Required*: The username of an user with access.
+- **password** (*Required*): The password for your given admin account.
+- **away_temperature** (*optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
+- **region** (*optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided.

source/_components/climate.knx.markdown

@@ -0,0 +1,35 @@
+---
+layout: page
+title: "KNX Thermostat"
+description: "Instructions on how to integrate KXN thermostats with Home Assistant."
+date: 2016-06-24 12:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: knx.png
+ha_category: DIY
+ha_release: 0.25
+---
+
+
+The `knx` climate platform is used as in interface with KNX thermostats.
+
+KNX thermostats use at least 2 group addresses: one for the current temperature and one for the target temperature (named set-point in KNX terms).
+
+To use your KNX thermostats in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+climate:
+  - platform: knx
+    name: KNX Thermostat
+    temperature_address: 0/1/1
+    setpoint_address: 0/1/0
+```
+
+- **name** (*Optional*): A name for this devices used within Home assistant
+- **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel
+- **temperature_address** (*Required*): The group address that is used to communicate the current temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value) (see http://www.knx.org/fileadmin/template/documents/downloads_support_menu/KNX_tutor_seminar_page/Advanced_documentation/05_Interworking_E1209.pdf)
+- **setpoint_address** (*Required*): The group address that is used to set/read the target temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value). Make sure, you set the read-flag for the thermostat to allow Home Assistant to read the target temperature.
+
+With the current version of the module, no advanced KNX thermostat functionalities (e.g. HVAC mode) are supported.

source/_components/climate.markdown

@@ -0,0 +1,22 @@
+---
+layout: page
+title: "Climate"
+description: "Instructions how to setup climate control devices within Home Assistant."
+date: 2016-08-26 19:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+---
+
+
+The `climate` component is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices.
+ 
+To enable this component, pick one of the platforms, and add it to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+climate:
+  platform: demo
+```
+

source/_components/climate.nest.markdown

@@ -0,0 +1,30 @@
+---
+layout: page
+title: "Nest Thermostat"
+description: "Instructions how to integrate Nest thermostats within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: nest_thermostat.png
+ha_category: Climate
+---
+
+
+The `nest` climate platform let you control a thermostat from [Nest](https://nest.com).
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+cliamte:
+  platform: nest
+```
+
+<p class='img'>
+  <img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
+</p>
+
+<p class='note'>
+  You must have the [Nest component](https://home-assistant.io/components/nest/) configured to use this sensor.
+</p>

source/_components/climate.proliphix.markdown

@@ -0,0 +1,40 @@
+---
+layout: page
+title: "Proliphix Thermostat"
+description: "Instructions how to integrate Proliphix thermostats within Home Assistant."
+date: 2016-01-15 08:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: proliphix.png
+ha_category: Climate
+ha_release: 0.11
+---
+
+
+The `proliphix` climate platform let you control [Proliphix](http://www.proliphix.com) thermostat from Home Assistant.
+
+Currently supported and tested thermostats:
+
+- NT10e
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+climate:
+  platform: proliphix
+  host: IP_ADDRESS
+  username: YOUR_USERNAME
+  password: YOUR_PASSWORD
+```
+
+Configuration variables:
+
+- **host** (*Required*): Adress of your thermostat, eg. 192.168.1.32
+- **username** (*Required*): Username for the thermostat.
+- **password** (*Required*): Password for the thermostat.
+
+The Proliphix NT Thermostat series are ethernet connected thermostats. They have a local HTTP interface that is based on get/set
+of OID values. A complete collection of the API is available in this [API documentation](https://github.com/sdague/thermostat.rb/blob/master/docs/PDP_API_R1_11.pdf).
+

source/_components/climate.radiotherm.markdown

@@ -0,0 +1,40 @@
+---
+layout: page
+title: "Radiotherm Thermostat"
+description: "Instructions how to integrate Radiotherm thermostats within Home Assistant."
+date: 2015-10-18 17:15
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: radiotherm.png
+ha_category: Climate
+---
+
+
+The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/).
+
+The underlaying library supports:
+- CT50 V1.09
+- CT50 V1.88
+- CT50 V1.94 (also known as Filtrete 3M50)
+- CT80 Rev B2 V1.03
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+climate:
+  platform: radiotherm
+  host:
+    - 192.168.99.137
+    - 192.168.99.202
+  hold_temp: True
+```
+
+Configuration variables:
+
+- **host** (*Required*): List of your Radiotherm thermostats
+- **hold_temp** (*Required*): Boolean to control if Home Assistant temperature adjustments hold (`True`) or are temporary (`False`).
+
+Temperature settings from Home Assistant will be sent to thermostat and then hold at that temperature. Set to `False` if you set a thermostat schedule on the thermostat itself and just want Home Assistant to send temporary temperature changes.
+

source/_components/climate.zwave.markdown

@@ -0,0 +1,22 @@
+---
+layout: page
+title: "Z-Wave Thermostat"
+description: "Instructions how to setup the Z-Wave thermostat within Home Assistant."
+date: 2016-04-03 9:52
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: z-wave.png
+ha_category: Climate
+ha_release: 0.17
+---
+
+
+To get your Z-Wave thermostat working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
+
+<p class='note'>
+If your thermostat support fan modes or different operating modes, it should be considered a [HVAC component](/components/hvac.zwave/), and will also be detected as one. Thermostat component does not support setting fan or operation mode. This is controlled via the HVAC component.
+
+If the thermostat support different operationg modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.
+</p>

source/_components/hvac.zwave.markdown

@@ -12,4 +12,6 @@ ha_category: HVAC
 ha_release: 0.19
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
+
 To get your Z-Wave `hvac` devices working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/) and the [HVAC component](/components/hvac/).

source/_components/thermostat.eq3btsmart.markdown

@@ -12,6 +12,8 @@ ha_category: Thermostat
 ha_iot_class: "Local Poll"
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
+
 This platform allows you to integrate EQ3 Bluetooth Smart Thermostats.
 
 The only functionality is to set the temperature, there doesn't seem to be any way to query the temperature sensor or battery level ([read more](https://forum.fhem.de/index.php/topic,39308.15.html)).

source/_components/thermostat.heat_control.markdown

@@ -11,6 +11,8 @@ logo: heat-control.png
 ha_category: Thermostat
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
+
 Heat Control is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater under the hood. If the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when required temperature is reached.
 
 ```yaml

source/_components/thermostat.heatmiser.markdown

@@ -12,6 +12,7 @@ ha_category: Thermostat
 ha_release: "0.10"
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
 
 The `heatmiser` thermostat platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](http://www.heatmisershop.co.uk/heatmiser-slimline-programmable-room-thermostat/) thermostats from Heatmiser.  The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
 

source/_components/thermostat.honeywell.markdown

@@ -11,6 +11,7 @@ logo: honeywell.png
 ha_category: Thermostat
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
 
 The `honeywell` thermostat platform let you control [Honeywell Connected](http://getconnected.honeywell.com/en/) thermostats from Home Assistant.
 

source/_components/thermostat.knx.markdown

@@ -12,6 +12,7 @@ ha_category: DIY
 ha_release: 0.25
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
 
 The `knx` thermostat platform is used as in interface with KNX thermostats.
 

source/_components/thermostat.nest.markdown

@@ -11,6 +11,7 @@ logo: nest_thermostat.png
 ha_category: Thermostat
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
 
 The `nest` thermostat platform let you control a thermostat from [Nest](https://nest.com).
 

source/_components/thermostat.proliphix.markdown

@@ -12,6 +12,7 @@ ha_category: Thermostat
 ha_release: 0.11
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
 
 The `proliphix` thermostat platform let you control [Proliphix](http://www.proliphix.com) thermostat from Home Assistant.
 

source/_components/thermostat.radiotherm.markdown

@@ -11,6 +11,7 @@ logo: radiotherm.png
 ha_category: Thermostat
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
 
 The `radiotherm` thermostat platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/).
 

source/_components/thermostat.zwave.markdown

@@ -12,6 +12,8 @@ ha_category: Thermostat
 ha_release: 0.17
 ---
 
+**This platform has been deprecated in favor of a "climate" platform and will be removed in the future. Please use the climate platform.**
+
 To get your Z-Wave thermostat working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
 
 <p class='note'>