Skip to content

Commit 220ee3c

Browse files
DuoxilianLandrash
authored andcommitted
Update climate.ecobee.markdown (home-assistant#2198)
Update documentation corresponding to feature additions home-assistant#6258
1 parent 7d21bc6 commit 220ee3c

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

source/_components/climate.ecobee.markdown

+29-10
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ limits).
3434

3535
A _climate_ is a predefined or user-defined set of states that the
3636
thermostat aims to achieve. The ecobee thermostat provides three predefined
37-
climates: home, away, and sleep. The user can define additional climates.
37+
climates: Home, Away, and Sleep. The user can define additional climates.
3838

3939
A _hold_ is an override of the target temperature defined in the
4040
currently active climate. The temperature targeted in the hold mode may be
41-
explicitly set (temperature hold) or it may be derived from a reference
42-
climate (home or away hold). All holds are temporary. Temperature and
41+
explicitly set (temperature hold), it may be derived from a reference
42+
climate (home, away, sleep, etc.), or it may be derived from a vacation
43+
defined by the thermostat. All holds are temporary. Temperature and
4344
climate holds expire when the thermostat transitions to the next climate
44-
defined in its program.
45+
defined in its program. A vacation hold starts at the beginning of the
46+
defined vacation period, and expires when the vacation period ends.
4547

4648
When in _away mode_, the target temperature is permanently overridden by
4749
the target temperature defined for the away climate. The away mode is a
@@ -59,7 +61,7 @@ The following attributes are provided by the Ecobee Thermostat:
5961
`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`,
6062
`fan`, `current_hold_mode`, `current_operation`, `operation_list`,
6163
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
62-
`is_away_mode_on`.
64+
`is_away_mode_on`, `vacation`, `climate_list`.
6365
The attributes `min_temp` and `max_temp` are meaningless constant values.
6466

6567

@@ -136,7 +138,7 @@ Returns the current temperature hold, if any.
136138

137139
| Attribute type | Description |
138140
| ---------------| ----------- |
139-
| String | 'home', 'away', 'temp', None
141+
| String | 'temp', 'vacation', 'home', 'away', etc., None
140142

141143
### {% linkable_title Attribute `current_operation` %}
142144

@@ -164,7 +166,8 @@ Returns the current operation mode of the thermostat.
164166

165167
### {% linkable_title Attribute `mode` %}
166168

167-
Returns the climate currently active on the thermostat.
169+
Returns the climate currently active on the thermostat. The mode
170+
is returned as the user-visible name (rather than the internally used name).
168171

169172
### {% linkable_title Attribute `fan_min_on_time` %}
170173

@@ -187,6 +190,18 @@ Returns the humidity as measured by the thermostat.
187190
| ---------------| ----------- |
188191
| Integer | Current humidity
189192

193+
### {% linkable_title Attribute `vacation` %}
194+
195+
Returns the currently active vacation or `None`.
196+
197+
| Attribute type | Description |
198+
| ---------------| ----------- |
199+
| String | Name of currently active vacation |
200+
201+
### {% linkable_title Attribute `climate_list` %}
202+
203+
Returns the list of climates defined in the thermostat.
204+
190205

191206
## {% linkable_title Services %}
192207

@@ -211,15 +226,19 @@ Turns the away mode on or off for the thermostat.
211226

212227
### {% linkable_title Service `set_hold_mode` %}
213228

214-
Puts the thermostat into the given hold mode. For 'home' and 'away', the
215-
target temperature is taken from the home or away, climate, respectively.
229+
Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep',
230+
and ony other hold based on a reference climate, the
231+
target temperature is taken from the reference climate.
216232
For 'temp', the current temperature is taken as the target temperature.
217233
When None is provided as parameter, the hold_mode is turned off.
234+
It is not possible to set a vacation hold; such hold has to be
235+
defined on the thermostat directly. However, a vacation hold can be
236+
cancelled.
218237

219238
| Service data attribute | Optional | Description |
220239
| ---------------------- | -------- | ----------- |
221240
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
222-
| `hold_mode` | no | 'home', 'away', 'temp', None
241+
| `hold_mode` | no | 'temp', 'home', 'away', 'sleep', etc., None
223242

224243
### {% linkable_title Service `set_temperature` %}
225244

0 commit comments

Comments
 (0)