469 lines
No EOL
16 KiB
HTML
469 lines
No EOL
16 KiB
HTML
<!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>MySensors Sensor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate MySensors sensors into Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.mysensors/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="MySensors Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.mysensors/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate MySensors 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="MySensors Sensor">
|
||
<meta name="twitter:description" content="Instructions how to integrate MySensors 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='/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">
|
||
MySensors Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>Integrates MySensors sensors into Home Assistant. See the <a href="/components/mysensors/">main component</a> for configuration instructions.</p>
|
||
|
||
<p>The following sensor types are supported:</p>
|
||
|
||
<h5>MySensors version 1.4 and higher</h5>
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>S_TYPE</th>
|
||
<th>V_TYPE</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>S_TEMP</td>
|
||
<td>V_TEMP</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_HUM</td>
|
||
<td>V_HUM</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_BARO</td>
|
||
<td>V_PRESSURE, V_FORECAST</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_WIND</td>
|
||
<td>V_WIND, V_GUST</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_RAIN</td>
|
||
<td>V_RAIN, V_RAINRATE</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_UV</td>
|
||
<td>V_UV</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_WEIGHT</td>
|
||
<td>V_WEIGHT, V_IMPEDANCE</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_POWER</td>
|
||
<td>V_WATT, V_KWH</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_DISTANCE</td>
|
||
<td>V_DISTANCE</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_LIGHT_LEVEL</td>
|
||
<td>V_LIGHT_LEVEL</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_IR</td>
|
||
<td>V_IR_RECEIVE</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_WATER</td>
|
||
<td>V_FLOW, V_VOLUME</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_AIR_QUALITY</td>
|
||
<td>V_DUST_LEVEL</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_CUSTOM</td>
|
||
<td>V_VAR1, V_VAR2, V_VAR3, V_VAR4, V_VAR5</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_DUST</td>
|
||
<td>V_DUST_LEVEL</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_SCENE_CONTROLLER</td>
|
||
<td>V_SCENE_ON, V_SCENE_OFF</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<h5>MySensors version 1.5 and higher</h5>
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>S_TYPE</th>
|
||
<th>V_TYPE</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>S_COLOR_SENSOR</td>
|
||
<td>V_RGB</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_MULTIMETER</td>
|
||
<td>V_VOLTAGE, V_CURRENT, V_IMPEDANCE</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_SOUND</td>
|
||
<td>V_LEVEL</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_VIBRATION</td>
|
||
<td>V_LEVEL</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_MOISTURE</td>
|
||
<td>V_LEVEL</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_LIGHT_LEVEL</td>
|
||
<td>V_LEVEL</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_AIR_QUALITY</td>
|
||
<td>V_LEVEL (replaces V_DUST_LEVEL)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>S_DUST</td>
|
||
<td>V_LEVEL (replaces V_DUST_LEVEL)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<h3><a class="title-link" name="custom-unit-of-measurement" href="#custom-unit-of-measurement"></a> Custom unit of measurement</h3>
|
||
|
||
<p>Some sensor value types are not specific for a certain sensor type. These do not have a default unit of measurement in Home Assistant. For example, the V_LEVEL type can be used for different sensor types, dust, sound, vibration etc.</p>
|
||
|
||
<p>By using V_UNIT_PREFIX, it’s possible to set a custom unit for any sensor. The string value that is sent for V_UNIT_PREFIX will be used in preference to any other unit of measurement, for the defined sensors. V_UNIT_PREFIX can’t be used as a standalone sensor value type. Sending a supported value type and value from the tables above is also required. V_UNIT_PREFIX is available with MySensors version 1.5 and later.</p>
|
||
|
||
<p>For more information, visit the <a href="https://www.mysensors.org/download/serial_api_15">serial api</a> of MySensors.</p>
|
||
|
||
<h3><a class="title-link" name="example-sketch" href="#example-sketch"></a> Example sketch</h3>
|
||
|
||
<div class="language-cpp highlighter-rouge"><pre class="highlight"><code><span class="cm">/**
|
||
* Documentation: http://www.mysensors.org
|
||
* Support Forum: http://forum.mysensors.org
|
||
*
|
||
* http://www.mysensors.org/build/light
|
||
*/</span>
|
||
|
||
<span class="cp">#include <SPI.h>
|
||
#include <MySensor.h>
|
||
#include <BH1750.h>
|
||
#include <Wire.h>
|
||
</span>
|
||
<span class="cp">#define SN "LightLuxSensor"
|
||
#define SV "1.0"
|
||
#define CHILD_ID 1
|
||
</span><span class="kt">unsigned</span> <span class="kt">long</span> <span class="n">SLEEP_TIME</span> <span class="o">=</span> <span class="mi">30000</span><span class="p">;</span> <span class="c1">// Sleep time between reads (in milliseconds)
|
||
</span>
|
||
<span class="n">BH1750</span> <span class="n">lightSensor</span><span class="p">;</span>
|
||
<span class="n">MySensor</span> <span class="n">gw</span><span class="p">;</span>
|
||
<span class="n">MyMessage</span> <span class="n">msg</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_LEVEL</span><span class="p">);</span>
|
||
<span class="n">MyMessage</span> <span class="n">msgPrefix</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_UNIT_PREFIX</span><span class="p">);</span> <span class="c1">// Custom unit message.
|
||
</span><span class="kt">uint16_t</span> <span class="n">lastlux</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
|
||
|
||
<span class="kt">void</span> <span class="nf">setup</span><span class="p">()</span>
|
||
<span class="p">{</span>
|
||
<span class="n">gw</span><span class="p">.</span><span class="n">begin</span><span class="p">();</span>
|
||
<span class="n">gw</span><span class="p">.</span><span class="n">sendSketchInfo</span><span class="p">(</span><span class="n">SN</span><span class="p">,</span> <span class="n">SV</span><span class="p">);</span>
|
||
<span class="n">gw</span><span class="p">.</span><span class="n">present</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">S_LIGHT_LEVEL</span><span class="p">);</span>
|
||
<span class="n">lightSensor</span><span class="p">.</span><span class="n">begin</span><span class="p">();</span>
|
||
<span class="n">gw</span><span class="p">.</span><span class="n">send</span><span class="p">(</span><span class="n">msg</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="n">lastlux</span><span class="p">));</span>
|
||
<span class="n">gw</span><span class="p">.</span><span class="n">send</span><span class="p">(</span><span class="n">msgPrefix</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="s">"lux"</span><span class="p">));</span> <span class="c1">// Set custom unit.
|
||
</span><span class="p">}</span>
|
||
|
||
<span class="kt">void</span> <span class="nf">loop</span><span class="p">()</span>
|
||
<span class="p">{</span>
|
||
<span class="kt">uint16_t</span> <span class="n">lux</span> <span class="o">=</span> <span class="n">lightSensor</span><span class="p">.</span><span class="n">readLightLevel</span><span class="p">();</span> <span class="c1">// Get Lux value
|
||
</span> <span class="k">if</span> <span class="p">(</span><span class="n">lux</span> <span class="o">!=</span> <span class="n">lastlux</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="n">gw</span><span class="p">.</span><span class="n">send</span><span class="p">(</span><span class="n">msg</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="n">lux</span><span class="p">));</span>
|
||
<span class="n">lastlux</span> <span class="o">=</span> <span class="n">lux</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="n">gw</span><span class="p">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">SLEEP_TIME</span><span class="p">);</span>
|
||
<span class="p">}</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.mysensors.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/mysensors.png' />
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/mysensors/'>
|
||
MySensors
|
||
</a></li>
|
||
<li><a href='/components/binary_sensor.mysensors/'>
|
||
MySensors Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/climate.mysensors/'>
|
||
MySensors HVAC
|
||
</a></li>
|
||
<li><a href='/components/light.mysensors/'>
|
||
MySensors Light
|
||
</a></li>
|
||
<li><a href='/components/switch.mysensors/'>
|
||
MySensors Switch
|
||
</a></li>
|
||
</ul>
|
||
</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.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>
|
||
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.emoncms/'>Emoncms Sensor</a>
|
||
</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.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.mhz19/'>MH-Z19 CO2 Sensor</a>
|
||
</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.moldindicator/'>Mold Indicator</a>
|
||
</li>
|
||
<li>
|
||
MySensors Sensor
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nest/'>Nest Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.neurio_energy/'>Neurio</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.rest/'>RESTful Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.rfxtrx/'>RFXtrx Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sleepiq/'>SleepIQ 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.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://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> |