Skip to content

Commit a16f5e8

Browse files
fabafffabaff
committed
Add climate docs
1 parent 8c7be85 commit a16f5e8

12 files changed

+405
-0
lines changed

‎source/_components/climate.ecobee.markdown

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
layout: page
3+
title: "Ecobee Thermostat"
4+
description: "Instructions how to setup the Ecobee thermostats within Home Assistant."
5+
date: 2016-08-26 18:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ecobee.png
11+
ha_category: Climate
12+
ha_release: 0.9
13+
---
14+
15+
To get your Ecobee thermostats working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).

‎source/_components/climate.eq3btsmart.markdown

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: page
3+
title: "EQ3 Bluetooth Smart Thermostats"
4+
description: "Instructions how to integrate EQ3 Bluetooth Smart Thermostats into Home Assistant."
5+
date: 2016-04-18 22:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: eq3.gif
11+
ha_category: Climate
12+
ha_iot_class: "Local Poll"
13+
---
14+
15+
16+
The `eq3btsmart` climate platform allows you to integrate EQ3 Bluetooth Smart Thermostats.
17+
18+
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)).
19+
20+
Setup is a bit more cumbersome than for most other thermostats. It has to be paired first:
21+
22+
```bash
23+
bluetoothctl
24+
scan on
25+
<Wait for the thermostat to be found, which looks like this: [NEW] Device 00:11:22:33:44:55 CC-RT-BLE>
26+
scan off
27+
<Set the thermostat to pairing mode.>
28+
pair <MAC>
29+
trust <MAC>
30+
disconnect <MAC>
31+
exit
32+
```
33+
34+
Then check with gatttool if the connection works as expected:
35+
36+
```bash
37+
gatttool -b 00:11:22:33:44:55 -I
38+
[00:11:22:33:44:55][LE]> connect
39+
Attempting to connect to 00:11:22:33:44:55
40+
Connection successful
41+
[00:11:22:33:44:55][LE]> char-write-req 0x0411 03
42+
Characteristic value was written successfully
43+
Notification handle = 0x0421 value: 02 01 09 14 04 2d
44+
[00:11:22:33:44:55][LE]> disconnect
45+
[00:11:22:33:44:55][LE]> exit
46+
```
47+
48+
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:
49+
50+
```bash
51+
/usr/bin/bt-device -d CC-RT-BLE
52+
```
53+
54+
to the start function of /etc/init.d/hass-daemon.
55+
56+
57+
```yaml
58+
# Example configuration.yaml entry
59+
climate:
60+
platform: eq3btsmart
61+
devices:
62+
room1:
63+
mac: '00:11:22:33:44:55'
64+
```

‎source/_components/climate.generic_thermostat.markdown

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: page
3+
title: "Generic Thermostat"
4+
description: "Turn Home Assistant into a thermostat"
5+
date: 2015-03-23 19:59
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: heat-control.png
11+
ha_category: Climate
12+
---
13+
14+
15+
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.
16+
17+
```yaml
18+
# Example configuration.yaml entry
19+
climate:
20+
platform: heat_control
21+
name: Study
22+
heater: switch.study_heater
23+
target_sensor: sensor.study_temperature
24+
min_temp: 15
25+
max_temp: 21
26+
target_temp: 15
27+
min_cycle_duration:
28+
# At least one of these must be specified:
29+
days: 2
30+
hours: 1
31+
minutes: 10
32+
seconds: 5
33+
milliseconds: 20
34+
```
35+
36+
Configuration variables:
37+
38+
- **name** (*Required*): Name of thermostat
39+
- **heater** (*Required*: `entity_id` for heater switch, must be a toggle device.
40+
- **target_sensor** (*Required*): `entity_id` for a temperature sensor, target_sensor.state must be temperature.
41+
- **min_temp** (*Optional*): Set minimum set point available (default: 7)
42+
- **max_temp** (*Optional*): Set maximum set point available (default: 35)
43+
- **target_temp** (*Required*): Set intital target temperature. Failure to set this variable will result in target temperature being set to null on startup.
44+
- **ac_mode** (*Optional*): Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device.
45+
- **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

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: page
3+
title: "Heatmiser Thermostat"
4+
description: "Instructions how to integrate Heatmiser thermostats within Home Assistant."
5+
date: 2015-12-11 12:35
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: heatmiser.png
11+
ha_category: Climate
12+
ha_release: "0.10"
13+
---
14+
15+
16+
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.
17+
18+
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.
19+
20+
To set it up, add the following information to your `configuration.yaml` file:
21+
22+
```yaml
23+
climate:
24+
platform: heatmiser
25+
ipaddress: YOUR_IPADDRESS
26+
port: YOUR_PORT
27+
tstats:
28+
1:
29+
id: THERMOSTAT_ID
30+
name: THERMOSTAT_NAME
31+
```
32+
33+
A single interface can handle up to 32 connected devices.
34+
35+
Configuration variables:
36+
37+
- **ipaddress** (*Required*): The ip address of your interface.
38+
- **port** (*Required*): The port that the interface is listening on.
39+
- **tstats** (*Required*): A list of thermostats activated on the gateway.
40+
- **id** (*Required*): The id of the thermostat as configured on the device itself
41+
- **name** (*Required*): A friendly name for the themostat

‎source/_components/climate.homematic.markdown

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: page
3+
title: "Homematic Thermostats"
4+
description: "Instructions how to integrate Homematic thermostats within Home Assistant."
5+
date: 2016-06-28 08:30
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: homematic.png
11+
ha_category: Climate
12+
ha_release: 0.23
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
17+
The `homematic` cliamte platform lets you control [Homematic](http://www.homematic.com/) thermostats through Home Assistant.
18+
19+
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

‎source/_components/climate.honeywell.markdown

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: page
3+
title: "Honeywell Thermostat"
4+
description: "Instructions how to integrate Honeywell thermostats within Home Assistant."
5+
date: 2016-02-07 22:01
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: honeywell.png
11+
ha_category: Climate
12+
---
13+
14+
15+
The `honeywell` cliamte platform let you control [Honeywell Connected](http://getconnected.honeywell.com/en/) thermostats from Home Assistant.
16+
17+
To set it up, add the following information to your `configuration.yaml` file:
18+
19+
```yaml
20+
cliamte:
21+
platform: honeywell
22+
username: YOUR_USERNAME
23+
password: YOUR_PASSWORD
24+
region: REGION
25+
```
26+
27+
Configuration variables:
28+
29+
- **username** (*Required*: The username of an user with access.
30+
- **password** (*Required*): The password for your given admin account.
31+
- **away_temperature** (*optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
32+
- **region** (*optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided.

‎source/_components/climate.knx.markdown

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: page
3+
title: "KNX Thermostat"
4+
description: "Instructions on how to integrate KXN thermostats with Home Assistant."
5+
date: 2016-06-24 12:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: knx.png
11+
ha_category: DIY
12+
ha_release: 0.25
13+
---
14+
15+
16+
The `knx` climate platform is used as in interface with KNX thermostats.
17+
18+
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).
19+
20+
To use your KNX thermostats in your installation, add the following to your `configuration.yaml` file:
21+
22+
```yaml
23+
climate:
24+
- platform: knx
25+
name: KNX Thermostat
26+
temperature_address: 0/1/1
27+
setpoint_address: 0/1/0
28+
```
29+
30+
- **name** (*Optional*): A name for this devices used within Home assistant
31+
- **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel
32+
- **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)
33+
- **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.
34+
35+
With the current version of the module, no advanced KNX thermostat functionalities (e.g. HVAC mode) are supported.

‎source/_components/climate.markdown

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: page
3+
title: "Climate"
4+
description: "Instructions how to setup climate control devices within Home Assistant."
5+
date: 2016-08-26 19:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
---
11+
12+
13+
The `climate` component is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices.
14+
15+
To enable this component, pick one of the platforms, and add it to your `configuration.yaml`:
16+
17+
```yaml
18+
# Example configuration.yaml entry
19+
climate:
20+
platform: demo
21+
```
22+

‎source/_components/climate.nest.markdown

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
layout: page
3+
title: "Nest Thermostat"
4+
description: "Instructions how to integrate Nest thermostats within Home Assistant."
5+
date: 2015-03-23 19:59
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: nest_thermostat.png
11+
ha_category: Climate
12+
---
13+
14+
15+
The `nest` climate platform let you control a thermostat from [Nest](https://nest.com).
16+
17+
To set it up, add the following information to your `configuration.yaml` file:
18+
19+
```yaml
20+
cliamte:
21+
platform: nest
22+
```
23+
24+
<p class='img'>
25+
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
26+
</p>
27+
28+
<p class='note'>
29+
You must have the [Nest component](https://home-assistant.io/components/nest/) configured to use this sensor.
30+
</p>

‎source/_components/climate.proliphix.markdown

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: page
3+
title: "Proliphix Thermostat"
4+
description: "Instructions how to integrate Proliphix thermostats within Home Assistant."
5+
date: 2016-01-15 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: proliphix.png
11+
ha_category: Climate
12+
ha_release: 0.11
13+
---
14+
15+
16+
The `proliphix` climate platform let you control [Proliphix](http://www.proliphix.com) thermostat from Home Assistant.
17+
18+
Currently supported and tested thermostats:
19+
20+
- NT10e
21+
22+
To set it up, add the following information to your `configuration.yaml` file:
23+
24+
```yaml
25+
climate:
26+
platform: proliphix
27+
host: IP_ADDRESS
28+
username: YOUR_USERNAME
29+
password: YOUR_PASSWORD
30+
```
31+
32+
Configuration variables:
33+
34+
- **host** (*Required*): Adress of your thermostat, eg. 192.168.1.32
35+
- **username** (*Required*): Username for the thermostat.
36+
- **password** (*Required*): Password for the thermostat.
37+
38+
The Proliphix NT Thermostat series are ethernet connected thermostats. They have a local HTTP interface that is based on get/set
39+
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).
40+

‎source/_components/climate.radiotherm.markdown

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: page
3+
title: "Radiotherm Thermostat"
4+
description: "Instructions how to integrate Radiotherm thermostats within Home Assistant."
5+
date: 2015-10-18 17:15
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: radiotherm.png
11+
ha_category: Climate
12+
---
13+
14+
15+
The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/).
16+
17+
The underlaying library supports:
18+
- CT50 V1.09
19+
- CT50 V1.88
20+
- CT50 V1.94 (also known as Filtrete 3M50)
21+
- CT80 Rev B2 V1.03
22+
23+
To set it up, add the following information to your `configuration.yaml` file:
24+
25+
```yaml
26+
climate:
27+
platform: radiotherm
28+
host:
29+
- 192.168.99.137
30+
- 192.168.99.202
31+
hold_temp: True
32+
```
33+
34+
Configuration variables:
35+
36+
- **host** (*Required*): List of your Radiotherm thermostats
37+
- **hold_temp** (*Required*): Boolean to control if Home Assistant temperature adjustments hold (`True`) or are temporary (`False`).
38+
39+
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.
40+

0 commit comments

Comments
 (0)