jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/climate.generic_thermostat/index.html
Travis CI 67179bf8fe Site updated at 2017-03-18 17:12:07 UTC
2017-03-18 17:12:07 +00:00

206 lines
12 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>Generic Thermostat - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Turn Home Assistant into a thermostat">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/climate.generic_thermostat/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Generic Thermostat">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/climate.generic_thermostat/">
<meta property="og:type" content="article">
<meta property="og:description" content="Turn Home Assistant into a thermostat">
<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="Generic Thermostat">
<meta name="twitter:description" content="Turn Home Assistant into a thermostat">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" 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>
<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>
</ul>
</nav>
</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">
Generic Thermostat
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">generic_thermostat</code> climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater under the hood. If the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when required temperature is reached.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">climate</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">generic_thermostat</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Study</span>
<span class="s">heater</span><span class="pi">:</span> <span class="s">switch.study_heater</span>
<span class="s">target_sensor</span><span class="pi">:</span> <span class="s">sensor.study_temperature</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Required</em>): Name of thermostat</li>
<li><strong>heater</strong> (<em>Required</em>): <code class="highlighter-rouge">entity_id</code> for heater switch, must be a toggle device.</li>
<li><strong>target_sensor</strong> (<em>Required</em>): <code class="highlighter-rouge">entity_id</code> for a temperature sensor, target_sensor.state must be temperature.</li>
<li><strong>min_temp</strong> (<em>Optional</em>): Set minimum set point available (default: 7)</li>
<li><strong>max_temp</strong> (<em>Optional</em>): Set maximum set point available (default: 35)</li>
<li><strong>target_temp</strong> (<em>Optional</em>): Set initial target temperature. Failure to set this variable will result in target temperature being set to null on startup.</li>
<li><strong>ac_mode</strong> (<em>Optional</em>): Set the switch specified in the <em>heater</em> option to be treated as a cooling device instead of a heating device.</li>
<li><strong>min_cycle_duration</strong> (<em>Optional</em>): Set a minimum amount of time that the switch specified in the <em>heater</em> option must be in it’s current state prior to being switched either off or on.</li>
<li><strong>tolerance</strong> (<em>Optional</em>): Set a minimum amount of difference between the temperature read by the sensor specified in the <em>target_sensor</em> option and the target temperature that must change prior to being switched either off or on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor goes below 24.5 and it will stop when the sensor goes above 25.5.</li>
<li><strong>keep_alive</strong> (<em>Optional</em>): Set a keep-alive interval. If set, the switch specified in the <em>heater</em> option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don’t receive a signal from their remote for a while.</li>
</ul>
<p>A full configuration example looks like the one below. <code class="highlighter-rouge">min_cycle_duration</code> and <code class="highlighter-rouge">keep_alive</code> must contain at least one of the following entries: <code class="highlighter-rouge">days:</code>, <code class="highlighter-rouge">hours:</code>, <code class="highlighter-rouge">minutes:</code>, <code class="highlighter-rouge">seconds:</code> or <code class="highlighter-rouge">milliseconds:</code>.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Full example configuration.yaml entry</span>
<span class="s">climate</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">generic_thermostat</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Study</span>
<span class="s">heater</span><span class="pi">:</span> <span class="s">switch.study_heater</span>
<span class="s">target_sensor</span><span class="pi">:</span> <span class="s">sensor.study_temperature</span>
<span class="s">min_temp</span><span class="pi">:</span> <span class="s">15</span>
<span class="s">max_temp</span><span class="pi">:</span> <span class="s">21</span>
<span class="s">target_temp</span><span class="pi">:</span> <span class="s">17</span>
<span class="s">tolerance</span><span class="pi">:</span> <span class="s">0.3</span>
<span class="s">min_cycle_duration</span><span class="pi">:</span>
<span class="s">seconds</span><span class="pi">:</span> <span class="s">5</span>
<span class="s">keep_alive</span><span class="pi">:</span>
<span class="s">minutes</span><span class="pi">:</span> <span class="s">3</span>
</code></pre>
</div>
</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.generic_thermostat.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/heat-control.png' />
</div>
<div class='section'>
Introduced in release: pre 0.7
</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">Category Climate</h1>
<ul class='divided'>
<li>
<a href='/components/climate.eq3btsmart/'>EQ3 Bluetooth Smart Thermostats</a>
</li>
<li>
<a href='/components/climate.ecobee/'>Ecobee Thermostat</a>
</li>
<li>
Generic Thermostat
</li>
<li>
<a href='/components/climate.heatmiser/'>Heatmiser 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.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>
<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.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</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>.<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>
</body>
</html>
Reference in a new issue View git blame Copy permalink