444 lines
20 KiB
HTML
444 lines
20 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 Notify - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate MySensors notifications into Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/notify.mysensors/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="MySensors Notify">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/notify.mysensors/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate MySensors notifications 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 Notify">
|
|
<meta name="twitter:description" content="Instructions how to integrate MySensors notifications into 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">
|
|
MySensors Notify
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>Integrates MySensors notifications into Home Assistant. See the <a href="/components/mysensors/">main component</a> for configuration instructions.</p>
|
|
<p>Setting the <code class="highlighter-rouge">target</code> key in the service call will target the name of the MySensors device in Home Assistant. MySensors device names follow the notation: “[Sketch name] [Node id] [Child id]”.</p>
|
|
<h3><a class="title-link" name="automation-example" href="#automation-example"></a> Automation example</h3>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="nn">...</span>
|
|
<span class="s">action</span><span class="pi">:</span>
|
|
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.mysensors</span>
|
|
<span class="s">data</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s">Welcome home!</span>
|
|
<span class="s">target</span><span class="pi">:</span> <span class="s1">'</span><span class="s">TextSensor</span><span class="nv"> </span><span class="s">254</span><span class="nv"> </span><span class="s">1'</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>The following sensor types are supported:</p>
|
|
<h5>MySensors version 2.0 and higher</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>S_TYPE</th>
|
|
<th>V_TYPE</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>S_INFO</td>
|
|
<td>V_TEXT</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>For more information, visit the <a href="http://www.mysensors.org/download/">api</a> page 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
|
|
*/</span>
|
|
|
|
<span class="cp">#define MY_DEBUG
|
|
</span> <span class="cp">#define MY_RADIO_NRF24
|
|
</span> <span class="cp">#define MY_REPEATER_FEATURE
|
|
</span>
|
|
<span class="cp">#include <SPI.h>
|
|
</span> <span class="cp">#include <MySensors.h>
|
|
</span>
|
|
<span class="cp">#define SN "TextSensor"
|
|
</span> <span class="cp">#define SV "1.0"
|
|
</span> <span class="cp">#define CHILD_ID 1
|
|
</span>
|
|
<span class="n">MyMessage</span> <span class="n">textMsg</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_TEXT</span><span class="p">);</span>
|
|
<span class="kt">bool</span> <span class="n">initialValueSent</span> <span class="o">=</span> <span class="nb">false</span><span class="p">;</span>
|
|
|
|
<span class="kt">void</span> <span class="nf">setup</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="kt">void</span> <span class="nf">presentation</span><span class="p">()</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">present</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">S_INFO</span><span class="p">,</span> <span class="s">"TextSensor1"</span><span class="p">);</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="k">if</span> <span class="p">(</span><span class="o">!</span><span class="n">initialValueSent</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"Sending initial value"</span><span class="p">);</span>
|
|
<span class="c1">// Send initial values.
|
|
</span> <span class="n">send</span><span class="p">(</span><span class="n">textMsg</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="s">"-"</span><span class="p">));</span>
|
|
<span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"Requesting initial value from controller"</span><span class="p">);</span>
|
|
<span class="n">request</span><span class="p">(</span><span class="n">CHILD_ID</span><span class="p">,</span> <span class="n">V_TEXT</span><span class="p">);</span>
|
|
<span class="n">wait</span><span class="p">(</span><span class="mi">2000</span><span class="p">,</span> <span class="n">C_SET</span><span class="p">,</span> <span class="n">V_TEXT</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="kt">void</span> <span class="nf">receive</span><span class="p">(</span><span class="k">const</span> <span class="n">MyMessage</span> <span class="o">&</span><span class="n">message</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="n">message</span><span class="p">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">V_TEXT</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="n">initialValueSent</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="s">"Receiving initial value from controller"</span><span class="p">);</span>
|
|
<span class="n">initialValueSent</span> <span class="o">=</span> <span class="nb">true</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="c1">// Dummy print
|
|
</span> <span class="n">Serial</span><span class="p">.</span><span class="n">print</span><span class="p">(</span><span class="s">"Message: "</span><span class="p">);</span>
|
|
<span class="n">Serial</span><span class="p">.</span><span class="n">print</span><span class="p">(</span><span class="n">message</span><span class="p">.</span><span class="n">sensor</span><span class="p">);</span>
|
|
<span class="n">Serial</span><span class="p">.</span><span class="n">print</span><span class="p">(</span><span class="s">", Message: "</span><span class="p">);</span>
|
|
<span class="n">Serial</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="n">message</span><span class="p">.</span><span class="n">getString</span><span class="p">());</span>
|
|
<span class="c1">// Send message to controller
|
|
</span> <span class="n">send</span><span class="p">(</span><span class="n">textMsg</span><span class="p">.</span><span class="n">set</span><span class="p">(</span><span class="n">message</span><span class="p">.</span><span class="n">getString</span><span class="p">()));</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/notify.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'>
|
|
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Push
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.36
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/notify/mysensors.py'>notify/mysensors.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
This is a platform for
|
|
<a href='/components/notify/'>the Notifications component</a>.
|
|
</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/cover.mysensors/'>
|
|
MySensors Cover
|
|
</a></li>
|
|
<li><a href='/components/device_tracker.mysensors/'>
|
|
MySensors Device Tracker
|
|
</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/sensor.mysensors/'>
|
|
MySensors Sensor
|
|
</a></li>
|
|
<li><a href='/components/switch.mysensors/'>
|
|
MySensors Switch
|
|
</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Notifications</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/notify.apns/'>APNS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.aws_lambda/'>AWS Lambda</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.aws_sns/'>AWS SNS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.aws_sqs/'>AWS SQS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.ciscospark/'>Cisco Spark</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.clicksend/'>ClickSend SMS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.clicksend_tts/'>ClickSend text-to-speech</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.clickatell/'>Clickatell SMS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.command_line/'>Command line Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.discord/'>Discord</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.ecobee/'>Ecobee Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.facebook/'>Facebook Messenger</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.file/'>File</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.free_mobile/'>Free Mobile</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.gntp/'>GNTP (Growl)</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.hipchat/'>HipChat</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.instapush/'>Instapush</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.xmpp/'>Jabber (XMPP)</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.joaoapps_join/'>Join Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.knx/'>KNX Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.kodi/'>Kodi</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.webostv/'>LG WebOS TV notifications</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.lametric/'>LaMetric Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.lannouncer/'>Lannouncer</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.llamalab_automate/'>LlamaLab Automate</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.mqtt/'>MQTT Notifications</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/mailgun/'>Mailgun</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.mailgun/'>Mailgun Notify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.matrix/'>Matrix</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.message_bird/'>MessageBird</a>
|
|
</li>
|
|
<li>
|
|
MySensors Notify
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.mycroft/'>Mycroft AI</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.nfandroidtv/'>Notifications for Android TV / FireTV</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.group/'>Notify Group</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.nma/'>Notify My Android</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.prowl/'>Prowl</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.html5/'>Push Notifications</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.pushbullet/'>Pushbullet</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.pushetta/'>Pushetta</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.pushover/'>Pushover</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.pushsafer/'>Pushsafer</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.rest/'>REST</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.rocketchat/'>Rocket.Chat</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.smtp/'>SMTP</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.sendgrid/'>SendGrid</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.simplepush/'>Simplepush</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.slack/'>Slack</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.synology_chat/'>Synology Chat</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.syslog/'>Syslog</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.telegram/'>Telegram</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/telegram_bot.broadcast/'>Telegram broadcast</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/telegram_bot.polling/'>Telegram polling</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/telegram_bot.webhooks/'>Telegram webhooks</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.telstra/'>Telstra</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.twilio_call/'>Twilio Call</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.twilio_sms/'>Twilio SMS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.twitter/'>Twitter</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/notify.yessssms/'>Yesss SMS</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>
|