home-assistant.github.io/components/climate.nuheat/index.html
2018-01-27 05:27:50 +00:00

483 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>NuHeat Thermostat - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate your NuHeat Signature thermostats within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/climate.nuheat/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="NuHeat Thermostat">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/climate.nuheat/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate your NuHeat Signature thermostats within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="NuHeat Thermostat">
<meta name="twitter:description" content="Instructions how to integrate your NuHeat Signature thermostats within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
NuHeat Thermostat
</h1>
</header>
<hr class="divider">
<p class="note">
To get your <a href="http://www.nuheat.com/products/thermostats/signature-thermostat">NuHeat Signature</a> thermostats working within Home Assistant, please follow the instructions for the general <a href="/components/nuheat">NuHeat component</a>
</p>
<h2><a class="title-link" name="concepts" href="#concepts"></a> Concepts</h2>
<p>The NuHeat Thermostat supports the following key concepts.</p>
<p>The <code class="highlighter-rouge">target temperature</code> is the temperature that the device attempts to achieve. The target temperature is either determined by the schedule programmed into the thermostat (<code class="highlighter-rouge">auto mode</code>) or may be overridden. When the target temperature is set by Home Assistant, the thermostat will hold this temperature until the schedule is resumed.</p>
<h2><a class="title-link" name="attributes" href="#attributes"></a> Attributes</h2>
<p>The following attributes are provided by the NuHeat thermostat: <code class="highlighter-rouge">name</code>, <code class="highlighter-rouge">temperature_unit</code>, <code class="highlighter-rouge">current_temperature</code>, <code class="highlighter-rouge">target_temperature</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">min_temp</code> and <code class="highlighter-rouge">max_temp</code>.</p>
<h3><a class="title-link" name="attribute-name" href="#attribute-name"></a> Attribute <code class="highlighter-rouge">name</code></h3>
<p>Returns the name of the NuHeat Thermostat.</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>String</td>
<td>Name of the thermostat</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-temperature_unit" href="#attribute-temperature_unit"></a> Attribute <code class="highlighter-rouge">temperature_unit</code></h3>
<p>Returns the unit of measurement used for temperature by the thermostat.</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>String</td>
<td>Name of the temperature unit</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-current_temperature" href="#attribute-current_temperature"></a> Attribute <code class="highlighter-rouge">current_temperature</code></h3>
<p>Returns the current temperature measured by the thermostat.</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Integer</td>
<td>Currently measured temperature</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-target_temperature" href="#attribute-target_temperature"></a> Attribute <code class="highlighter-rouge">target_temperature</code></h3>
<p>Returns the target temperature of the thermostat, when the thermostat is
not in auto operation mode.</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Integer</td>
<td>Target temperature</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-current_hold_mode" href="#attribute-current_hold_mode"></a> Attribute <code class="highlighter-rouge">current_hold_mode</code></h3>
<p>Returns the current temperature hold, if any.</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>String</td>
<td>temperature, temporary_temperature, auto, etc.</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-current_operation" href="#attribute-current_operation"></a> Attribute <code class="highlighter-rouge">current_operation</code></h3>
<p>Returns the current operation of the thermostat.</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>String</td>
<td>heat, idle</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-operation_list" href="#attribute-operation_list"></a> Attribute <code class="highlighter-rouge">operation_list</code></h3>
<p>Returns the list of available operation modes.</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>List of String</td>
<td>Available operation modes</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-min_temp" href="#attribute-min_temp"></a> Attribute <code class="highlighter-rouge">min_temp</code></h3>
<p>Returns the minimum supported temperature by the thermostat</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Integer</td>
<td>Minimum supported temperature</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="attribute-max_temp" href="#attribute-max_temp"></a> Attribute <code class="highlighter-rouge">max_temp</code></h3>
<p>Returns the maximum supported temperature by the thermostat</p>
<table>
<thead>
<tr>
<th>Attribute type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Integer</td>
<td>Maximum supported temperature</td>
</tr>
</tbody>
</table>
<h2><a class="title-link" name="services" href="#services"></a> Services</h2>
<p>The following services are provided by the NuHeat Thermostat: <code class="highlighter-rouge">set_temperature</code>, <code class="highlighter-rouge">set_hold_mode</code>, <code class="highlighter-rouge">nuheat_resume_program</code>.</p>
<p>The services <code class="highlighter-rouge">fan_min_on_time</code>, <code class="highlighter-rouge">set_aux_heat</code>, <code class="highlighter-rouge">set_away_mode</code>, <code class="highlighter-rouge">set_humidity</code>, <code class="highlighter-rouge">set_fan_mode</code>, <code class="highlighter-rouge">set_operation_mode</code> and <code class="highlighter-rouge">set_swing_mode</code> offered by the <a href="/components/climate/">Climate component</a> are not implemented for this thermostat.</p>
<h3><a class="title-link" name="service-set_temperature" href="#service-set_temperature"></a> Service <code class="highlighter-rouge">set_temperature</code></h3>
<p>Puts the thermostat into an indefinite hold at the given temperature.</p>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of climate devices to control. Else targets all.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">temperature</code></td>
<td>no</td>
<td>Desired target temperature (when not in auto mode)</td>
</tr>
</tbody>
</table>
<p>Only the target temperatures relevant for the current operation mode need to
be provided.</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>Sets the thermostats hold mode. The NuHeat thermostat supports “auto” (to run the thermostats programmed schedule), “temperature” (to indefinitely hold the thermostats current target temperature), or “temporary_temperature” (to hold the thermostats current target temperature until the thermostats next scheduled event).</p>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of climate devices to control. Else targets all.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">hold_mode</code></td>
<td>no</td>
<td>New value of hold mode.</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="service-nuheat_resume_program" href="#service-nuheat_resume_program"></a> Service <code class="highlighter-rouge">nuheat_resume_program</code></h3>
<p>Resumes the currently active schedule.</p>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>yes</td>
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of climate devices to control. Else targets all.</td>
</tr>
</tbody>
</table>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/climate.nuheat.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/nuheat.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
</div>
<div class='section'>
Introduced in release: 0.61
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/climate/nuheat.py'>climate/nuheat.py</a>
</div>
<div class='section'>
This is a platform for
<a href='/components/climate/'>the Climate component</a>.
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/nuheat/'>
NuHeat
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Climate</h1>
<ul class='divided'>
<li>
<a href='/components/climate.daikin/'>Daikin AC</a>
</li>
<li>
<a href='/components/climate.ephember/'>EPH Controls Ember Thermostat</a>
</li>
<li>
<a href='/components/climate.eq3btsmart/'>EQ3 Bluetooth Smart Thermostats</a>
</li>
<li>
<a href='/components/climate.econet/'>EcoNet water heater</a>
</li>
<li>
<a href='/components/climate.ecobee/'>Ecobee Thermostat</a>
</li>
<li>
<a href='/components/climate.flexit/'>Flexit A/C controller</a>
</li>
<li>
<a href='/components/climate.generic_thermostat/'>Generic Thermostat</a>
</li>
<li>
<a href='/components/climate.heatmiser/'>Heatmiser Thermostat</a>
</li>
<li>
<a href='/components/climate.hive/'>Hive Thermostat</a>
</li>
<li>
<a href='/components/climate.homematic/'>Homematic Thermostats</a>
</li>
<li>
<a href='/components/climate.honeywell/'>Honeywell Thermostat</a>
</li>
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
<li>
<a href='/components/climate.nest/'>Nest Thermostat</a>
</li>
<li>
<a href='/components/climate.netatmo/'>Netatmo Thermostat</a>
</li>
<li>
NuHeat Thermostat
</li>
<li>
<a href='/components/climate.oem/'>OpenEnergyMonitor WiFi Thermostat</a>
</li>
<li>
<a href='/components/climate.proliphix/'>Proliphix Thermostat</a>
</li>
<li>
<a href='/components/climate.radiotherm/'>Radio Thermostat (3M Filtrete) Thermostat</a>
</li>
<li>
<a href='/components/climate.touchline/'>Roth Touchline</a>
</li>
<li>
<a href='/components/climate.sensibo/'>Sensibo A/C controller</a>
</li>
<li>
<a href='/components/climate.tado/'>Tado Thermostat</a>
</li>
<li>
<a href='/components/climate.tesla/'>Tesla HVAC</a>
</li>
<li>
<a href='/components/climate.toon/'>Toon Thermostat</a>
</li>
<li>
<a href='/components/climate.venstar/'>Venstar Thermostat</a>
</li>
<li>
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>
</li>
<li>
<a href='/components/maxcube/'>eQ-3 MAX! Cube</a>
</li>
<li>
<a href='/components/binary_sensor.maxcube/'>eQ-3 MAX! Cube binary sensors</a>
</li>
<li>
<a href='/components/climate.maxcube/'>eQ-3 MAX! Cube thermostat</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>