Site updated at 2017-03-11 22:26:12 UTC

components/climate.ecobee/index.html

@@ -111,14 +111,16 @@ limits).</p>
 
 <p>A <em>climate</em> 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.</p>
+climates: Home, Away, and Sleep. The user can define additional climates.</p>
 
 <p>A <em>hold</em> 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
+explicitly set (temperature hold), 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.</p>
+defined in its program. A vacation hold starts at the beginning of the
+defined vacation period, and expires when the vacation period ends.</p>
 
 <p>When in <em>away mode</em>, the target temperature is permanently overridden by
 the target temperature defined for the away climate. The away mode is a
@@ -135,7 +137,7 @@ auto, and off.</p>
 <code class="highlighter-rouge">target_temperature_low</code>, <code class="highlighter-rouge">target_temperature_high</code>, <code class="highlighter-rouge">desired_fan_mode</code>, 
 <code class="highlighter-rouge">fan</code>, <code class="highlighter-rouge">current_hold_mode</code>, <code class="highlighter-rouge">current_operation</code>, <code class="highlighter-rouge">operation_list</code>,
 <code class="highlighter-rouge">operation_mode</code>, <code class="highlighter-rouge">mode</code>, <code class="highlighter-rouge">fan_min_on_time</code>, <code class="highlighter-rouge">device_state_attributes</code>, 
-<code class="highlighter-rouge">is_away_mode_on</code>.
+<code class="highlighter-rouge">is_away_mode_on</code>, <code class="highlighter-rouge">vacation</code>, <code class="highlighter-rouge">climate_list</code>.
 The attributes <code class="highlighter-rouge">min_temp</code> and <code class="highlighter-rouge">max_temp</code> are meaningless constant values.</p>
 
 <h3><a class="title-link" name="attribute-name" href="#attribute-name"></a> Attribute <code class="highlighter-rouge">name</code></h3>
@@ -307,7 +309,7 @@ auto operation mode.</p>
   <tbody>
     <tr>
       <td>String</td>
-      <td>‘home’, ‘away’, ‘temp’, None</td>
+      <td>‘temp’, ‘vacation’, ‘home’, ‘away’, etc., None</td>
     </tr>
   </tbody>
 </table>
@@ -371,7 +373,8 @@ auto operation mode.</p>
 
 <h3><a class="title-link" name="attribute-mode" href="#attribute-mode"></a> Attribute <code class="highlighter-rouge">mode</code></h3>
 
-<p>Returns the climate currently active on the thermostat.</p>
+<p>Returns the climate currently active on the thermostat. The mode
+is returned as the user-visible name (rather than the internally used name).</p>
 
 <h3><a class="title-link" name="attribute-fan_min_on_time" href="#attribute-fan_min_on_time"></a> Attribute <code class="highlighter-rouge">fan_min_on_time</code></h3>
 
@@ -416,6 +419,29 @@ service for more detail).</p>
   </tbody>
 </table>
 
+<h3><a class="title-link" name="attribute-vacation" href="#attribute-vacation"></a> Attribute <code class="highlighter-rouge">vacation</code></h3>
+
+<p>Returns the currently active vacation or <code class="highlighter-rouge">None</code>.</p>
+
+<table>
+  <thead>
+    <tr>
+      <th>Attribute type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>String</td>
+      <td>Name of currently active vacation</td>
+    </tr>
+  </tbody>
+</table>
+
+<h3><a class="title-link" name="attribute-climate_list" href="#attribute-climate_list"></a> Attribute <code class="highlighter-rouge">climate_list</code></h3>
+
+<p>Returns the list of climates defined in the thermostat.</p>
+
 <h2><a class="title-link" name="services" href="#services"></a> Services</h2>
 
 <p>The following services are provided by the Ecobee Thermostat:
@@ -453,10 +479,14 @@ are not implemented for this thermostat.</p>
 
 <h3><a class="title-link" name="service-set_hold_mode" href="#service-set_hold_mode"></a> Service <code class="highlighter-rouge">set_hold_mode</code></h3>
 
-<p>Puts the thermostat into the given hold mode. For ‘home’ and ‘away’, the
-target temperature is taken from the home or away, climate, respectively.
+<p>Puts the thermostat into the given hold mode. For ‘home’, ‘away’, ‘sleep’,
+and ony other hold based on a reference climate, the
+target temperature is taken from the reference climate.
 For ‘temp’, the current temperature is taken as the target temperature.
-When None is provided as parameter, the hold_mode is turned off.</p>
+When None is provided as parameter, the hold_mode is turned off.
+It is not possible to set a vacation hold; such hold has to be 
+defined on the thermostat directly. However, a vacation hold can be
+cancelled.</p>
 
 <table>
   <thead>
@@ -475,7 +505,7 @@ When None is provided as parameter, the hold_mode is turned off.</p>
     <tr>
       <td><code class="highlighter-rouge">hold_mode</code></td>
       <td>no</td>
-      <td>‘home’, ‘away’, ‘temp’, None</td>
+      <td>‘temp’, ‘home’, ‘away’, ‘sleep’, etc., None</td>
     </tr>
   </tbody>
 </table>