home-assistant.github.io/components/sensor.emoncms/index.html
2016-12-03 22:55:09 +00:00

441 lines
No EOL
21 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>Emoncms Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate Emoncms feeds as sensors into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.emoncms/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Emoncms Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.emoncms/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate Emoncms feeds as sensors into 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="Emoncms Sensor">
<meta name="twitter:description" content="Instructions on how to integrate Emoncms feeds as sensors into 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="/ecosystem/">Ecosystem</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">
Emoncms Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">emoncms</code> sensor platform creates sensors for the feeds available in your local or cloud based version of <a href="https://emoncms.org">Emoncms</a>.</p>
<p>To enable this sensor, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>, it will list all feeds as a sensor:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry using cloud based Emoncms</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">emoncms</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">API_KEY</span>
<span class="s">url</span><span class="pi">:</span> <span class="s">https://emoncms.org</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">1</span>
</code></pre>
</div>
<h2><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration variables</h2>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): The read API key for your Emoncms user.</li>
<li><strong>url</strong> (<em>Required</em>): The base URL of Emoncms, use “https://emoncms.org” for the cloud based version.</li>
<li><strong>id</strong> (<em>Required</em>): Positive integer identifier for the sensor. Must be unique if you specify multiple Emoncms sensors.</li>
<li><strong>include_only_feed_id</strong> (<em>Optional</em>): Positive integer list of Emoncms feed IDs. Only the feeds with feed IDs specified here will be displayed. Can not be specified if <code class="highlighter-rouge">exclude_feed_id</code> is specified.</li>
<li><strong>exclude_feed_id</strong> (<em>Optional</em>): Positive integer list of Emoncms feed IDs. All the feeds will be displayed as sensors except the ones listed here. Can not be specified if <code class="highlighter-rouge">include_only_feed_id</code> is specified.</li>
<li><strong>sensor_names</strong> (<em>Optional</em>): Dictionary of names for the sensors created that are created based on feed ID. The dictionary consists of <code class="highlighter-rouge">feedid: name</code> pairs. Sensors for feeds with their feed ID mentioned here will get the chosen name instead of the default name</li>
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to alter the feed value.</li>
<li><strong>scan_interval</strong> (<em>Optional</em>): Defines the update interval of the sensor in seconds.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the unit of measurement of for all the sensors. default is “W”.</li>
</ul>
<h2><a class="title-link" name="default-naming-scheme" href="#default-naming-scheme"></a> Default naming scheme</h2>
<p>The names of the sensors created by this component, will be a combination of static text, <code class="highlighter-rouge">id</code> from the config and <code class="highlighter-rouge">feedid</code> from the Emoncms feed, unless <code class="highlighter-rouge">sensor_names</code> is used. An example name would be <code class="highlighter-rouge">emoncms1_feedid_10</code>.</p>
<h3><a class="title-link" name="examples" href="#examples"></a> Examples</h3>
<p>In this section you find some more examples of how this sensor can be used.</p>
<p>Display only feeds with their feed IDs specified in <code class="highlighter-rouge">include_only_feed_id</code>.</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">emoncms</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">API_KEY</span>
<span class="s">url</span><span class="pi">:</span> <span class="s">https://emoncms.org</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s2">"</span><span class="s">W"</span>
<span class="s">include_only_feed_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">107</span>
<span class="pi">-</span> <span class="s">105</span>
</code></pre>
</div>
<p>Display all feeds except feeds with their feed id specified in <code class="highlighter-rouge">exclude_feed_id</code>.</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">emoncms</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">API_KEY</span>
<span class="s">url</span><span class="pi">:</span> <span class="s">https://emoncms.org</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s2">"</span><span class="s">KWH"</span>
<span class="s">exclude_feed_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">107</span>
<span class="pi">-</span> <span class="s">105</span>
</code></pre>
</div>
<p>Display only feeds with their feed ids specified in <code class="highlighter-rouge">include_only_feed_id</code> and give the feed sensors a name using “sensor_names”. You dont have to specify all feeds names in “sensor_names”, the remaining sensor names will be chosen based on “id” and the Emoncms <code class="highlighter-rouge">feedid</code>.</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">emoncms</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">API_KEY</span>
<span class="s">url</span><span class="pi">:</span> <span class="s">https://emoncms.org</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s2">"</span><span class="s">KW"</span>
<span class="s">include_only_feed_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">5</span>
<span class="pi">-</span> <span class="s">120</span>
<span class="s">sensor_names</span><span class="pi">:</span>
<span class="s">5</span><span class="pi">:</span> <span class="s2">"</span><span class="s">feed</span><span class="nv"> </span><span class="s">1"</span>
<span class="s">48</span><span class="pi">:</span> <span class="s2">"</span><span class="s">kwh</span><span class="nv"> </span><span class="s">feed"</span>
<span class="s">61</span><span class="pi">:</span> <span class="s2">"</span><span class="s">amp</span><span class="nv"> </span><span class="s">feed"</span>
<span class="s">110</span><span class="pi">:</span> <span class="s2">"</span><span class="s">watt</span><span class="nv"> </span><span class="s">feed"</span>
</code></pre>
</div>
<p>Use a <code class="highlighter-rouge">value_template</code> to add 1500 to the feed value for all specified feed IDs in <code class="highlighter-rouge">include_feed_id</code>.</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">emoncms</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">API_KEY</span>
<span class="s">url</span><span class="pi">:</span> <span class="s">https://emoncms.org</span>
<span class="s">scan_interval</span><span class="pi">:</span> <span class="s">15</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">float</span><span class="nv"> </span><span class="s">+</span><span class="nv"> </span><span class="s">1500</span><span class="nv"> </span><span class="s">}}"</span>
<span class="s">include_only_feed_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">107</span>
<span class="pi">-</span> <span class="s">106</span>
</code></pre>
</div>
<p>Display feeds from the same Emoncms instance with 2 groups of feeds, different <code class="highlighter-rouge">scan_interval</code> and a different <code class="highlighter-rouge">unit_of_measurement</code>.</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">emoncms</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">API_KEY</span>
<span class="s">url</span><span class="pi">:</span> <span class="s">https://emoncms.org</span>
<span class="s">scan_interval</span><span class="pi">:</span> <span class="s">30</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s2">"</span><span class="s">W"</span>
<span class="s">include_only_feed_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">107</span>
<span class="pi">-</span> <span class="s">106</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">emoncms</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">put your emoncms read api key here</span>
<span class="s">url</span><span class="pi">:</span> <span class="s">https://emoncms.org</span>
<span class="s">id</span><span class="pi">:</span> <span class="s">2</span>
<span class="s">scan_interval</span><span class="pi">:</span> <span class="s">60</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s2">"</span><span class="s">A"</span>
<span class="s">include_only_feed_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">108</span>
<span class="pi">-</span> <span class="s">61</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/sensor.emoncms.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/emoncms.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.29
</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.api_stream/'>API Stream Sensor</a>
</li>
<li>
<a href='/components/sensor.arwn/'>ARWN Sensor</a>
</li>
<li>
<a href='/components/sensor.bbox/'>Bbox Sensor</a>
</li>
<li>
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
</li>
<li>
<a href='/components/sensor.command_line/'>Command line Sensor</a>
</li>
<li>
<a href='/components/sensor.dweet/'>Dweet.io</a>
</li>
<li>
Emoncms Sensor
</li>
<li>
<a href='/components/sensor.enocean/'>EnOcean Sensor</a>
</li>
<li>
<a href='/components/sensor.envisalink/'>Envisalink Sensor</a>
</li>
<li>
<a href='/components/sensor.gpsd/'>GPSD</a>
</li>
<li>
<a href='/components/sensor.http/'>HTTP Sensor</a>
</li>
<li>
<a href='/components/sensor.haveibeenpwned/'>HaveIBeenPwned Sensor</a>
</li>
<li>
<a href='/components/sensor.homematic/'>Homematic Sensor</a>
</li>
<li>
<a href='/components/sensor.imap_email_content/'>IMAP Email Content</a>
</li>
<li>
<a href='/components/sensor.imap/'>IMAP Unread E-mail</a>
</li>
<li>
<a href='/components/sensor.isy994/'>ISY994 Sensor</a>
</li>
<li>
<a href='/components/sensor.influxdb/'>InfluxDB Sensor</a>
</li>
<li>
<a href='/components/sensor.mhz19/'>MH-Z19 CO2 Sensor</a>
</li>
<li>
<a href='/components/sensor.mqtt/'>MQTT Sensor</a>
</li>
<li>
<a href='/components/sensor.min_max/'>Min/max Sensor</a>
</li>
<li>
<a href='/components/sensor.modbus/'>Modbus Sensor</a>
</li>
<li>
<a href='/components/sensor.moldindicator/'>Mold Indicator</a>
</li>
<li>
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
</li>
<li>
<a href='/components/sensor.nut/'>NUT Sensor</a>
</li>
<li>
<a href='/components/sensor.neato/'>Neato Robotics Sensor</a>
</li>
<li>
<a href='/components/sensor.nest/'>Nest Sensor</a>
</li>
<li>
<a href='/components/sensor.octoprint/'>OctoPrint Sensor</a>
</li>
<li>
<a href='/components/sensor.onewire/'>One wire Sensor</a>
</li>
<li>
<a href='/components/sensor.pilight/'>Pilight Sensor</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/sensor.random/'>Random Sensor</a>
</li>
<li>
<a href='/components/sensor.scrape/'>Scrape Sensor</a>
</li>
<li>
<a href='/components/sensor.sleepiq/'>SleepIQ Sensor</a>
</li>
<li>
<a href='/components/sensor.sonarr/'>Sonarr Sensor</a>
</li>
<li>
<a href='/components/sensor.statistics/'>Statistics Sensor</a>
</li>
<li>
<a href='/components/sensor.synologydsm/'>SynologyDSM Sensor</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.thinkingcleaner/'>Thinking Cleaner sensor</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.waqi/'>World Air Quality Index</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.zoneminder/'>ZoneMinder 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://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>