@@ -34,14 +34,16 @@ limits).
34
34
35
35
A _ climate_ is a predefined or user-defined set of states that the
36
36
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.
38
38
39
39
A _ hold_ is an override of the target temperature defined in the
40
40
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
43
44
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.
45
47
46
48
When in _ away mode_ , the target temperature is permanently overridden by
47
49
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:
59
61
` target_temperature_low ` , ` target_temperature_high ` , ` desired_fan_mode ` ,
60
62
` fan ` , ` current_hold_mode ` , ` current_operation ` , ` operation_list ` ,
61
63
` operation_mode ` , ` mode ` , ` fan_min_on_time ` , ` device_state_attributes ` ,
62
- ` is_away_mode_on ` .
64
+ ` is_away_mode_on ` , ` vacation ` , ` climate_list ` .
63
65
The attributes ` min_temp ` and ` max_temp ` are meaningless constant values.
64
66
65
67
@@ -136,7 +138,7 @@ Returns the current temperature hold, if any.
136
138
137
139
| Attribute type | Description |
138
140
| ---------------| ----------- |
139
- | String | 'home ', 'away ', 'temp' , None
141
+ | String | 'temp ', 'vacation ', 'home', 'away', etc. , None
140
142
141
143
### {% linkable_title Attribute ` current_operation ` %}
142
144
@@ -164,7 +166,8 @@ Returns the current operation mode of the thermostat.
164
166
165
167
### {% linkable_title Attribute ` mode ` %}
166
168
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).
168
171
169
172
### {% linkable_title Attribute ` fan_min_on_time ` %}
170
173
@@ -187,6 +190,18 @@ Returns the humidity as measured by the thermostat.
187
190
| ---------------| ----------- |
188
191
| Integer | Current humidity
189
192
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
+
190
205
191
206
## {% linkable_title Services %}
192
207
@@ -211,15 +226,19 @@ Turns the away mode on or off for the thermostat.
211
226
212
227
### {% linkable_title Service ` set_hold_mode ` %}
213
228
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.
216
232
For 'temp', the current temperature is taken as the target temperature.
217
233
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.
218
237
219
238
| Service data attribute | Optional | Description |
220
239
| ---------------------- | -------- | ----------- |
221
240
| ` 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
223
242
224
243
### {% linkable_title Service ` set_temperature ` %}
225
244
0 commit comments