home-assistant.github.io/components/sensor.loop_energy/index.html
2016-10-08 18:28:02 +00:00

226 lines
No EOL
10 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>Loop Energy - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Loop Energy devices within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.loop_energy/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Loop Energy">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.loop_energy/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Loop Energy devices 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="Loop Energy">
<meta name="twitter:description" content="Instructions how to integrate Loop Energy devices within Home Assistant.">
<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='/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">
Loop Energy
</h1>
</header>
<hr class="divider">
<p>Integrate your <a href="https://www.your-loop.com/">Loop Energy</a> meter information into Home Assistant. To use this sensor you need the the client serial number and secret keys for your devices.</p>
<p>The library used to get the data isnt officially supported and the only way to get the keys is to log into loop energys website and type a command into your browser console.</p>
<p>To do this log into <a href="https://www.your-loop.com/">Loop Energy</a>. Once youre logged in you should be able see see your live readings on the webpage.</p>
<p>You can then open your browsers console window, how you do this varies by browser but in Chrome you click on `More Tools / Developer Tools and click on the console window. You then type:</p>
<p><code class="highlighter-rouge">Drupal.settings.navetas_realtime.</code></p>
<p>This should show something like</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">client_ip</span><span class="pi">:</span> <span class="s2">"</span><span class="s">127.0.0.1"</span>
<span class="s">gas_secret</span><span class="pi">:</span> <span class="s2">"</span><span class="s">GAS_SECRET"</span>
<span class="s">gas_serial</span><span class="pi">:</span> <span class="s2">"</span><span class="s">GAS_SERIAL"</span>
<span class="s">host</span><span class="pi">:</span> <span class="s2">"</span><span class="s">www.your-loop.com"</span>
<span class="nn">...</span>
<span class="s">secret</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ELECTRICAL_SECRET"</span>
<span class="s">serial</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ELECTRICAL_SERIAL"</span>
</code></pre>
</div>
<p>The serial and secret tokens are the ones you need. If you just have an electricity monitor then you wont see the gas keys.</p>
<p>Now you have the keys, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>, replacing the <code class="highlighter-rouge">*_SERIAL</code> and <code class="highlighter-rouge">*_SECRET</code> keys with the ones you found in the console:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">loopenergy</span>
<span class="s">electricity</span><span class="pi">:</span>
<span class="s">electricity_serial</span><span class="pi">:</span> <span class="s1">'</span><span class="s">ELECTRICAL_SERIAL'</span>
<span class="s">electricity_secret</span><span class="pi">:</span> <span class="s1">'</span><span class="s">ELECTRICAL_SECRET'</span>
<span class="s">gas</span><span class="pi">:</span>
<span class="s">gas_serial</span><span class="pi">:</span> <span class="s1">'</span><span class="s">GAS_SERIAL'</span>
<span class="s">gas_secret</span><span class="pi">:</span> <span class="s1">'</span><span class="s">GAS_SECRET'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>electricity_serial</strong> (<em>Required</em>): Serial number of your electricity sensor</li>
<li><strong>electricity_secret</strong> (<em>Required</em>): Secret key for your electricity sensor</li>
<li><strong>gas_serial</strong> (<em>Optional</em>): Serial number for your gas sensor.</li>
<li><strong>gas_secret</strong> (<em>Optional</em>): Secret key for your gas sensor.</li>
<li><strong>gas_type</strong> (<em>Optional</em>): Type of meter <code class="highlighter-rouge">imperial</code> or <code class="highlighter-rouge">metric</code>. Defaults to <code class="highlighter-rouge">metric</code>.</li>
<li><strong>gas_calorific</strong> (<em>Optional</em>): Calorific value of your gas supply (usually on your gas bill). Defaults to 39.11.</li>
</ul>
<p>The electricity readings are updated every 10 seconds and the gas readings every 15 minutes.</p>
<p>The gas readings are experimental and not all gas meters are properly supported. So if the data you see doesnt agree with the readings you see via loop energy please report an issue.</p>
</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/sensor.loop_energy.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/loop.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.17
</div>
<div class='section'>
<h1 class="title delta">Category Energy</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.dte_energy_bridge/'>DTE Energy Bridge</a>
</li>
<li>
<a href='/components/sensor.efergy/'>Efergy</a>
</li>
<li>
<a href='/components/sensor.eliqonline/'>Eliqonline</a>
</li>
<li>
Loop Energy
</li>
<li>
<a href='/components/sensor.neurio_energy/'>Neurio</a>
</li>
<li>
<a href='/components/sensor.ohmconnect/'>OhmConnect</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>
</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>