home-assistant.github.io/components/sensor.loop_energy/index.html
2016-04-13 04:25:48 +00:00

371 lines
No EOL
13 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="Paulus Schoutsen">
<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/home-assistant-logo-2164x2164.png">
<meta name="twitter:card" content="summary">
<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/home-assistant-logo-2164x2164.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>Getting started <i class="icon icon-caret-down"></i></a>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration/'>Configuration Basics</a></li>
<li><a href='/getting-started/devices/'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection/'>Presence Detection</a></li>
<li><a href='/getting-started/automation/'>Automation</a></li>
<li><a href='/topics/'>Advanced Topics</a></li>
</ul>
</li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook'>Examples</a></li>
<li>
<a>Developers <i class="icon icon-caret-down"></i></a>
<ul>
<li><a href="/developers/">Setup Development</a></li>
<li><a href="/developers/architecture/">Architecture</a></li>
<li><a href="/developers/frontend/">Frontend Development</a></li>
<li><a href="/developers/creating_components/">
Creating Components
</a></li>
<li><a href="/developers/add_new_platform/">
Adding Platform Support
</a></li>
<li><a href="/developers/api/">API and SSE</a></li>
<li><a href="/developers/credits/">Credits</a></li>
</ul>
</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.</p>
<p>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>Drupal.settings.navetas_realtime.</code></p>
<p>This should show something like<br />
<code>
client_ip: "127.0.0.1"
gas_secret: "GAS_SECRET"
gas_serial: "GAS_SERIAL"
host: "www.your-loop.com"
...
secret: "ELECTRICAL_SECRET"
serial: "ELECTRICAL_SERIAL"
</code></p>
<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>configuration.yaml</code>, replacing the <code>SERIAL</code> and <code>SECRET</code> keys with the ones you found in the console:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
<span class="key">sensor</span>:
<span class="key">platform</span>: <span class="string"><span class="content">loopenergy</span></span>
<span class="key">electricity_serial</span>: <span class="string"><span class="content">ELECTRICAL_SERIAL</span></span>
<span class="key">electricity_secret</span>: <span class="string"><span class="content">ELECTRICAL_SECRET</span></span>
<span class="key">gas_serial</span>: <span class="string"><span class="content">GAS_SERIAL</span></span>
<span class="key">gas_secret</span>: <span class="string"><span class="content">GAS_SECRET</span></span>
</pre></div>
</div>
</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>Required</em>): Serial number for your gas sensor.</li>
<li><strong>gas_secret</strong> (<em>Required</em>): Secret key for your gas sensor.</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.io/tree/master/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'>
<h1 class="title delta">Category Sensor</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
</li>
<li>
<a href='/components/sensor.bitcoin/'>Bitcoin</a>
</li>
<li>
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
</li>
<li>
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.command_line/'>Command line Sensor</a>
</li>
<li>
<a href='/components/sensor.deutsche_bahn/'>Deutsche Bahn</a>
</li>
<li>
<a href='/components/sensor.dweet/'>Dweet.io</a>
</li>
<li>
<a href='/components/sensor.ecobee/'>Ecobee Sensor</a>
</li>
<li>
<a href='/components/sensor.efergy/'>Efergy</a>
</li>
<li>
<a href='/components/sensor.eliqonline/'>Eliqonline</a>
</li>
<li>
<a href='/components/sensor.glances/'>Glances</a>
</li>
<li>
<a href='/components/sensor.http/'>HTTP Sensor</a>
</li>
<li>
Loop Energy
</li>
<li>
<a href='/components/sensor.mqtt/'>MQTT Sensor</a>
</li>
<li>
<a href='/components/sensor.modbus/'>Modbus Sensor</a>
</li>
<li>
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
</li>
<li>
<a href='/components/sensor.nzbget/'>NZBGet</a>
</li>
<li>
<a href='/components/sensor.nest/'>Nest Sensor</a>
</li>
<li>
<a href='/components/sensor.netatmo/'>Netatmo Sensor</a>
</li>
<li>
<a href='/components/sensor.neurio_energy/'>Neurio</a>
</li>
<li>
<a href='/components/sensor.onewire/'>One wire Sensor</a>
</li>
<li>
<a href='/components/sensor.gtfs/'>Public Transit (GTFS)</a>
</li>
<li>
<a href='/components/sensor.rest/'>RESTful Sensor</a>
</li>
<li>
<a href='/components/sensor.rfxtrx/'>RFXtrx Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.sabnzbd/'>SABnzbd</a>
</li>
<li>
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
</li>
<li>
<a href='/components/sensor.steam_online/'>Steam</a>
</li>
<li>
<a href='/components/sensor.swiss_public_transport/'>Swiss Public Transport</a>
</li>
<li>
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
</li>
<li>
<a href='/components/sensor.tcp/'>TCP Sensor</a>
</li>
<li>
<a href='/components/sensor.temper/'>TEMPer Sensor</a>
</li>
<li>
<a href='/components/sensor.tellstick/'>TellStick Sensor</a>
</li>
<li>
<a href='/components/sensor.tellduslive/'>Telldus Live sensor</a>
</li>
<li>
<a href='/components/sensor.template/'>Template Sensor</a>
</li>
<li>
<a href='/components/sensor.time_date/'>Time & Date</a>
</li>
<li>
<a href='/components/sensor.torque/'>Torque (OBD2)</a>
</li>
<li>
<a href='/components/sensor.transmission/'>Transmission Sensor</a>
</li>
<li>
<a href='/components/sensor.twitch/'>Twitch</a>
</li>
<li>
<a href='/components/sensor.uber/'>Uber</a>
</li>
<li>
<a href='/components/sensor.vera/'>Vera Sensor</a>
</li>
<li>
<a href='/components/sensor.verisure/'>Verisure Sensor</a>
</li>
<li>
<a href='/components/sensor.wink/'>Wink Sensor</a>
</li>
<li>
<a href='/components/sensor.worldclock/'>Worldclock</a>
</li>
<li>
<a href='/components/sensor.zwave/'>Z-Wave Sensor</a>
</li>
<li>
<a href='/components/sensor.zigbee/'>ZigBee Sensor</a>
</li>
<li>
<a href='/components/sensor.arest/'>aREST Sensor</a>
</li>
<li>
<a href='/components/sensor.mfi/'>mFi Sensor</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://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
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>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<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>