jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 11:47:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9799 from home-assistant/climate-1

Browse Source 
Climate 1.0
This commit is contained in:
Paulus Schoutsen 2019-07-10 14:27:48 -07:00 committed by GitHub
commit 1352b2e322
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 137 additions and 384 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
source/_components/climate.knx.markdown
View File

@ -69,14 +69,19 @@ climate:
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` is specified.
The following values are valid for the `operation_modes` attribute:
The following values are valid for the `hvac_mode` attribute:
- Comfort (maps internally to STATE_HEAT within Home Assistant)
- Standby (maps internally to STATE_ECO within Home Assistant)
- Night (maps internally to STATE_IDLE within Home Assistant)
- Frost Protection (maps internally to STATE_MANUAL within Home Assistant)
- Fan only (maps internally to STATE_FAN_ONLY within Home Assistant)
- Dehumidification (maps internally to STATE_DRY within Home Assistant)
- Off (maps internally to HVAC_MODE_OFF within Home Assistant)
- Heat (maps internally to HVAC_MDOE_HEAT within Home Assistant)
- Fan only (maps internally to HVAC_MODE_FAN_ONLY within Home Assistant)
- Dehumidification (maps internally to HVAC_MODE_DRY within Home Assistant)
The following presets are valid for the `preset_mode` attribute:
- Comfort (maps internally to PRESET_COMFORT within Home Assistant)
- Standby (maps internally to PRESET_AWAY within Home Assistant)
- Night (maps internally to PRESET_SLEEP within Home Assistant)
- Frost Protection (maps internally to PRESET_ECO within Home Assistant)
{% configuration %}
name:

69
source/_components/climate.markdown
View File

@ -19,7 +19,8 @@ The `climate` integration is built for the controlling and monitoring of HVAC (h
## Services
### Climate control services
Available services: `climate.set_aux_heat`, `climate.set_away_mode`, `climate.set_temperature`, `climate.set_humidity`, `climate.set_fan_mode`, `climate.set_operation_mode`, `climate.set_swing_mode`, `climate.set_hold_mode`, `climate.turn_on`, `climate.turn_off`
Available services: `climate.set_aux_heat`, `climate.set_preset_mode`, `climate.set_temperature`, `climate.set_humidity`, `climate.set_fan_mode`, `climate.set_hvac_mode`, `climate.set_swing_mode`, `climate.turn_on`, `climate.turn_off`
<p class='note'>
Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services**.
@ -34,7 +35,7 @@ Turn auxiliary heater on/off for climate device
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `aux_heat` | no | New value of auxiliary heater.
#### Automation example
#### Automation example
```yaml
automation:
@ -48,18 +49,18 @@ automation:
aux_heat: true
```
### Service `climate.set_away_mode`
### Service `climate.set_preset_mode`
Set away mode for climate device. The away mode changes the target temperature permanently to a temperature
Set preset mode for climate device. The away mode changes the target temperature permanently to a temperature
reflecting a situation where the climate device is set to save energy. This may be used to emulate a
"vacation mode", for example.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `away_mode` | no | New value of away mode.
| `preset_mode` | no | New value of preset mode.
#### Automation example
#### Automation example
```yaml
automation:
@ -67,37 +68,10 @@ automation:
platform: time
at: "07:15:00"
action:
- service: climate.set_away_mode
- service: climate.set_preset_mode
data:
entity_id: climate.kitchen
away_mode: 'on'
```
### Service `climate.set_hold_mode`
Set hold mode for climate device. The hold mode changes the target temperature of the client device temporarily to
a different temperature. Typical hold modes provided by a climate device are "away" or "home", where the hold temperature
is chosen depending on a predefined climate, or "temperature" hold, where a particular temperature is selected as the
temporary target temperature. The particular modes available depend on the climate device.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `hold_mode` | no | New value of hold mode.
#### Automation example
```yaml
automation:
trigger:
platform: time
at: "07:15:00"
action:
- service: climate.set_hold_mode
data:
entity_id: climate.kitchen
hold_mode: 'away'
preset_mode: 'eco'
```
### Service `climate.set_temperature`
@ -112,7 +86,7 @@ Set target temperature of climate device
| `target_temp_low` | yes | New target low temperature for hvac
| `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly.
#### Automation example
#### Automation example
```yaml
automation:
@ -136,7 +110,7 @@ Set target humidity of climate device
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `humidity` | no | New target humidity for climate device
#### Automation example
#### Automation example
```yaml
automation:
@ -159,7 +133,7 @@ Set fan operation for climate device
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `fan_mode` | no | New value of fan mode
#### Automation example
#### Automation example
```yaml
automation:
@ -173,16 +147,16 @@ automation:
fan_mode: 'On Low'
```
### Service `climate.set_operation_mode`
### Service `climate.set_hvac_mode`
Set operation mode for climate device
Set HVAC mode for climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `operation_mode` | no | New value of operation mode
| `hvac_mode` | no | New value of HVAC mode
#### Automation example
#### Automation example
```yaml
automation:
@ -190,10 +164,10 @@ automation:
platform: time
at: "07:15:00"
action:
- service: climate.set_operation_mode
- service: climate.set_hvac_mode
data:
entity_id: climate.kitchen
operation_mode: Heat
operation_mode: heat
```
### Service `climate.set_swing_mode`
@ -205,7 +179,7 @@ Set operation mode for climate device
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `swing_mode` | no | New value of swing mode
#### Automation example
#### Automation example
```yaml
automation:
@ -218,9 +192,10 @@ automation:
entity_id: climate.kitchen
swing_mode: 1
```
### Service `climate.turn_on`
Turn climate device on
Turn climate device on. This is only supported if the climate device supports being turned off.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
@ -228,7 +203,7 @@ Turn climate device on
### Service `climate.turn_off`
Turn climate device off
Turn climate device off. This is only supported if the climate device has the hvac mode "off".
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |

3
source/_components/climate.mqtt.markdown
View File

@ -203,6 +203,9 @@ hold_state_template:
description: A template to render the value received on the `hold_state_topic` with.
required: false
type: template
hold_modes:
description: A list of available hold modes.
required: false
aux_command_topic:
description: The MQTT topic to publish commands to switch auxiliary heat.
required: false

9
source/_components/climate.mysensors.markdown
View File

@ -29,10 +29,10 @@ V_HVAC_FLOW_STATE is mapped to the state of the Climate integration in Home Assi
Home Assistant State | MySensors State
---------------------|----------------
STATE_COOL | CoolOn
STATE_HEAT | HeatOn
STATE_AUTO | AutoChangeOver
STATE_OFF | Off
HVAC_MODE_COOL | CoolOn
HVAC_MODE_HEAT | HeatOn
HVAC_MODE_AUTO | AutoChangeOver
HVAC_MODE_OFF | Off
Currently humidity, away_mode, aux_heat, swing_mode is not supported. This will be included in later versions as feasible.
@ -46,7 +46,6 @@ For more information, visit the [serial api] of MySensors.
### Example sketch for MySensors 2.x
```cpp
/*
* Documentation: http://www.mysensors.org

5
source/_components/daikin.markdown
View File

@ -61,12 +61,11 @@ hosts:
The `daikin` climate platform integrates Daikin air conditioning systems into Home Assistant, enabling control of setting the following parameters:
- [**mode**](https://www.home-assistant.io/components/climate#service-climateset_operation_mode) (cool, heat, dry, fan only or auto)
- [**set_hvac_mode**](/components/climate/#service-climateset_hvac_mode) (off, heat, cool, auto, or fan only)
- [**target temperature**](https://www.home-assistant.io/components/climate#service-climateset_temperature)
- [**fan mode**](https://www.home-assistant.io/components/climate#service-climateset_fan_mode) (speed)
- [**swing mode**](https://www.home-assistant.io/components/climate#service-climateset_swing_mode)
- [**turn on/off**](https://www.home-assistant.io/components/climate#service-climateturn_on)
- [**away mode**](https://www.home-assistant.io/components/climate#service-climateset_away_mode)
- [**set_preset_mode**](https://www.home-assistant.io/components/climate#service-climateset_away_mode) (away, home)
Current inside temperature is displayed.

2
source/_components/dyson.markdown
View File

@ -130,7 +130,7 @@ This integration supports the following services (see [Climate](/components/clim
- [`turn_off`](/components/climate/#service-climateturn_off)
- [`set_temperature`](/components/climate/#service-climateset_temperature)
- [`set_fan_mode`](/components/climate/#service-climateset_fan_mode)
- [`set_operation_mode`](/components/climate/#service-climateset_operation_mode)
- [`set_hvac_mode`](/components/climate/#service-climateset_hvac_mode)
## Fan

245
source/_components/ecobee.markdown
View File

@ -118,264 +118,37 @@ The _target temperature_ is the temperature that the device attempts
to achieve. The target temperature is either determined by the
currently active climate or it may be overridden by a hold. When the
thermostat is not in auto mode, there is a single target
temperature. When the thermostat is in auto operation mode, there is a
temperature. When the thermostat is in auto HVAC mode, there is a
pair of target temperatures: the lower target temperature determines
the lowest desired temperature, while the higher target temperature
determines the highest desired temperature (the thermostat will switch
between heating and cooling to keep the temperature within these
limits).
A _climate_ is a predefined or user-defined set of states that the
A _climate_ is a predefined or user-defined set of presets that the
thermostat aims to achieve. The ecobee thermostat provides three predefined
climates: Home, Away, and Sleep. The user can define additional climates.
A _hold_ is an override of the target temperature defined in the
currently active climate. The temperature targeted in the hold mode may be
explicitly set (temperature hold), it may be derived from a reference
A _preset_ is an override of the target temperature defined in the
currently active climate. The temperature targeted in the preset mode may be
explicitly set (temperature preset), it may be derived from a reference
climate (home, away, sleep, etc.), or it may be derived from a vacation
defined by the thermostat. All holds are temporary. Temperature and
climate holds expire when the thermostat transitions to the next climate
defined in its program. A vacation hold starts at the beginning of the
defined vacation period, and expires when the vacation period ends.
When in _away mode_, the target temperature is permanently overridden by
the target temperature defined for the away climate. The away mode is a
When in _away preset_, the target temperature is permanently overridden by
the target temperature defined for the away climate. The away preset is a
simple way to emulate a vacation mode.
The _operation mode_ of the device is the currently active operational
The _HVAC mode_ of the device is the currently active operational
modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool,
auto, and off.
## Attributes
The following attributes are provided by the Ecobee Thermostat:
`name`, `temperature_unit`, `current_temperature`, `target_temperature`,
`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`,
`fan`, `current_hold_mode`, `operation`, `operation_list`, `equipment_running`,
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
`is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`.
The attributes `min_temp` and `max_temp` are meaningless constant values.
### Attribute `name`
Returns the name of the Ecobee Thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the Ecobee Thermostat
### Attribute `temperature_unit`
Returns the unit of measurement used for temperature by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the temperature unit
### Attribute `current_temperature`
Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currently measured temperature
### Attribute `target_temperature`
Returns the target temperature of the thermostat, when the thermostat is
not in auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### Attribute `target_temperature_low`
Returns the desired heating temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### Attribute `target_temperature_high`
Returns the desired cooling temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### Attribute `desired_fan_mode`
Returns the desired fan mode of the current operation.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
### Attribute `fan`
Returns the current fan state.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
### Attribute `current_hold_mode`
Returns the current temperature hold, if any.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'temp', 'vacation', 'home', 'away', etc., None
### Attribute `operation`
Returns the current operation of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'auto', 'cool', 'heat', 'off'
### Attribute `operation_list`
Returns the list of available operation modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
### Attribute `operation_mode`
Returns the current operation mode of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Currently active operation mode
### Attribute `equipment_running`
Returns the list of equipment that is currently operating from the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | If no equipment is currently running empty string is returned. Possible values are a comma separated list of any of the following: heatPump, heatPump2, heatPump3, compCool1, compCool2, auxHeat1, auxHeat2, auxHeat3, fan, humidifier, dehumidifier, ventilator, economizer, compHotWater, auxHotWater.
### Attribute `mode`
Returns the climate currently active on the thermostat. The mode
is returned as the user-visible name (rather than the internally used name).
### Attribute `fan_min_on_time`
Returns the current fan minimum on time.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current fan minimum on time in minutes
### Attribute `is_away_mode_on`
Returns whether the thermostat is in away mode (see the corresponding
service for more detail).
### Attribute `actual humidity`
Returns the humidity as measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current humidity
### Attribute `vacation`
Returns the currently active vacation or `None`.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of currently active vacation |
### Attribute `climate_list`
Returns the list of climates defined in the thermostat.
### Attribute `aux_heat`
Returns the current auxiliary heat state.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
## Services
The following services are provided by the Ecobee Thermostat:
`set_away_mode`, `set_hold_mode`, `set_temperature`, `set_operation_mode`,
`fan_min_on_time`, `resume_program`.
The services `set_aux_heat`, `set_humidity`, `set_fan_mode`, and
`set_swing_mode` offered by the [Climate component](/components/climate/)
are not implemented for this thermostat.
### Service `set_away_mode`
Turns Away Mode on or off, ignoring the next scheduled activity. This setting will override the thermostat Hold Duration setting, even if you set the hold duration to "Until the next scheduled activity" within thermostat preferences.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `away_mode` | no | 'on' or 'off'
### Service `set_hold_mode`
Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep',
and any other hold based on a comfort setting, the
target temperature is set to whatever is programmed in the comfort setting.
For 'temp', the current temperature is taken as the target temperature.
When None is provided as parameter, the hold_mode is turned off.
If the thermostat Hold Duration is set to "Until the next scheduled activity" within thermostat preferences, then the next scheduled activity will change this hold mode.
Note that it is not possible to set a vacation hold; this must be defined on the thermostat directly. However, a vacation hold can be
canceled.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `hold_mode` | no | `temp`, `home`, `away`, `sleep`, `None`, `smart1`, `smart2`, etc.
NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are `smart1`, `smart2`, `smart3`, etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app *may not match* the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct `smartX` hold_mode IDs.
### Service `set_temperature`
Puts the thermostat into a temporary hold at the given temperature.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `target_temp_low` | no | Desired heating target temperature (when in auto mode)
| `target_temp_high` | no | Desired cooling target temperature (when in auto mode)
| `temperature` | no | Desired target temperature (when not in auto mode)
Only the target temperatures relevant for the current operation mode need to
be provided.
### Service `set_operation_mode`
Sets the current operation mode of the thermostat.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `operation_mode` | no | 'auto', 'auxHeatOnly', 'cool', 'heat', 'off'
### Service `fan_min_on_time`
Sets the fan minimum on time.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `fan_min_on_time` | no | Desired fan minimum on time
The following extra services are provided by the Ecobee Thermostat: `resume_program`.
### Service `resume_program`

8
source/_components/generic_thermostat.markdown
View File

@ -77,8 +77,8 @@ keep_alive:
description: Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate integration state (either on or off).
required: false
type: [time, integer]
initial_operation_mode:
description: Set the initial operation mode. Valid values are `off` or `auto`. Value has to be double quoted. If this parameter is not set, it is preferable to set a *keep_alive* value. This is helpful to align any discrepancies between *generic_thermostat* and *heater* state.
initial_hvac_mode:
description: Set the initial HVAC mode. Valid values are `heat`, `cool` or `auto`. Value has to be double quoted. If this parameter is not set, it is preferable to set a *keep_alive* value. This is helpful to align any discrepancies between *generic_thermostat* and *heater* state.
required: false
type: string
away_temp:
@ -94,7 +94,7 @@ precision:
A full configuration example looks like the one below. `min_cycle_duration` and `keep_alive` must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.
Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' operation modes. You can force your `generic_thermostat` to avoid starting by setting Operation to 'off'.
Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' hvac modes. You can force your `generic_thermostat` to avoid starting by setting HVAC mode to 'off'.
Please note that changing Away Mode you will force a target temperature change as well that will get restored once the Away Mode is turned off.
@ -115,7 +115,7 @@ climate:
seconds: 5
keep_alive:
minutes: 3
initial_operation_mode: "off"
initial_hvac_mode: "off"
away_temp: 16
precision: 0.1
```

25
source/_components/geniushub.markdown
View File

@ -17,9 +17,11 @@ ha_release: 0.92
ha_iot_class: Local Polling
---
The `geniushub` integration links Home Assistant with your Genius Hub for controlling its Zones and Devices, and visibility of any Issues. Currently, there is no support for Zone schedules.
The `geniushub` integration links Home Assistant with your Genius Hub CH/DHW system, including its Zones, Devices, and Issues.
It uses the [geniushub-client](https://pypi.org/project/geniushub-client/) library.
Currently, there is no support for Zone schedules.
It uses the [geniushub](https://pypi.org/project/geniushub-client/) client library.
### Zones
@ -30,9 +32,16 @@ Each Zone controlled by your Genius hub will be exposed as either a:
Other Zone types, such as **On / Off** Zones, are not currently supported.
Each such entity will report back its mode, state, setpoint and current temperature; other properties are available via its attributes (see below).
Each such entity will report back its mode, state, setpoint and current temperature; other properties are available via its attributes (see below). The Zone's mode can changed as below.
In addition, the entity's mode and setpoint can be changed. The entity's `operating_mode` can be set to one of `off`, `timer`, `on` (i.e. **Override** mode) or `eco`. The `eco` mode is a proxy for the **Footprint** mode and so is only available to **Radiator** Zones that have room sensors.
GH mode | HA Operation | HA Preset
:---: | :---: | :---:
**Off** | Off | N/A
**Timer** | Heat | None
**Override** | Heat | Boost
**Footprint** | Heat | Activity
Note that **Footprint** mode is only available to **Radiator** Zones that have room sensors.
### Devices
@ -102,7 +111,7 @@ value_template: "{{ state_attr('climate.main_room', 'status').occupied }}"
## Configuration
To add your Genius Hub into your Home Assistant installation, add one of the following to your `configuration.yaml` file.
To set up this integration, add one of the following to your **configuration.yaml** file.
### Option 1: hub token only
@ -122,6 +131,8 @@ geniushub:
- uses the v3 API - unofficial, but there are additional features (e.g., battery levels)
- polls the hub directly (so is faster, say ~1s response time)
The hub does not have to be in the same network as HA.
```yaml
# Example configuration.yaml entry, directly polling the Hub
geniushub:
@ -130,8 +141,6 @@ geniushub:
password: GENIUS_HUB_PASSWORD
```
Note that if a `host` is used instead of `token`, then the `username` and `password` are also required.
{% configuration %}
token:
description: The Hub Token of the Genius Hub.
@ -150,3 +159,5 @@ password:
required: false
type: string
{% endconfiguration %}
Note that if a `host` is used instead of `token`, then the `username` and `password` are also required.

2
source/_components/google_assistant.markdown
View File

@ -191,7 +191,7 @@ Currently, the following domains are available to be used with Google Assistant,
- lock (lock/unlock (to allow assistant to unlock, set the `allow_unlock` key in configuration))
- cover (on/off/set position)
- media_player (on/off/set volume (via set brightness)/source (via set input source))
- climate (temperature setting, operation_mode)
- climate (temperature setting, hvac_mode)
- vacuum (dock/start/stop/pause)
- sensor (temperature setting, only for temperature sensor)

5
source/_components/hive.markdown
View File

@ -73,15 +73,14 @@ The platform supports the following Hive products:
## Climate
The `hive` climate platform integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.
The `hive` climate platform integrates your Hive thermostat into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.
A short boost for Hive Heating or Hive Hot water can be set by using the **Aux Heat** function, this will turn on the boost feature for Hive Heating or Hive Hot water for 30 minutes at 0.5 degrees higher than the current temperature.
A short boost for Hive Heating can be set by using the **Boost** preset, this will turn on the boost feature for 30 minutes at 0.5 degrees higher than the current temperature.
The platform supports the following Hive products:
- Hive Active Heating
- Hive Multizone
- Hot water control
## Light

30
source/_components/incomfort.markdown
View File

@ -17,17 +17,25 @@ ha_release: 0.93
ha_iot_class: Local Polling
---
The `incomfort` integration links Home Assistant with your Intergas Lan2RF gateway for integrating the boiler and any room thermostats attached to it.
The `incomfort` integration links Home Assistant with your Intergas Lan2RF gateway, including the boiler and any room thermostats attached to it.
The boiler is represented as a **Water Heater** device. It will report the boiler's `state` and `temperature` (current temperature). The gateway does not expose any means to directly control the boiler or change its configuration.
It uses the [incomfort](https://pypi.org/project/incomfort-client/) client library.
Note that the `temperature` will switch between the CV and Tap temperatures according to the current operating mode of the boiler. If the boiler is neither pumping nor tapping, it will be reported as the higher of the two.
### Boiler
Any room thermostats (there can be 0, 1 or 2) are represented as **Climate** devices. They will report the thermostat's `target_temperature` (setpoint) and `current_temperature` and the setpoint can be changed.
The boiler is represented as a **Water Heater** device. It will report the boiler's `state` and `current_temperature`. The gateway does not expose any means to directly control the boiler or change its configuration.
Note that the `current_temperature` will switch between the CV (circulating volume) and Tap temperatures according to the current operating mode of the boiler. If the boiler is neither pumping nor tapping, it will be reported as the higher of the two.
In addition, there is a **Sensor** for CV pressure, CV temperature, and Tap temperature, and a **Binary Sensor** that will be `on` if there is a fault with the boiler (the fault code will be a state attribute).
To send an alert if the CV pressure is too low or too high, consider the following automation:
### Rooms
Any room thermostats (there can be 0, 1 or 2) are represented as **Climate** devices. They will report the thermostat's `temperature` (setpoint) and `current_temperature` and the setpoint can be changed.
## Automation
To send an alert if the CV pressure is too low or too high, consider the following example:
{% raw %}
```yaml
@ -48,9 +56,13 @@ To send an alert if the CV pressure is too low or too high, consider the followi
Other properties are available via each device's attributes.
### Configuration
## Configuration
To add your Lan2RF gateway into your Home Assistant installation, add one of the following to your `configuration.yaml` file.
To set up this integration, add the following to your **configuration.yaml** file:
The hub does not have to be in the same network as HA.
### Older gateways
Older gateways do not require user authentication:
@ -60,6 +72,8 @@ incomfort:
host: IP_ADDRESS
```
### Newer gateways
Alternatively, if a **username** & **password** is printed on the back of the gateway:
```yaml
@ -70,8 +84,6 @@ incomfort:
password: PASSWORD
```
The hub does not have to be in the same network as HA.
{% configuration %}
host:
description: The hostname/IP address of the Lan2RF gateway.

1
source/_components/knx.markdown
View File

@ -14,7 +14,6 @@ ha_release: 0.24
ha_iot_class: Local Polling
---
The [KNX](https://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices.
The integration requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.

4
source/_components/nest.markdown
View File

@ -309,10 +309,10 @@ The following conditions are available by device:
- security\_state: `ok` or `deter`. [Security State](#security-state). Only available when Nest Camera exists.
- Nest Thermostat:
- humidity
- operation\_mode
- preset\_mode
- temperature
- target
- hvac\_state: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`).
- hvac\_mode: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`).
- Nest Protect:
- co\_status: `Ok`, `Warning` or `Emergency`
- smoke\_status: `Ok`, `Warning` or `Emergency`

25
source/_components/nuheat.markdown
View File

@ -63,12 +63,10 @@ The NuHeat Thermostat supports the following key concepts.
The `target temperature` is the temperature that the device attempts to achieve. The target temperature is either determined by the schedule programmed into the thermostat (`auto mode`) or may be overridden. When the target temperature is set by Home Assistant, the thermostat will hold this temperature until the schedule is resumed.
## Attributes
The following attributes are provided by the NuHeat thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, `current_hold_mode`, `current_operation`, `operation_list`, `min_temp` and `max_temp`.
### Attribute `name`
Returns the name of the NuHeat Thermostat.
@ -102,7 +100,7 @@ not in auto operation mode.
| ---------------| ----------- |
| Integer | Target temperature
### Attribute `current_hold_mode`
### Attribute `preset_mode`
Returns the current temperature hold, if any.
@ -110,21 +108,21 @@ Returns the current temperature hold, if any.
| ---------------| ----------- |
| String | 'temperature', 'temporary_temperature', 'auto', etc.
### Attribute `current_operation`
### Attribute `hvac_action`
Returns the current operation of the thermostat.
Returns the current HVAC mode of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'heat', 'idle'
### Attribute `operation_list`
### Attribute `preset_modes`
Returns the list of available operation modes.
Returns the list of available preset modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
| List of String | Available preset modes
### Attribute `min_temp`
@ -142,12 +140,11 @@ Returns the maximum supported temperature by the thermostat
| ---------------| ----------- |
| Integer | Maximum supported temperature
## Services
The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hold_mode`, `nuheat_resume_program`.
The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hvac_mode`, `set_preset_mode`, `resume_program`.
The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `set_humidity`, `set_fan_mode`, `set_operation_mode` and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat.
The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `set_humidity`, `set_fan_mode`, and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat.
### Service `set_temperature`
@ -161,16 +158,16 @@ Puts the thermostat into an indefinite hold at the given temperature.
Only the target temperatures relevant for the current operation mode need to
be provided.
### Service `set_hold_mode`
### Service `set_preset_mode`
Sets the thermostat's hold mode. The NuHeat thermostat supports "auto" (to run the thermostat's programmed schedule), "temperature" (to indefinitely hold the thermostat's current target temperature), or "temporary_temperature" (to hold the thermostat's current target temperature until the thermostat's next scheduled event).
Sets the thermostat's preset mode. Without a preset mode set it run the thermostat's programmed schedule, "temperature" (to indefinitely hold the thermostat's current target temperature), or "temporary_temperature" (to hold the thermostat's current target temperature until the thermostat's next scheduled event).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `hold_mode` | no | New value of hold mode.
### Service `nuheat_resume_program`
### Service `resume_program`
Resumes the currently active schedule.

7
source/_components/oem.markdown
View File

@ -18,7 +18,7 @@ redirect_from:
This platform supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/). The underlying [library](http://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/).
This platform controls the setpoint of the thermostat in its "manual" mode, therefore there is a configuration option the away setpoint.
This platform controls the setpoint of the thermostat in its "manual" mode.
To set it up, add the following information to your `configuration.yaml` file:
@ -52,9 +52,4 @@ password:
description: Password for the web interface if set.
required: inclusive
type: string
away_temp:
description: Setpoint for the thermostat in away mode.
required: false
default: 14.0
type: float
{% endconfiguration %}

13
source/_components/radiotherm.markdown
View File

@ -16,7 +16,6 @@ redirect_from:
- /components/climate.radiotherm/
---
The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/) or [3M Filtrete](http://www.radiothermostat.com/filtrete/products/). Your thermostat must have the Wi-Fi module installed and connected to your network.
The underlying library supports:
@ -49,16 +48,6 @@ host:
description: List of your Radiotherm thermostats. If not provided the thermostats will be auto-detected.
required: false
type: list
away_temperature_heat:
description: Target heating temperature in Fahrenheit for away mode. This is separate from away mode in the app.
required: false
default: 60
type: float
away_temperature_cool:
description: Target cooling temperature in Fahrenheit for away mode. This is separate from away mode in the app.
required: false
default: 85
type: float
hold_temp:
description: Boolean to control if Home Assistant temperature adjustments hold (`true`) or are temporary (`false`).
required: false
@ -68,8 +57,6 @@ hold_temp:
Set `hold_temp: true` if you want temperature settings from Home Assistant to override a thermostat schedule on the thermostat itself. Otherwise Home Assistant will perform temporary temperature changes.
The away mode functions similarly to the away mode feature of the website and apps, but cannot detect if you set away mode outside of Home Assistant.
Multiple thermostats can be assigned by using `host:` if auto-detection is not used.
```yaml

6
source/_components/sensibo.markdown
View File

@ -67,12 +67,14 @@ switch:
friendly_name: "AC"
value_template: "{{ is_state('climate.ac', 'cool') or is_state('climate.ac', 'heat') or is_state('climate.ac', 'dry') or is_state('climate.ac', 'heat')}}"
turn_on:
service: climate.turn_on
service: climate.set_havc_mode
data:
entity_id: climate.ac
hvac_mode: off
turn_off:
service: climate.turn_off
service: climate.set_havc_mode
data:
entity_id: climate.ac
hvac_mode:
```
{% endraw %}

9
source/_components/smartthings.markdown
View File

@ -177,9 +177,8 @@ For a SmartThings Air Conditioner to be represented by the climate platform, it
| Capability |Climate Features
|-------------------------------------|--------------------------------------------|
| [`airConditionerMode`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Air-Conditioner-Mode) (required) | `operation mode`
| [`airConditionerMode`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Air-Conditioner-Mode) (required) | `hvac mode`, `hvac action`
| `airConditionerFanMode` (required) | `fan mode`
| [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) (required) | `on/off`
| [`temperatureMeasurement`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Temperature-Measurement) (required) | `temperature`
| [`thermostatCoolingSetpoint`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Cooling-Setpoint) (required) | `target temp`
| [`demandResponseLoadControl`](https://docs.smartthings.com/en/latest/capabilities-reference.html#demand-response-load-control) | `drlc_status_duration` (state attribute), `drlc_status_level` (state attribute), `drlc_status_override` (state attribute), `drlc_status_start` (state attribute)
@ -191,12 +190,12 @@ For a SmartThings thermostat to be represented by the climate platform, it must
| Capability |Climate Features
|-------------------------------------|--------------------------------------------|
| [`thermostat`](https://docs.smartthings.com/en/latest/capabilities-reference.html#thermostat) (set a) | `operation mode`, `operating state` (state attribute), `target temp high`, `target temp low` and `fan mode`
| [`thermostatMode`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Mode) (set b) | `operation mode`
| [`thermostat`](https://docs.smartthings.com/en/latest/capabilities-reference.html#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode`
| [`thermostatMode`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Mode) (set b) | `hvac mode`
| [`thermostatCoolingSetpoint`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Cooling-Setpoint) (seb b) | `target temp low`
| [`thermostatHeatingSetpoint`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Heating-Setpoint) (set b) | `target temp high`
| [`temperatureMeasurement`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Temperature-Measurement) (set b) |
| [`thermostatOperatingState`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Operating-State) | `operating state` (state attribute)
| [`thermostatOperatingState`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Operating-State) | `hvac action`
| [`thermostatFanMode`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Thermostat-Fan-Mode) | `fan mode`
| [`relativeHumidityMeasurement`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Relative-Humidity-Measurement) | `humidity` (state attribute)

20
source/_components/stiebel_eltron.markdown
View File

@ -29,18 +29,22 @@ By now, the following units are tested:
- LWZ504e
- LWZ304
## Operation modes
## HVAC modes
Only the standard HA operation modes are supported. The STIEBEL ELTRON modes are mapped and configurable as follows:
The following HVAC modes are supported. The STIEBEL ELTRON modes are mapped and configurable as follows:
- Auto (STATE_AUTO): Automatic mode
- Eco (STATE_ECO): Standby mode
- Manual (STATE_MANUAL): Manual mode
- Off (STATE_OFF): DHW mode (domestic hot water mode, heating is switched off)
- Auto (HVAC_MODE_AUTO): Automatic mode
- Manual (HVAC_MODE_HEAT): Manual mode
- Off (HVAC_MODE_OFF): DHW mode (domestic hot water mode, heating is switched off)
The HA operation mode 'On' is displayed, if the following STIEBEL ELTRON modes are configured directly on the unit:
## Preset modes
- On (STATE_ON): Day mode, Setback mode or Emergency operation
The following preset modes are supported. The STIEBEL ELTRON modes are mapped and configurable as follows:
- Eco mode (PRESET_ECO)
- Day mode (PRESET_DAY)
- Setback mode (PRESET_SETBACK)
- Emergency mode (PRESET_EMERGENCY)
## Configuration

10
source/_components/toon.markdown
View File

@ -69,15 +69,9 @@ client_secret:
## Climate
The `toon` climate platform allows you to interact with your Toon thermostat. For compatibility reasons, the states in Home Assistant are different from the states displayed on your Toon device and are mapped as follows:
| Home Assistant | Toon |
|:---------------|:--------|
| Auto | Comfort |
| Heat | Thuis |
| Eco | Weg |
| Cool | Slapen |
The `toon` climate platform allows you to interact with your Toon thermostat.
Home Assistant support the four Toon presets: `Comfort`, `Home`, `Away` and `Sleep`.
It also supports setting the temperature manually.
The Toon API is polled at a 300-second interval, so the status is relatively fresh without overloading the API.

4
source/_components/venstar.markdown
View File

@ -29,8 +29,8 @@ Currently supported functionality:
- Changing the operation mode of the thermostat (heat/cool/off/auto)
- Turning the fan on/off
- Reading and setting the humidity level and limits
- Turning away mode on/off
- Turning hold mode on/off
- Turning on away preset
- Turning on hold mode preset
The following values are supported for the hold_mode state attribute:
- `off`: *Enables* the scheduling functionality.