home-assistant.github.io/components/climate.oem/index.html
2018-01-21 16:46:02 +00:00

268 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>OpenEnergyMonitor WiFi Thermostat - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate an OpenEnergyMonitor thermostat with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/climate.oem/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="OpenEnergyMonitor WiFi Thermostat">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/climate.oem/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate an OpenEnergyMonitor thermostat with 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="OpenEnergyMonitor WiFi Thermostat">
<meta name="twitter:description" content="Instructions how to integrate an OpenEnergyMonitor thermostat with 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">
OpenEnergyMonitor WiFi Thermostat
</h1>
</header>
<hr class="divider">
<p>This platform supports the ESP82666 based “WiFi MQTT Relay / Thermostat” sold by <a href="https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/">OpenEnergyMonitor</a>. The underlying <a href="http://oemthermostat.readthedocs.io/">library</a> only supports this single relay variant of the <a href="https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/">original device</a>.</p>
<p>This platform controls the setpoint of the thermostat in its “manual” mode, therefore there is a configuration option the away setpoint.</p>
<p>To set it up, add the following information to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">climate oem</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">oem</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.0.100</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address or hostname of the thermostat.</li>
<li><strong>port</strong> (<em>Optional</em>): The port for the web interface. Defaults to 80.</li>
<li><strong>name</strong> (<em>Optional</em>): The name to use for the frontend.</li>
<li><strong>username</strong> (<em>Optional</em>): Username for the web interface if set.</li>
<li><strong>password</strong> (<em>Optional</em>): Password for the web interface if set.</li>
<li><strong>away_temp</strong> (<em>Optional</em>): Setpoint for the thermostat in away mode. Defaults to 14 C.</li>
</ul>
</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.oem.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/oem.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>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.39
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/climate/oem.py'>climate/oem.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">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>
<a href='/components/climate.nuheat/'>NuHeat Thermostat</a>
</li>
<li>
OpenEnergyMonitor WiFi Thermostat
</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.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>