Skip to content

Minimizing of the configuration sample (Climate) #1011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/_components/climate.ecobee.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ footer: true
logo: ecobee.png
ha_category: Climate
ha_release: 0.9
ha_iot_class: "Cloud Push"
---

To get your Ecobee thermostats working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).
15 changes: 11 additions & 4 deletions source/_components/climate.eq3btsmart.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,15 @@ 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'
- platform: eq3btsmart
devices:
room1:
mac: '00:11:22:33:44:55'
```

Configuration variables:

- **devices** array (*Required*): List of thermostats.
- **[device-name]** (*Required*): The name to use for the thermostat.
- **mac** (*Required*): MAC address of the thermostat.

37 changes: 22 additions & 15 deletions source/_components/climate.generic_thermostat.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ sharing: true
footer: true
logo: heat-control.png
ha_category: Climate
ha_release: pre 0.7
---


Expand All @@ -17,29 +18,35 @@ The `generic_thermostat` climate platform is a thermostat implemented in Home As
```yaml
# Example configuration.yaml entry
climate:
platform: generic_thermostat
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
- platform: generic_thermostat
name: Study
heater: switch.study_heater
target_sensor: sensor.study_temperature
```

Configuration variables:

- **name** (*Required*): Name of thermostat
- **heater** (*Required*: `entity_id` for heater switch, must be a toggle device.
- **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** (*Optional*): 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.

A full configuration example looks like the one below. `min_cycle_duration` must contains at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.

```yaml
# Full example configuration.yaml entry
climate:
- platform: generic_thermostat
name: Study
heater: switch.study_heater
target_sensor: sensor.study_temperature
min_temp: 15
max_temp: 21
target_temp: 17
min_cycle_duration:
seconds: 5
```
2 changes: 0 additions & 2 deletions source/_components/climate.honeywell.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ To set it up, add the following information to your `configuration.yaml` file:
climate:
platform: honeywell
username: YOUR_USERNAME
password: YOUR_PASSWORD
region: REGION
```

Configuration variables:
Expand Down
3 changes: 1 addition & 2 deletions source/_components/climate.knx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,14 @@ To use your KNX thermostats in your installation, add the following to your `con
# Example configuration.yaml entry
climate:
- platform: knx
name: KNX Thermostat
address : KNX_ADDRESS
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), check [details](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.
- **name** (*Optional*): A name for this devices used within Home Assistant

With the current version of the module, no advanced KNX thermostat functionalities (e.g. HVAC mode) are supported.
14 changes: 10 additions & 4 deletions source/_components/climate.radiotherm.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,9 @@ The underlaying library supports:
To set it up, add the following information to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
climate:
platform: radiotherm
host:
- 192.168.99.137
- 192.168.99.202
hold_temp: True
```

Configuration variables:
Expand All @@ -39,3 +36,12 @@ Configuration variables:

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.

Multiple thermostats could be assigned by using `host:` if auto-detetion is not used.

```yaml
climate:
platform: radiotherm
host:
- 192.168.99.137
- 192.168.99.202
```