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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix tables

Browse Source
This commit is contained in:
Fabian Affolter 2017-02-05 22:13:20 +01:00
parent 79e2d61109
commit 2b0c208e1f
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
1 changed files with 41 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
source/_components/climate.ecobee.markdown
View File

@ -21,45 +21,23 @@ To get your Ecobee thermostats working with Home Assistant, follow the instructi
The Ecobee 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
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
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).
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 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
thermostat aims to achieve. The ecobee thermostat provides three predefined
climates: home, away, and sleep. The user can define additional climates.
A _climate_ is a predefined or user-defined set of states 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) or it may be derived from a reference
climate (home or away hold). All holds are temporary. Temperature and
climate holds expire when the thermostat transitions to the next climate
defined in its program.
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) or it may be derived from a reference climate (home or away hold). All holds are temporary. Temperature and climate holds expire when the thermostat transitions to the next climate defined in its program.
When in _away mode_, the target temperature is permanently overridden by
the target temperature defined for the away climate. The away mode is a
simple way to emulate a vacation mode.
When in _away mode_, the target temperature is permanently overridden by the target temperature defined for the away climate. The away mode is a simple way to emulate a vacation mode.
The _operation mode_ of the device is the currently active operational
modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool,
auto, and off.
The _operation mode_ of the device is the currently active operational modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool, auto, and off.
## {% linkable_title 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`, `current_operation`, `operation_list`,
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
`is_away_mode_on`.
`name`, `temperature_unit`, `current_temperature`, `target_temperature`, `target_temperature_low`, `target_temperature_high`, `desired_fan_mode`, `fan`, `current_hold_mode`, `current_operation`, `operation_list`,`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`, `is_away_mode_on`.
The attributes `min_temp` and `max_temp` are meaningless constant values.
@ -69,7 +47,7 @@ Returns the name of the Ecobee Thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the Ecobee Thermostat
| String | Name of the Ecobee Thermostat |
### {% linkable_title Attribute `temperature_unit` %}
@ -77,7 +55,7 @@ Returns the unit of measurement used for temperature by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the temperature unit
| String | Name of the temperature unit |
### {% linkable_title Attribute `current_temperature` %}
@ -85,7 +63,7 @@ Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currenly measured temperature
| Integer | Currenly measured temperature |
### {% linkable_title Attribute `target_temperature` %}
@ -94,7 +72,7 @@ not in auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
| Integer | Target temperature |
### {% linkable_title Attribute `target_temperature_low` %}
@ -103,7 +81,7 @@ auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
| Integer | Target temperature |
### {% linkable_title Attribute `target_temperature_high` %}
@ -112,7 +90,7 @@ auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
| Integer | Target temperature |
### {% linkable_title Attribute `desired_fan_mode` %}
@ -120,7 +98,7 @@ Returns the desired fan mode of the current operation.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
| String | 'on', 'off' |
### {% linkable_title Attribute `fan` %}
@ -128,7 +106,7 @@ Returns the current fan state.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
| String | 'on', 'off' |
### {% linkable_title Attribute `current_hold_mode` %}
@ -136,7 +114,7 @@ Returns the current temperature hold, if any.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'home', 'away', 'temp', None
| String | 'home', 'away', 'temp', None |
### {% linkable_title Attribute `current_operation` %}
@ -144,7 +122,7 @@ Returns the current operation of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'auto', 'cool', 'heat', 'off'
| String | 'auto', 'cool', 'heat', 'off' |
### {% linkable_title Attribute `operation_list` %}
@ -152,7 +130,7 @@ Returns the list of available operation modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
| List of String | Available operation modes |
### {% linkable_title Attribute `operation_mode` %}
@ -160,7 +138,7 @@ Returns the current operation mode of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Currently active operation mode
| String | Currently active operation mode |
### {% linkable_title Attribute `mode` %}
@ -172,12 +150,11 @@ Returns the current fan mimimum on time.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current fan minimum on time in minutes
| Integer | Current fan minimum on time in minutes |
### {% linkable_title Attribute `is_away_mode_on` %}
Returns whether the thermostat is in away mode (see the corresponding
service for more detail).
Returns whether the thermostat is in away mode (see the corresponding service for more detail).
### {% linkable_title Attribute `actual humidity` %}
@ -185,17 +162,15 @@ Returns the humidity as measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current humidity
| Integer | Current humidity |
## {% linkable_title 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.
`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.
@ -205,21 +180,18 @@ Turns the away mode on or off for 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.
| `away_mode` | no | 'on' or 'off'
| `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' |
### {% linkable_title Service `set_hold_mode` %}
Puts the thermostat into the given hold mode. For 'home' and 'away', the
target temperature is taken from the home or away, climate, respectively.
For 'temp', the current temperature is taken as the target temperature.
When None is provided as parameter, the hold_mode is turned off.
Puts the thermostat into the given hold mode. For 'home' and 'away', the target temperature is taken from the home or away, climate, respectively. For 'temp', the current temperature is taken as the target temperature. When None is provided as parameter, the hold_mode is turned off.
| 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 | 'home', 'away', 'temp', None
| `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 | 'home', 'away', 'temp', None |
### {% linkable_title Service `set_temperature` %}
@ -228,12 +200,11 @@ 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)
| `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.
Only the target temperatures relevant for the current operation mode need to be provided.
### {% linkable_title Service `set_operation_mode` %}
@ -241,8 +212,8 @@ 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'
| `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' |
### {% linkable_title Service `fan_min_on_time` %}
@ -250,8 +221,8 @@ 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
| `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 |
### {% linkable_title Service `resume_program` %}
@ -259,5 +230,5 @@ Resumes the currently active schedule.
| 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.
| `resume_all` | no | true or false
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. |
| `resume_all` | no | true or false |