Skip to content

Commit

Permalink
Thermostat Capability - closes #13 (#56)
Browse files Browse the repository at this point in the history
* Thermostat Capability - closes #13
  • Loading branch information
benfrancis committed Oct 7, 2019
1 parent e7b6586 commit bc11a63
Showing 1 changed file with 83 additions and 0 deletions.
83 changes: 83 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ <h1>Contents</h1>
<li><a href="#Camera">Camera</a></li>
<li><a href="#VideoCamera">VideoCamera</a></li>
<li><a href="#Alarm">Alarm</a></li>
<li><a href="#Thermostat">Thermostat</a></li>
</ul>
<li><strong><a href="#properties">Properties</a></strong></li>
<ul>
Expand All @@ -139,9 +140,12 @@ <h1>Contents</h1>
<li><a href="#VoltageProperty">VoltageProperty</a></li>
<li><a href="#FrequencyProperty">FrequencyProperty</a></li>
<li><a href="#TemperatureProperty">TemperatureProperty</a></li>
<li><a href="#TargetTemperatureProperty">TargetTemperatureProperty</a></li>
<li><a href="#ImageProperty">ImageProperty</a></li>
<li><a href="#VideoProperty">VideoProperty</a></li>
<li><a href="#AlarmProperty">AlarmProperty</a></li>
<li><a href="#HeatingCoolingProperty">HeatingCoolingProperty</a></li>
<li><a href="#ThermostatModeProperty">ThermostatModeProperty</a></li>
</ul>
<li><strong><a href="#actions">Actions</a></strong></li>
<ul>
Expand Down Expand Up @@ -617,6 +621,43 @@ <h3>Events</h3>
</tr>
</table>
</section>
<section id="Thermostat">
<h2>Thermostat</h2>
<p>A device which regulates temperature. E.g. For space heating, cooking or refrigeration.</p>
<h3>Properties</h3>
<table>
<tr>
<th>Type</th>
<th>Read-Only</th>
<th>Required</th>
</tr>
<tr>
<td><a href="#TemperatureProperty">TemperatureProperty</a></td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td><a href="#TargetTemperatureProperty">TargetTemperatureProperty</a></td>
<td>No</td>
<td>Yes</td>
</tr>
<tr>
<td><a href="#HeatingCoolingProperty">HeatingCoolingProperty</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="#ThermostatModeProperty">ThermostatModeProperty</a></td>
<td>No</td>
<td>No</td>
</tr>
</table>
<p><strong>Note:</strong> A device may have multiple properties of the type <code>TargetTemperatureProperty</code>, e.g. to provide separate heating and cooling setpoints.</p>
<h3>Actions</h3>
<p>None.</p>
<h3>Events</h3>
<p>None.</p>
</section>
</section>
<section id="properties">
<h1>Properties</h1>
Expand Down Expand Up @@ -818,6 +859,20 @@ <h2>TemperatureProperty</h2>
</tr>
</table>
</section>
<section id="TargetTemperatureProperty">
<h2>TargetTemperatureProperty</h2>
<p>A <code>TargetTemperatureProperty</code> is like a <code>TemperatureProperty</code>, but defines a desired temperature rather than a current temperature.</p>
<table>
<tr>
<th>type</th>
<td>number/integer</td>
</tr>
<tr>
<th>unit</th>
<td>degree celsius</td>
</tr>
</table>
</section>
<section id="ImageProperty">
<h2>ImageProperty</h2>
<table>
Expand Down Expand Up @@ -847,6 +902,34 @@ <h2>AlarmProperty</h2>
</tr>
</table>
</section>
<section id="HeatingCoolingProperty">
<h2>HeatingCoolingProperty</h2>
<p>Defines the current state of a heating or cooling device. e.g. a thermostat, heater or air conditioner. Must support an "off" state and may support a "heating" state, a "cooling" state, or both.</p>
<table>
<tr>
<th>type</th>
<td>string</td>
</tr>
<tr>
<th>enum</th>
<td>["off", "heating", "cooling"]</td>
</tr>
</table>
</section>
<section id="ThermostatModeProperty">
<h2>ThermostatModeProperty</h2>
<p>Defines the current setting of a thermostat type device which can switch on and off a heating device and/or cooling device based on a current and desired temperature. Must support an "off" state and must support one or more of a "heat" state, "cool" state and "auto" state, where "auto" means either "heat" or "cool" depending on target and current temperatures.</p>
<table>
<tr>
<th>type</th>
<td>string</td>
</tr>
<tr>
<th>enum</th>
<td>["off", "heat", "cool", "auto"]</td>
</tr>
</table>
</section>
</section>
<section id="actions">
<h1>Actions</h1>
Expand Down

0 comments on commit bc11a63

Please sign in to comment.