Site updated at 2017-02-11 22:50:44 UTC
This commit is contained in:
Travis CI
parent
83c3bf8dbf
commit
4bedc7a4cc
627 changed files with 11192 additions and 2416 deletions
283
components/alert/index.html
Normal file
283
components/alert/index.html
Normal file
|
|
@ -0,0 +1,283 @@
|
|||
<!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>Alert - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions how to setup automatic alerts within Home Assistant.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/alert/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Alert">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/alert/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions how to setup automatic alerts 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="Alert">
|
||||
<meta name="twitter:description" content="Instructions how to setup automatic alerts 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="/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">
|
||||
Alert
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>The <code class="highlighter-rouge">alert</code> component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the <code class="highlighter-rouge">alert</code> component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also useful for low battery sensors, water leak sensors, or any condition that may need your attention.</p>
|
||||
|
||||
<p>Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved.</p>
|
||||
|
||||
<h3><a class="title-link" name="basic-example" href="#basic-example"></a> Basic Example</h3>
|
||||
|
||||
<p>The <code class="highlighter-rouge">alert</code> component makes use of any of the <code class="highlighter-rouge">notifications</code> components. To setup the <code class="highlighter-rouge">alert</code> component, first, you must setup a <code class="highlighter-rouge">notification</code> component. Then, add the following to your configuration file:</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||||
<span class="s">alert</span><span class="pi">:</span>
|
||||
<span class="s">garage_door</span><span class="pi">:</span>
|
||||
<span class="s">name</span><span class="pi">:</span> <span class="s">Garage is open</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">input_boolean.garage_door</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
|
||||
<span class="s">repeat</span><span class="pi">:</span> <span class="s">30</span>
|
||||
<span class="s">can_acknowledge</span><span class="pi">:</span> <span class="s">True</span>
|
||||
<span class="s">skip_first</span><span class="pi">:</span> <span class="s">True</span>
|
||||
<span class="s">notifiers</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">ryans_phone</span>
|
||||
<span class="pi">-</span> <span class="s">kristens_phone</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Configuration variables:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>name</strong> (<em>Required</em>): The friendly name of the alert.</li>
|
||||
<li><strong>entity_id</strong> (<em>Required</em>): The ID of the entity to watch.</li>
|
||||
<li><strong>state</strong> (<em>Optional</em>): The problem condition for the entity. Defaults to <code class="highlighter-rouge">on</code>.</li>
|
||||
<li><strong>repeat</strong> (<em>Required</em>): Number of minutes before the notification should be repeated. Can be either a number or a list of numbers.</li>
|
||||
<li><strong>can_acknowledge</strong> (<em>Optional</em>): Allows the alert to be unacknowledgable. Defaults to <code class="highlighter-rouge">true</code>.</li>
|
||||
<li><strong>skip_first</strong> (<em>Optional</em>): Controls whether the notification should be sent immediately or after the first delay. Defaults to <code class="highlighter-rouge">false</code>.</li>
|
||||
<li><strong>notifiers</strong> (<em>Required</em>): List of <code class="highlighter-rouge">notification</code> components to use for alerts.</li>
|
||||
</ul>
|
||||
|
||||
<p>In this example, the garage door status (<code class="highlighter-rouge">input_boolean.garage_door</code>) is watched and this alert will be triggered when its status is equal to <code class="highlighter-rouge">on</code>. This indicates that the door has been opened. Because the <code class="highlighter-rouge">skip_first</code> option was set to <code class="highlighter-rouge">True</code>, the first notification will not be delivered immediately. However, every 30 minutes, a notification will be delivered until either <code class="highlighter-rouge">input_boolean.garage_door</code> no longer has a state of <code class="highlighter-rouge">on</code> or until the alert is acknowledged using the Home Assistant frontend.</p>
|
||||
|
||||
<h3><a class="title-link" name="complex-alert-criteria" href="#complex-alert-criteria"></a> Complex Alert Criteria</h3>
|
||||
|
||||
<p>By design, the <code class="highlighter-rouge">alert</code> component only handles very simple criteria for firing. That is, is only checks if a single entity’s state is equal to a value. At some point, it may be desireable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a <code class="highlighter-rouge">Template Binary Sensor</code>. The following example does that.</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">binary_sensor</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
|
||||
<span class="s">sensors</span><span class="pi">:</span>
|
||||
<span class="s">motion_battery_low</span><span class="pi">:</span>
|
||||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.sensor.motion.attributes.battery</span><span class="nv"> </span><span class="s"><</span><span class="nv"> </span><span class="s">15</span><span class="nv"> </span><span class="s">}}'</span>
|
||||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Motion</span><span class="nv"> </span><span class="s">battery</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">low'</span>
|
||||
|
||||
<span class="s">alert</span><span class="pi">:</span>
|
||||
<span class="s">motion_battery</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">Motion Battery is Low</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">binary_sensor.motion_battery_low</span>
|
||||
<span class="s">repeat</span><span class="pi">:</span> <span class="s">30</span>
|
||||
<span class="s">notifiers</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">ryans_phone</span>
|
||||
<span class="pi">-</span> <span class="s">kristens_phone</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>This example will begin firing as soon as the entity <code class="highlighter-rouge">sensor.motion</code>’s <code class="highlighter-rouge">battery</code> attribute falls below 15. It will continue to fire until the battery attribute raises above 15 or the alert is acknowledged on the frontend.</p>
|
||||
|
||||
<h3><a class="title-link" name="dynamic-notification-delay-times" href="#dynamic-notification-delay-times"></a> Dynamic Notification Delay Times</h3>
|
||||
|
||||
<p>It may be desireable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the <code class="highlighter-rouge">repeat</code> configuration key to a list of numbers rather than a single number. Altering the first example would look like the following.</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||||
<span class="s">alert</span><span class="pi">:</span>
|
||||
<span class="s">garage_door</span><span class="pi">:</span>
|
||||
<span class="s">name</span><span class="pi">:</span> <span class="s">Garage is open</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">input_boolean.garage_door</span>
|
||||
<span class="s">state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span> <span class="c1"># Optional, 'on' is the default value</span>
|
||||
<span class="s">repeat</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">15</span>
|
||||
<span class="pi">-</span> <span class="s">30</span>
|
||||
<span class="pi">-</span> <span class="s">60</span>
|
||||
<span class="s">can_acknowledge</span><span class="pi">:</span> <span class="s">True</span> <span class="c1"># Optional, default is True</span>
|
||||
<span class="s">skip_first</span><span class="pi">:</span> <span class="s">True</span> <span class="c1"># Optional, false is the default</span>
|
||||
<span class="s">notifiers</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">ryans_phone</span>
|
||||
<span class="pi">-</span> <span class="s">kristens_phone</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Now, the first message will be sent after a 15 minute delay. The second will be sent after a 30 minute delay. A 60 minute delay will fall between every following notification.</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/alert.markdown'>Edit this page on GitHub</a></div>
|
||||
<div class='brand-logo-container section'>
|
||||
<img src='/images/supported_brands/home-assistant.png' />
|
||||
</div>
|
||||
<div class='section'>
|
||||
Introduced in release: 0.38
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Category Automation</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
Alert
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/automation/'>Automation</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/switch.flux/'>Flux Light Adjustment</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/hdmi_cec/'>HDMI CEC</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ifttt/'>IFTTT</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/input_boolean/'>Input Boolean</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/input_select/'>Input Select</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/input_slider/'>Input Slider</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/keyboard/'>Keyboard</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/lirc/'>LIRC</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_sun_light_trigger/'>Presence based lights</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/proximity/'>Proximity</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rest_command/'>RESTful Command</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/script/'>Scripts</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/shell_command/'>Shell command</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>
|
||||
<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>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -246,9 +246,11 @@ WhereAreWeIntent where we are
|
|||
<span class="no">{%- for state in states.device_tracker -%}</span>
|
||||
<span class="no">{%- if state.name.lower() == User.lower() -%}</span>
|
||||
<span class="no">{{ state.name }} is at {{ state.state }}</span>
|
||||
<span class="no">{%- elif loop.last -%}</span>
|
||||
<span class="no">I am sorry, I do not know where {{ User }} is.</span>
|
||||
<span class="no">{%- endif -%}</span>
|
||||
<span class="no">{%- else -%}</span>
|
||||
<span class="no">I am sorry, I do not know where {{ User }} is.</span>
|
||||
<span class="no">Sorry, I don't have any trackers registered.</span>
|
||||
<span class="no">{%- endfor -%}</span>
|
||||
<span class="s">card</span><span class="pi">:</span>
|
||||
<span class="s">type</span><span class="pi">:</span> <span class="s">simple</span>
|
||||
|
|
|
|||
|
|
@ -221,6 +221,9 @@
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -128,6 +128,9 @@
|
|||
<div class='section'>
|
||||
<h1 class="title delta">Category Automation</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/alert/'>Alert</a>
|
||||
</li>
|
||||
<li>
|
||||
Automation
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -171,7 +171,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -197,7 +197,10 @@ This sensor is not suitable for fast state changes because there is a high possi
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -187,7 +187,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -184,7 +184,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -228,7 +228,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -167,7 +167,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -160,7 +160,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -180,7 +180,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -164,7 +164,10 @@
|
|||
Envisalink Binary Sensor
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -1,360 +1,10 @@
|
|||
<!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>FFmpeg Binary Sensor - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions on how to integrate an FFmpeg-based binary sensor">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.ffmpeg/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="FFmpeg Binary Sensor">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.ffmpeg/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions on how to integrate an FFmpeg-based binary sensor">
|
||||
<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="FFmpeg Binary Sensor">
|
||||
<meta name="twitter:description" content="Instructions on how to integrate an FFmpeg-based binary sensor">
|
||||
<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">
|
||||
FFmpeg Binary Sensor
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>The <code class="highlighter-rouge">ffmpeg</code> platform allows you to use any video or audio feed with <a href="http://www.ffmpeg.org/">FFmpeg</a> for various sensors in Home Assistant. Available are: <strong>noise</strong>, <strong>motion</strong>.</p>
|
||||
|
||||
<p class="note">
|
||||
If the <code class="highlighter-rouge">ffmpeg</code> process is broken, the sensor will be unavailable. To controll the ffmpeg process of sensor, use the service <em>binary_sensor.ffmpeg_start</em>, <em>binary_sensor.ffmpeg_stop</em>, <em>binary_sensor.ffmpeg_restart</em>.
|
||||
</p>
|
||||
|
||||
<h3><a class="title-link" name="noise" href="#noise"></a> Noise</h3>
|
||||
|
||||
<p>To add FFmpeg with noise detection to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||||
<span class="s">binary_sensor</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">ffmpeg</span>
|
||||
<span class="s">tool</span><span class="pi">:</span> <span class="s">noise</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Configuration variables:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>input</strong> (<em>Required</em>): An FFmpeg-compatible input file, stream, or feed.</li>
|
||||
<li><strong>tool</strong> (<em>Required</em>): <code class="highlighter-rouge">noise</code>.</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Override the name of your camera.</li>
|
||||
<li><strong>initial_state</strong> (<em>Optional</em>): Default true. Start ffmpeg with home-assistant.</li>
|
||||
<li><strong>peak</strong> (<em>Optional</em>): Default -30. The threshold of detecting noise, in dB. 0 is very loud and -100 is low.</li>
|
||||
<li><strong>duration</strong> (<em>Optional</em>): Default 1 second. How long the noise needs to be over the peak to trigger the state.</li>
|
||||
<li><strong>reset</strong> (<em>Optional</em>): Default 20 seconds. The time to reset the state after no new noise is over the peak.</li>
|
||||
<li><strong>extra_arguments</strong> (<em>Optional</em>): Extra options to pass to <code class="highlighter-rouge">ffmpeg</code>, like audio frequency filtering.</li>
|
||||
<li><strong>output</strong> (<em>Optional</em>): Allows you to send the audio output of this sensor to an Icecast server or other FFmpeg-supported output, e.g. to stream with Sonos after a state is triggered.</li>
|
||||
</ul>
|
||||
|
||||
<p>To experiment with values:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ffmpeg -i YOUR_INPUT -vn -filter:a <span class="nv">silencedetect</span><span class="o">=</span><span class="nv">n</span><span class="o">=</span>-30dB:d<span class="o">=</span>1 -f null -
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="motion" href="#motion"></a> Motion</h3>
|
||||
|
||||
<p>FFmpeg doesn’t have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option ‘changes’, the percent value of change between frames. If you want a really small value for ‘changes’, you can also add a denoise filter.</p>
|
||||
|
||||
<p>To add FFmpeg with motion detection to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||||
<span class="s">binary_sensor</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">ffmpeg</span>
|
||||
<span class="s">tool</span><span class="pi">:</span> <span class="s">motion</span>
|
||||
<span class="s">input</span><span class="pi">:</span> <span class="s">FFMPEG_SUPPORTED_INPUT</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Configuration variables:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>input</strong> (<em>Required</em>): An FFmpeg-compatible input file, stream, or feed.</li>
|
||||
<li><strong>tool</strong> (<em>Required</em>): <code class="highlighter-rouge">motion</code>.</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Override the name of your camera for the frontend.</li>
|
||||
<li><strong>initial_state</strong> (<em>Optional</em>): Start <code class="highlighter-rouge">ffmpeg</code> with Home Assistant. Defaults to <code class="highlighter-rouge">true</code>.</li>
|
||||
<li><strong>changes</strong> (<em>Optional</em>): How much needs to change between two frames to detect it as motion (a lower value is more sensitive). Defaults to 10%.</li>
|
||||
<li><strong>reset</strong> (<em>Optional</em>): The time to reset the state after no new motion is detected. Defaults to 20 seconds.</li>
|
||||
<li><strong>repeat</strong> (<em>Optional</em>): How many events need to be detected in <em>repeat_time</em> in order to trigger a motion. Defaults to 0 repeats (deactivated).</li>
|
||||
<li><strong>repeat_time</strong> (<em>Optional</em>): The span of time <em>repeat</em> events need to occur in before triggering a motion. Defaults to 0 seconds (deactivated).</li>
|
||||
<li><strong>extra_arguments</strong> (<em>Optional</em>): Extra options to pass to <code class="highlighter-rouge">ffmpeg</code>, e.g. video denoise filtering.</li>
|
||||
</ul>
|
||||
|
||||
<p>To experiment with values (changes/100 is the scene value in <code class="highlighter-rouge">ffmpeg</code>):</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ffmpeg -i YOUR_INPUT -an -filter:v <span class="k">select</span><span class="o">=</span>gt<span class="o">(</span>scene<span class="se">\,</span>0.1<span class="o">)</span> -f framemd5 -
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>If you are running into trouble with this sensor, please refer to the <a href="/components/ffmpeg/#troubleshooting">troubleshooting section</a>.</p>
|
||||
|
||||
<h4><a class="title-link" name="tipps" href="#tipps"></a> Tipps</h4>
|
||||
|
||||
<ul>
|
||||
<li>Use motion only in a customer area with <a href="https://ffmpeg.org/ffmpeg-filters.html#crop">crop filter</a>:</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">extra_arguments</span><span class="pi">:</span> <span class="s">-filter:v "crop=100:100:12:34"</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/binary_sensor.ffmpeg.markdown'>Edit this page on GitHub</a></div>
|
||||
<div class='brand-logo-container section'>
|
||||
<img src='/images/supported_brands/ffmpeg.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.27
|
||||
</div>
|
||||
<div class='section'>
|
||||
This is a platform for
|
||||
<a href='/components/binary_sensor/'>the Binary Sensor component</a>.
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class='title delta'>Related components</h1>
|
||||
<ul class='divided'>
|
||||
<li><a href='/components/ffmpeg/'>
|
||||
FFmpeg
|
||||
</a></li>
|
||||
<li><a href='/components/camera.ffmpeg/'>
|
||||
FFmpeg Camera
|
||||
</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Category Binary Sensor</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.bbb_gpio/'>BeagleBone Black GPIO Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.concord232/'>Concord232 Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
FFmpeg Binary Sensor
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.hikvision/'>Hikvision Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.isy994/'>ISY994 Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.iss/'>International Space Station</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.netatmo/'>Netatmo Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.sleepiq/'>SleepIQ Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.threshold/'>Threshold Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.arest/'>aREST Binary 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>
|
||||
<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>
|
||||
</body>
|
||||
</html>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting…</title>
|
||||
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.ffmpeg_motion/">
|
||||
<meta http-equiv="refresh" content="0; url=https://home-assistant.io/components/binary_sensor.ffmpeg_motion/">
|
||||
<h1>Redirecting…</h1>
|
||||
<a href="https://home-assistant.io/components/binary_sensor.ffmpeg_motion/">Click here if you are not redirected.</a>
|
||||
<script>location="https://home-assistant.io/components/binary_sensor.ffmpeg_motion/"</script>
|
||||
</html>
|
||||
|
|
|
|||
316
components/binary_sensor.ffmpeg_motion/index.html
Normal file
316
components/binary_sensor.ffmpeg_motion/index.html
Normal file
|
|
@ -0,0 +1,316 @@
|
|||
<!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>FFmpeg Motion Binary Sensor - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions on how to integrate an FFmpeg-based motion binary sensor">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.ffmpeg_motion/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="FFmpeg Motion Binary Sensor">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.ffmpeg_motion/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions on how to integrate an FFmpeg-based motion binary sensor">
|
||||
<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="FFmpeg Motion Binary Sensor">
|
||||
<meta name="twitter:description" content="Instructions on how to integrate an FFmpeg-based motion binary sensor">
|
||||
<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">
|
||||
FFmpeg Motion Binary Sensor
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>The <code class="highlighter-rouge">ffmpeg</code> platform allows you to use any video feed with <a href="http://www.ffmpeg.org/">FFmpeg</a> for motion sensors in Home Assistant.</p>
|
||||
|
||||
<p class="note">
|
||||
If the <code class="highlighter-rouge">ffmpeg</code> process is broken, the sensor will be unavailable. To controll the ffmpeg process of sensor, use the service <em>ffmpeg.start</em>, <em>ffmpeg.stop</em>, <em>ffmpeg.restart</em>.
|
||||
</p>
|
||||
|
||||
<h3><a class="title-link" name="motion" href="#motion"></a> Motion</h3>
|
||||
|
||||
<p>FFmpeg doesn’t have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option ‘changes’, the percent value of change between frames. If you want a really small value for ‘changes’, you can also add a denoise filter.</p>
|
||||
|
||||
<p>To add FFmpeg with motion detection to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||||
<span class="s">binary_sensor</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">ffmpeg</span>
|
||||
<span class="s">input</span><span class="pi">:</span> <span class="s">FFMPEG_SUPPORTED_INPUT</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Configuration variables:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>input</strong> (<em>Required</em>): An FFmpeg-compatible input file, stream, or feed.</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Override the name of your camera for the frontend.</li>
|
||||
<li><strong>initial_state</strong> (<em>Optional</em>): Start <code class="highlighter-rouge">ffmpeg</code> with Home Assistant. Defaults to <code class="highlighter-rouge">true</code>.</li>
|
||||
<li><strong>changes</strong> (<em>Optional</em>): How much needs to change between two frames to detect it as motion (a lower value is more sensitive). Defaults to 10%.</li>
|
||||
<li><strong>reset</strong> (<em>Optional</em>): The time to reset the state after no new motion is detected. Defaults to 20 seconds.</li>
|
||||
<li><strong>repeat</strong> (<em>Optional</em>): How many events need to be detected in <em>repeat_time</em> in order to trigger a motion. Defaults to 0 repeats (deactivated).</li>
|
||||
<li><strong>repeat_time</strong> (<em>Optional</em>): The span of time <em>repeat</em> events need to occur in before triggering a motion. Defaults to 0 seconds (deactivated).</li>
|
||||
<li><strong>extra_arguments</strong> (<em>Optional</em>): Extra options to pass to <code class="highlighter-rouge">ffmpeg</code>, e.g. video denoise filtering.</li>
|
||||
</ul>
|
||||
|
||||
<p>To experiment with values (changes/100 is the scene value in <code class="highlighter-rouge">ffmpeg</code>):</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ffmpeg -i YOUR_INPUT -an -filter:v <span class="k">select</span><span class="o">=</span>gt<span class="o">(</span>scene<span class="se">\,</span>0.1<span class="o">)</span> -f framemd5 -
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>If you are running into trouble with this sensor, please refer to the <a href="/components/ffmpeg/#troubleshooting">troubleshooting section</a>.</p>
|
||||
|
||||
<h4><a class="title-link" name="tipps" href="#tipps"></a> Tipps</h4>
|
||||
|
||||
<ul>
|
||||
<li>Use motion only in a customer area with <a href="https://ffmpeg.org/ffmpeg-filters.html#crop">crop filter</a>:</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">extra_arguments</span><span class="pi">:</span> <span class="s">-filter:v "crop=100:100:12:34"</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/binary_sensor.ffmpeg_motion.markdown'>Edit this page on GitHub</a></div>
|
||||
<div class='brand-logo-container section'>
|
||||
<img src='/images/supported_brands/ffmpeg.png' />
|
||||
</div>
|
||||
<div class='section'>
|
||||
Introduced in release: 0.27
|
||||
</div>
|
||||
<div class='section'>
|
||||
This is a platform for
|
||||
<a href='/components/binary_sensor/'>the Binary Sensor component</a>.
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Category Binary Sensor</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.bbb_gpio/'>BeagleBone Black GPIO Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.concord232/'>Concord232 Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
FFmpeg Motion Binary Sensor
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.hikvision/'>Hikvision Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.isy994/'>ISY994 Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.iss/'>International Space Station</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.netatmo/'>Netatmo Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.sleepiq/'>SleepIQ Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.threshold/'>Threshold Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.arest/'>aREST Binary 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>
|
||||
<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>
|
||||
</body>
|
||||
</html>
|
||||
302
components/binary_sensor.ffmpeg_noise/index.html
Normal file
302
components/binary_sensor.ffmpeg_noise/index.html
Normal file
|
|
@ -0,0 +1,302 @@
|
|||
<!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>FFmpeg Noise Binary Sensor - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions on how to integrate an FFmpeg-based noise binary sensor">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.ffmpeg_noise/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="FFmpeg Noise Binary Sensor">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.ffmpeg_noise/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions on how to integrate an FFmpeg-based noise binary sensor">
|
||||
<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="FFmpeg Noise Binary Sensor">
|
||||
<meta name="twitter:description" content="Instructions on how to integrate an FFmpeg-based noise binary sensor">
|
||||
<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">
|
||||
FFmpeg Noise Binary Sensor
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>The <code class="highlighter-rouge">ffmpeg</code> platform allows you to use any video or audio feed with <a href="http://www.ffmpeg.org/">FFmpeg</a> for various sensors in Home Assistant.</p>
|
||||
|
||||
<p class="note">
|
||||
If the <code class="highlighter-rouge">ffmpeg</code> process is broken, the sensor will be unavailable. To controll the ffmpeg process of sensor, use the service <em>ffmpeg.start</em>, <em>ffmpeg.stop</em>, <em>ffmpeg.restart</em>.
|
||||
</p>
|
||||
|
||||
<h3><a class="title-link" name="noise" href="#noise"></a> Noise</h3>
|
||||
|
||||
<p>To add FFmpeg with noise detection to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||||
<span class="s">binary_sensor</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">ffmpeg</span>
|
||||
<span class="s">input</span><span class="pi">:</span> <span class="s">FFMPEG_SUPPORTED_INPUT</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Configuration variables:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>input</strong> (<em>Required</em>): An FFmpeg-compatible input file, stream, or feed.</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Override the name of your camera.</li>
|
||||
<li><strong>initial_state</strong> (<em>Optional</em>): Default true. Start ffmpeg with home-assistant.</li>
|
||||
<li><strong>peak</strong> (<em>Optional</em>): Default -30. The threshold of detecting noise, in dB. 0 is very loud and -100 is low.</li>
|
||||
<li><strong>duration</strong> (<em>Optional</em>): Default 1 second. How long the noise needs to be over the peak to trigger the state.</li>
|
||||
<li><strong>reset</strong> (<em>Optional</em>): Default 20 seconds. The time to reset the state after no new noise is over the peak.</li>
|
||||
<li><strong>extra_arguments</strong> (<em>Optional</em>): Extra options to pass to <code class="highlighter-rouge">ffmpeg</code>, like audio frequency filtering.</li>
|
||||
<li><strong>output</strong> (<em>Optional</em>): Allows you to send the audio output of this sensor to an Icecast server or other FFmpeg-supported output, e.g. to stream with Sonos after a state is triggered.</li>
|
||||
</ul>
|
||||
|
||||
<p>To experiment with values:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ffmpeg -i YOUR_INPUT -vn -filter:a <span class="nv">silencedetect</span><span class="o">=</span><span class="nv">n</span><span class="o">=</span>-30dB:d<span class="o">=</span>1 -f null -
|
||||
</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/binary_sensor.ffmpeg_noise.markdown'>Edit this page on GitHub</a></div>
|
||||
<div class='brand-logo-container section'>
|
||||
<img src='/images/supported_brands/ffmpeg.png' />
|
||||
</div>
|
||||
<div class='section'>
|
||||
Introduced in release: 0.27
|
||||
</div>
|
||||
<div class='section'>
|
||||
This is a platform for
|
||||
<a href='/components/binary_sensor/'>the Binary Sensor component</a>.
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Category Binary Sensor</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.bbb_gpio/'>BeagleBone Black GPIO Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.concord232/'>Concord232 Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
FFmpeg Noise Binary Sensor
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.hikvision/'>Hikvision Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.isy994/'>ISY994 Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.iss/'>International Space Station</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.netatmo/'>Netatmo Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.sleepiq/'>SleepIQ Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.threshold/'>Threshold Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.arest/'>aREST Binary 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>
|
||||
<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>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -205,7 +205,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
Flic Smart Button
|
||||
|
|
|
|||
|
|
@ -235,7 +235,10 @@ binary_sensor.front_port_line_crossing
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -171,7 +171,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -220,7 +220,10 @@ You should choose a unique device name (DEVICE_NAME) to avoid clashes with other
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -180,7 +180,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -174,7 +174,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -163,7 +163,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -187,7 +187,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -224,7 +224,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -152,7 +152,7 @@
|
|||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>For more information, visit the <a href="https://www.mysensors.org/download/serial_api_15">serial api</a> of MySensors.</p>
|
||||
<p>For more information, visit the <a href="http://www.mysensors.org/download">serial api</a> of MySensors.</p>
|
||||
|
||||
<h3><a class="title-link" name="example-sketch" href="#example-sketch"></a> Example sketch</h3>
|
||||
|
||||
|
|
@ -238,6 +238,9 @@
|
|||
<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>
|
||||
|
|
@ -283,7 +286,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -210,7 +210,10 @@ You must have the <a href="/components/nest/">Nest component</a> configured to u
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -218,7 +218,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -190,7 +190,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -183,7 +183,10 @@ You must have the <a href="/components/octoprint/">OctoPrint component</a> confi
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -256,7 +256,10 @@ User-Agent: Home Assistant
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -187,7 +187,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -157,7 +157,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -179,7 +179,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -235,7 +235,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -173,7 +173,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -202,7 +202,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -174,7 +174,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -200,7 +200,10 @@ The above devices are confimed to work, but others may work as well.
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -183,7 +183,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -172,7 +172,10 @@
|
|||
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg/'>FFmpeg Binary Sensor</a>
|
||||
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
|
||||
|
|
|
|||
|
|
@ -161,8 +161,11 @@
|
|||
<li><a href='/components/binary_sensor.envisalink/'>
|
||||
Envisalink Binary Sensor
|
||||
</a></li>
|
||||
<li><a href='/components/binary_sensor.ffmpeg/'>
|
||||
FFmpeg Binary Sensor
|
||||
<li><a href='/components/binary_sensor.ffmpeg_motion/'>
|
||||
FFmpeg Motion Binary Sensor
|
||||
</a></li>
|
||||
<li><a href='/components/binary_sensor.ffmpeg_noise/'>
|
||||
FFmpeg Noise Binary Sensor
|
||||
</a></li>
|
||||
<li><a href='/components/binary_sensor.flic/'>
|
||||
Flic Smart Button
|
||||
|
|
|
|||
|
|
@ -228,6 +228,9 @@
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -169,7 +169,7 @@
|
|||
<a href='/components/http/'>HTTP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ha/'>Home Assistant 0.37</a>
|
||||
<a href='/components/ha/'>Home Assistant 0.38</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
|
|
@ -144,9 +144,6 @@
|
|||
<li><a href='/components/ffmpeg/'>
|
||||
FFmpeg
|
||||
</a></li>
|
||||
<li><a href='/components/binary_sensor.ffmpeg/'>
|
||||
FFmpeg Binary Sensor
|
||||
</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class='section'>
|
||||
|
|
|
|||
|
|
@ -98,23 +98,45 @@ To get your Ecobee thermostats working with Home Assistant, follow the instructi
|
|||
|
||||
<p>The Ecobee Thermostat supports the following key concepts.</p>
|
||||
|
||||
<p>The <em>target temperature</em> is the temperature that the device attempts to achieve. The target temperature is either determined by the
|
||||
currently active climate or it may be overridden by a hold. When the thermostat is not in auto mode, there is a single target temperature. When the thermostat is in auto operation mode, there is a pair of target temperatures: the lower target temperature determines the lowest desired temperature, while the higher target temperature determines the highest desired temperature (the thermostat will switch between heating and cooling to keep the temperature within these limits).</p>
|
||||
<p>The <em>target temperature</em> is the temperature that the device attempts
|
||||
to achieve. The target temperature is either determined by the
|
||||
currently active climate or it may be overridden by a hold. When the
|
||||
thermostat is not in auto mode, there is a single target
|
||||
temperature. When the thermostat is in auto operation mode, there is a
|
||||
pair of target temperatures: the lower target temperature determines
|
||||
the lowest desired temperature, while the higher target temperature
|
||||
determines the highest desired temperature (the thermostat will switch
|
||||
between heating and cooling to keep the temperature within these
|
||||
limits).</p>
|
||||
|
||||
<p>A <em>climate</em> is a predefined or user-defined set of states that the thermostat aims to achieve. The ecobee thermostat provides three predefined climates: home, away, and sleep. The user can define additional climates.</p>
|
||||
<p>A <em>climate</em> is a predefined or user-defined set of states that the
|
||||
thermostat aims to achieve. The ecobee thermostat provides three predefined
|
||||
climates: home, away, and sleep. The user can define additional climates.</p>
|
||||
|
||||
<p>A <em>hold</em> is an override of the target temperature defined in the currently active climate. The temperature targeted in the hold mode may be explicitly set (temperature hold) or it may be derived from a reference climate (home or away hold). All holds are temporary. Temperature and climate holds expire when the thermostat transitions to the next climate defined in its program.</p>
|
||||
<p>A <em>hold</em> is an override of the target temperature defined in the
|
||||
currently active climate. The temperature targeted in the hold mode may be
|
||||
explicitly set (temperature hold) or it may be derived from a reference
|
||||
climate (home or away hold). All holds are temporary. Temperature and
|
||||
climate holds expire when the thermostat transitions to the next climate
|
||||
defined in its program.</p>
|
||||
|
||||
<p>When in <em>away mode</em>, the target temperature is permanently overridden by the target temperature defined for the away climate. The away mode is a simple way to emulate a vacation mode.</p>
|
||||
<p>When in <em>away mode</em>, the target temperature is permanently overridden by
|
||||
the target temperature defined for the away climate. The away mode is a
|
||||
simple way to emulate a vacation mode.</p>
|
||||
|
||||
<p>The <em>operation mode</em> of the device is the currently active operational modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool, auto, and off.</p>
|
||||
<p>The <em>operation mode</em> of the device is the currently active operational
|
||||
modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool,
|
||||
auto, and off.</p>
|
||||
|
||||
<h2><a class="title-link" name="attributes" href="#attributes"></a> Attributes</h2>
|
||||
|
||||
<p>The following attributes are provided by the Ecobee Thermostat:
|
||||
<code class="highlighter-rouge">name</code>, <code class="highlighter-rouge">temperature_unit</code>, <code class="highlighter-rouge">current_temperature</code>, <code class="highlighter-rouge">target_temperature</code>, <code class="highlighter-rouge">target_temperature_low</code>, <code class="highlighter-rouge">target_temperature_high</code>, <code class="highlighter-rouge">desired_fan_mode</code>, <code class="highlighter-rouge">fan</code>, <code class="highlighter-rouge">current_hold_mode</code>, <code class="highlighter-rouge">current_operation</code>, <code class="highlighter-rouge">operation_list</code>,<code class="highlighter-rouge">operation_mode</code>, <code class="highlighter-rouge">mode</code>, <code class="highlighter-rouge">fan_min_on_time</code>, <code class="highlighter-rouge">device_state_attributes</code>, <code class="highlighter-rouge">is_away_mode_on</code>.</p>
|
||||
|
||||
<p>The attributes <code class="highlighter-rouge">min_temp</code> and <code class="highlighter-rouge">max_temp</code> are meaningless constant values.</p>
|
||||
<code class="highlighter-rouge">name</code>, <code class="highlighter-rouge">temperature_unit</code>, <code class="highlighter-rouge">current_temperature</code>, <code class="highlighter-rouge">target_temperature</code>,
|
||||
<code class="highlighter-rouge">target_temperature_low</code>, <code class="highlighter-rouge">target_temperature_high</code>, <code class="highlighter-rouge">desired_fan_mode</code>,
|
||||
<code class="highlighter-rouge">fan</code>, <code class="highlighter-rouge">current_hold_mode</code>, <code class="highlighter-rouge">current_operation</code>, <code class="highlighter-rouge">operation_list</code>,
|
||||
<code class="highlighter-rouge">operation_mode</code>, <code class="highlighter-rouge">mode</code>, <code class="highlighter-rouge">fan_min_on_time</code>, <code class="highlighter-rouge">device_state_attributes</code>,
|
||||
<code class="highlighter-rouge">is_away_mode_on</code>.
|
||||
The attributes <code class="highlighter-rouge">min_temp</code> and <code class="highlighter-rouge">max_temp</code> are meaningless constant values.</p>
|
||||
|
||||
<h3><a class="title-link" name="attribute-name" href="#attribute-name"></a> Attribute <code class="highlighter-rouge">name</code></h3>
|
||||
|
||||
|
|
@ -372,7 +394,8 @@ auto operation mode.</p>
|
|||
|
||||
<h3><a class="title-link" name="attribute-is_away_mode_on" href="#attribute-is_away_mode_on"></a> Attribute <code class="highlighter-rouge">is_away_mode_on</code></h3>
|
||||
|
||||
<p>Returns whether the thermostat is in away mode (see the corresponding service for more detail).</p>
|
||||
<p>Returns whether the thermostat is in away mode (see the corresponding
|
||||
service for more detail).</p>
|
||||
|
||||
<h3><a class="title-link" name="attribute-actual-humidity" href="#attribute-actual-humidity"></a> Attribute <code class="highlighter-rouge">actual humidity</code></h3>
|
||||
|
||||
|
|
@ -396,9 +419,11 @@ auto operation mode.</p>
|
|||
<h2><a class="title-link" name="services" href="#services"></a> Services</h2>
|
||||
|
||||
<p>The following services are provided by the Ecobee Thermostat:
|
||||
<code class="highlighter-rouge">set_away_mode</code>, <code class="highlighter-rouge">set_hold_mode</code>, <code class="highlighter-rouge">set_temperature</code>, <code class="highlighter-rouge">set_operation_mode</code>, <code class="highlighter-rouge">fan_min_on_time</code>, <code class="highlighter-rouge">resume_program</code>.</p>
|
||||
|
||||
<p>The services <code class="highlighter-rouge">set_aux_heat</code>, <code class="highlighter-rouge">set_humidity</code>, <code class="highlighter-rouge">set_fan_mode</code>, and <code class="highlighter-rouge">set_swing_mode</code> offered by the <a href="/components/climate/">Climate component</a> are not implemented for this thermostat.</p>
|
||||
<code class="highlighter-rouge">set_away_mode</code>, <code class="highlighter-rouge">set_hold_mode</code>, <code class="highlighter-rouge">set_temperature</code>, <code class="highlighter-rouge">set_operation_mode</code>,
|
||||
<code class="highlighter-rouge">fan_min_on_time</code>, <code class="highlighter-rouge">resume_program</code>.
|
||||
The services <code class="highlighter-rouge">set_aux_heat</code>, <code class="highlighter-rouge">set_humidity</code>, <code class="highlighter-rouge">set_fan_mode</code>, and
|
||||
<code class="highlighter-rouge">set_swing_mode</code> offered by the <a href="/components/climate/">Climate component</a>
|
||||
are not implemented for this thermostat.</p>
|
||||
|
||||
<h3><a class="title-link" name="service-set_away_mode" href="#service-set_away_mode"></a> Service <code class="highlighter-rouge">set_away_mode</code></h3>
|
||||
|
||||
|
|
@ -428,7 +453,10 @@ auto operation mode.</p>
|
|||
|
||||
<h3><a class="title-link" name="service-set_hold_mode" href="#service-set_hold_mode"></a> Service <code class="highlighter-rouge">set_hold_mode</code></h3>
|
||||
|
||||
<p>Puts the thermostat into the given hold mode. For ‘home’ and ‘away’, the target temperature is taken from the home or away, climate, respectively. For ‘temp’, the current temperature is taken as the target temperature. When None is provided as parameter, the hold_mode is turned off.</p>
|
||||
<p>Puts the thermostat into the given hold mode. For ‘home’ and ‘away’, the
|
||||
target temperature is taken from the home or away, climate, respectively.
|
||||
For ‘temp’, the current temperature is taken as the target temperature.
|
||||
When None is provided as parameter, the hold_mode is turned off.</p>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
|
|
@ -488,7 +516,8 @@ auto operation mode.</p>
|
|||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>Only the target temperatures relevant for the current operation mode need to be provided.</p>
|
||||
<p>Only the target temperatures relevant for the current operation mode need to
|
||||
be provided.</p>
|
||||
|
||||
<h3><a class="title-link" name="service-set_operation_mode" href="#service-set_operation_mode"></a> Service <code class="highlighter-rouge">set_operation_mode</code></h3>
|
||||
|
||||
|
|
|
|||
|
|
@ -148,7 +148,7 @@
|
|||
|
||||
<p>You can use V_TEMP to send the current temperature from the node to Home Assistant.</p>
|
||||
|
||||
<p>For more information, visit the <a href="https://www.mysensors.org/download/serial_api_15">serial api</a> of MySensors.</p>
|
||||
<p>For more information, visit the <a href="http://www.mysensors.org/download">serial api</a> of MySensors.</p>
|
||||
|
||||
<h3><a class="title-link" name="example-sketch" href="#example-sketch"></a> Example sketch</h3>
|
||||
|
||||
|
|
@ -262,6 +262,9 @@
|
|||
<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/light.mysensors/'>
|
||||
MySensors Light
|
||||
</a></li>
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@
|
|||
<h2><a class="title-link" name="services" href="#services"></a> Services</h2>
|
||||
|
||||
<h3><a class="title-link" name="climate-control-services" href="#climate-control-services"></a> Climate control services</h3>
|
||||
<p>Available services: <code class="highlighter-rouge">climate.set_aux_heat</code>, <code class="highlighter-rouge">climate.set_away_mode</code>, <code class="highlighter-rouge">climate.set_temperature</code>, <code class="highlighter-rouge">climate.set_humidity</code>, <code class="highlighter-rouge">climate.set_fan_mode</code>, <code class="highlighter-rouge">climate.set_operation_mode</code>, <code class="highlighter-rouge">climate.set_swing_mode</code></p>
|
||||
<p>Available services: <code class="highlighter-rouge">climate.set_aux_heat</code>, <code class="highlighter-rouge">climate.set_away_mode</code>, <code class="highlighter-rouge">climate.set_temperature</code>, <code class="highlighter-rouge">climate.set_humidity</code>, <code class="highlighter-rouge">climate.set_fan_mode</code>, <code class="highlighter-rouge">climate.set_operation_mode</code>, <code class="highlighter-rouge">climate.set_swing_mode</code>, <code class="highlighter-rouge">climate.set_hold_mode</code></p>
|
||||
|
||||
<p class="note">
|
||||
Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking <img src="/images/screenshots/developer-tool-services-icon.png" alt="service developer tool icon" class="no-shadow" height="38" /> <strong>Services</strong>.
|
||||
|
|
@ -151,11 +151,52 @@ Not all climate services may be available for your platform. Be sure to check th
|
|||
|
||||
<h3><a class="title-link" name="service-climateset_away_mode" href="#service-climateset_away_mode"></a> Service <code class="highlighter-rouge">climate.set_away_mode</code></h3>
|
||||
|
||||
<p>This service has been deprecated. Use <code class="highlighter-rouge">climate.set_hold_mode</code> instead.</p>
|
||||
<p>Set away mode for climate device. The away mode changes the target temperature permanently to a temperature
|
||||
reflecting a situation where the climate device is set to save energy. This may be used to emulate a
|
||||
“vacation mode”, for example.</p>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service data attribute</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||||
<td>yes</td>
|
||||
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>’s of climate devices to control. Else targets all.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code class="highlighter-rouge">away_mode</code></td>
|
||||
<td>no</td>
|
||||
<td>New value of away mode.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h4><a class="title-link" name="automation-example" href="#automation-example"></a> Automation example</h4>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">automation</span><span class="pi">:</span>
|
||||
<span class="s">trigger</span><span class="pi">:</span>
|
||||
<span class="s">platform</span><span class="pi">:</span> <span class="s">time</span>
|
||||
<span class="s">after</span><span class="pi">:</span> <span class="s2">"</span><span class="s">07:15:00"</span>
|
||||
<span class="s">action</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">climate.set_away_mode</span>
|
||||
<span class="s">data</span><span class="pi">:</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">climate.kitchen</span>
|
||||
<span class="s">away_mode</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="service-climateset_hold_mode" href="#service-climateset_hold_mode"></a> Service <code class="highlighter-rouge">climate.set_hold_mode</code></h3>
|
||||
|
||||
<p>Set hold mode for climate device</p>
|
||||
<p>Set hold mode for climate device. The hold mode changes the target temperature of the client device temporarily to
|
||||
a different temperature. Typical hold modes provided by a climate device are “away” or “home”, where the hold temperature
|
||||
is chosen depending on a predefined climate, or “temperature” hold, where a particular temperature is selected as the
|
||||
temporary target temperature. The particular modes available depend on the climate device.</p>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
|
|
|
|||
|
|
@ -147,7 +147,7 @@ This component is intended for developers.
|
|||
<a href='/components/http/'>HTTP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ha/'>Home Assistant 0.37</a>
|
||||
<a href='/components/ha/'>Home Assistant 0.38</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
|
|
@ -289,6 +289,9 @@
|
|||
<li><a href='/components/binary_sensor.mysensors/'>
|
||||
MySensors Binary Sensor
|
||||
</a></li>
|
||||
<li><a href='/components/device_tracker.mysensors/'>
|
||||
MySensors Device Tracker
|
||||
</a></li>
|
||||
<li><a href='/components/climate.mysensors/'>
|
||||
MySensors HVAC
|
||||
</a></li>
|
||||
|
|
|
|||
|
|
@ -167,7 +167,7 @@
|
|||
<a href='/components/http/'>HTTP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ha/'>Home Assistant 0.37</a>
|
||||
<a href='/components/ha/'>Home Assistant 0.38</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
|
|
@ -146,6 +146,9 @@
|
|||
<div class='section'>
|
||||
<h1 class="title delta">Category Automation</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/alert/'>Alert</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/automation/'>Automation</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -195,6 +195,9 @@ This device tracker needs telnet to be enabled on the router.
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -198,6 +198,9 @@ This device tracker needs telnet to be enabled on the router.
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -197,6 +197,9 @@ You need to <a href="https://www.asus.com/support/faq/1005449/">enable telnet</a
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -193,6 +193,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -193,6 +193,9 @@ For now and due to third party limitation, the Bbox must be on the same local ne
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -216,6 +216,9 @@ BT LE tracking requires root privileges.
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -181,6 +181,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -180,6 +180,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -220,6 +220,9 @@ If you have a very large number of devices on your VLan (+1000), then you may wa
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -187,6 +187,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -193,6 +193,9 @@ It seems that it is not necessary to use it in current generation Fritz!Box rout
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -215,6 +215,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -208,6 +208,9 @@ You may receive an email from Apple stating that someone has logged into your ac
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -202,6 +202,9 @@ It was tested with a LAPAC1750 AC1750 Dual Band Access Point.</p>
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -188,6 +188,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -200,6 +200,9 @@ Some installations have <a href="https://github.com/openwrt/luci/issues/576">a s
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -225,6 +225,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
397
components/device_tracker.mysensors/index.html
Normal file
397
components/device_tracker.mysensors/index.html
Normal file
|
|
@ -0,0 +1,397 @@
|
|||
<!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 Device Tracker - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions how to use MySensors to track devices in Home Assistant.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/device_tracker.mysensors/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="MySensors Device Tracker">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/device_tracker.mysensors/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions how to use MySensors to track devices in 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 Device Tracker">
|
||||
<meta name="twitter:description" content="Instructions how to use MySensors to track devices in 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">
|
||||
MySensors Device Tracker
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>Integrates MySensors device trackers 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 2.0 and higher</h5>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>S_TYPE</th>
|
||||
<th>V_TYPE</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>S_GPS</td>
|
||||
<td>V_POSITION</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>For more information, visit the <a href="http://www.mysensors.org/download">serial api</a> of MySensors.</p>
|
||||
|
||||
<h3><a class="title-link" name="mysensors-2x-example-sketch" href="#mysensors-2x-example-sketch"></a> MySensors 2.x 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/gps
|
||||
*/</span>
|
||||
|
||||
<span class="c1">// Enable debug prints to serial monitor
|
||||
</span><span class="cp">#define MY_DEBUG
|
||||
</span><span class="c1">// Enable and select radio type attached
|
||||
</span><span class="cp">#define MY_RADIO_NRF24
|
||||
</span><span class="c1">//#define MY_RADIO_RFM69
|
||||
</span>
|
||||
<span class="cp">#include <MySensors.h>
|
||||
</span>
|
||||
<span class="cp">#define SN "GPS Sensor"
|
||||
#define SV "1.0"
|
||||
</span>
|
||||
<span class="c1">// GPS position send interval (in millisectonds)
|
||||
</span><span class="cp">#define GPS_SEND_INTERVAL 30000
|
||||
</span><span class="c1">// The child id used for the gps sensor
|
||||
</span><span class="cp">#define CHILD_ID_GPS 1
|
||||
</span>
|
||||
<span class="n">MyMessage</span> <span class="n">msg</span><span class="p">(</span><span class="n">CHILD_ID_GPS</span><span class="p">,</span> <span class="n">V_POSITION</span><span class="p">);</span>
|
||||
|
||||
<span class="c1">// Last time GPS position was sent to controller
|
||||
</span><span class="kt">unsigned</span> <span class="kt">long</span> <span class="n">lastGPSSent</span> <span class="o">=</span> <span class="o">-</span><span class="mi">31000</span><span class="p">;</span>
|
||||
|
||||
<span class="c1">// Some buffers
|
||||
</span><span class="kt">char</span> <span class="n">latBuf</span><span class="p">[</span><span class="mi">11</span><span class="p">];</span>
|
||||
<span class="kt">char</span> <span class="n">lngBuf</span><span class="p">[</span><span class="mi">11</span><span class="p">];</span>
|
||||
<span class="kt">char</span> <span class="n">altBuf</span><span class="p">[</span><span class="mi">6</span><span class="p">];</span>
|
||||
<span class="kt">char</span> <span class="n">payload</span><span class="p">[</span><span class="mi">30</span><span class="p">];</span>
|
||||
|
||||
<span class="c1">// Dummy values. Implementation of real GPS device is not done.
|
||||
</span><span class="kt">float</span> <span class="n">gpsLocationLat</span> <span class="o">=</span> <span class="mf">40.741895</span><span class="p">;</span>
|
||||
<span class="kt">float</span> <span class="n">gpsLocationLng</span> <span class="o">=</span> <span class="o">-</span><span class="mf">73.989308</span><span class="p">;</span>
|
||||
<span class="kt">float</span> <span class="n">gpsAltitudeMeters</span> <span class="o">=</span> <span class="mf">12.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="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_GPS</span><span class="p">,</span> <span class="n">S_GPS</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="kt">unsigned</span> <span class="kt">long</span> <span class="n">currentTime</span> <span class="o">=</span> <span class="n">millis</span><span class="p">();</span>
|
||||
|
||||
<span class="c1">// Evaluate if it is time to send a new position
|
||||
</span> <span class="kt">bool</span> <span class="n">timeToSend</span> <span class="o">=</span> <span class="n">currentTime</span> <span class="o">-</span> <span class="n">lastGPSSent</span> <span class="o">></span> <span class="n">GPS_SEND_INTERVAL</span><span class="p">;</span>
|
||||
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">timeToSend</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="c1">// Send current gps location
|
||||
</span> <span class="c1">// Build position and altitude string to send
|
||||
</span> <span class="n">dtostrf</span><span class="p">(</span><span class="n">gpsLocationLat</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="n">latBuf</span><span class="p">);</span>
|
||||
<span class="n">dtostrf</span><span class="p">(</span><span class="n">gpsLocationLng</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="n">lngBuf</span><span class="p">);</span>
|
||||
<span class="n">dtostrf</span><span class="p">(</span><span class="n">gpsAltitudeMeters</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">altBuf</span><span class="p">);</span>
|
||||
<span class="n">sprintf</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="s">"%s,%s,%s"</span><span class="p">,</span> <span class="n">latBuf</span><span class="p">,</span> <span class="n">lngBuf</span><span class="p">,</span> <span class="n">altBuf</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">F</span><span class="p">(</span><span class="s">"Position: "</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">payload</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">payload</span><span class="p">));</span>
|
||||
<span class="n">lastGPSSent</span> <span class="o">=</span> <span class="n">currentTime</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/device_tracker.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.38
|
||||
</div>
|
||||
<div class='section'>
|
||||
This is a platform for
|
||||
<a href='/components/device_tracker/'>the Device Tracker 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/climate.mysensors/'>
|
||||
MySensors HVAC
|
||||
</a></li>
|
||||
<li><a href='/components/light.mysensors/'>
|
||||
MySensors Light
|
||||
</a></li>
|
||||
<li><a href='/components/notify.mysensors/'>
|
||||
MySensors Notify
|
||||
</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 Presence Detection</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/device_tracker.asuswrt/'>ASUSWRT</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.actiontec/'>Actiontec</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.aruba/'>Aruba</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.automatic/'>Automatic</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.bbox/'>Bbox</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.bluetooth_le_tracker/'>Bluetooth LE Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.bluetooth_tracker/'>Bluetooth Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.cisco_ios/'>Cisco IOS</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.ddwrt/'>DD-WRT</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.fritz/'>FRITZ!Box</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.gpslogger/'>GPSLogger</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.linksys_ap/'>Linksys Access Points</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.locative/'>Locative</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mqtt/'>MQTT Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
MySensors Device Tracker
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.nmap_tracker/'>Nmap</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.luci/'>OpenWRT (luci)</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.ubus/'>OpenWRT (ubus)</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.owntracks/'>Owntracks</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.ping/'>Ping (ICMP)</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.snmp/'>SNMP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.sky_hub/'>Sky Hub</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.swisscom/'>Swisscom Internet-Box</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.tplink/'>TP-Link</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.tado/'>Tado</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.thomson/'>Thomson</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.trackr/'>TrackR</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.upc_connect/'>UPC ConnectBox</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.unifi/'>Ubiquiti Unifi WAP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.volvooncall/'>Volvo On Call</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.xiaomi/'>Xiaomi Router</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</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>
|
||||
<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>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -191,6 +191,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
Netgear
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -228,6 +228,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -250,6 +250,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -185,6 +185,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -183,6 +183,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -107,6 +107,7 @@ This device tracker needs SNMP to be enabled on the router.
|
|||
<li>pfSense: <code class="highlighter-rouge">1.3.6.1.2.1.4.22.1.2</code> (tested on 2.2.4-RELEASE, need to enable SNMP service)</li>
|
||||
<li>TPLink: <code class="highlighter-rouge">1.3.6.1.2.1.3.1.1.2.19.1</code> (Archer VR2600v, need to enable SNMP service)</li>
|
||||
<li>EdgeRouter <code class="highlighter-rouge">1.3.6.1.2.1.4.22.1.2</code> (EdgeRouter Lite v1.9.0, need to enable SNMP service)</li>
|
||||
<li>Ruckus: <code class="highlighter-rouge">1.3.6.1.4.1.25053.1.2.2.1.1.3.1.1.1.6</code> (Ruckus ZoneDirector, tested on 9.13.3)</li>
|
||||
</ul>
|
||||
|
||||
<p>To use the SNMP version 1 platform in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||||
|
|
@ -227,6 +228,9 @@ This device tracker needs SNMP to be enabled on the router.
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -186,6 +186,9 @@ There are three models of Internet-Box (light, standard and plus). The platform
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -190,6 +190,9 @@ Polling Tado API for presence information will occure at most once every 30 seco
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -186,6 +186,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -194,6 +194,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -208,6 +208,9 @@ TP-Link devices typically only allow one login at a time to the admin console.
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -188,6 +188,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -225,6 +225,9 @@ file
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -188,6 +188,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -184,6 +184,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -185,6 +185,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -187,6 +187,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -278,6 +278,9 @@
|
|||
<li><a href='/components/device_tracker.mqtt/'>
|
||||
MQTT Device Tracker
|
||||
</a></li>
|
||||
<li><a href='/components/device_tracker.mysensors/'>
|
||||
MySensors Device Tracker
|
||||
</a></li>
|
||||
<li><a href='/components/device_tracker.netgear/'>
|
||||
Netgear
|
||||
</a></li>
|
||||
|
|
|
|||
|
|
@ -225,6 +225,9 @@
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -175,7 +175,7 @@ If you see <code class="highlighter-rouge">Not initializing discovery because co
|
|||
<a href='/components/http/'>HTTP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ha/'>Home Assistant 0.37</a>
|
||||
<a href='/components/ha/'>Home Assistant 0.38</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
|
|
@ -265,6 +265,9 @@
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -309,6 +309,9 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -248,6 +248,9 @@
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -187,7 +187,7 @@
|
|||
<a href='/components/http/'>HTTP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ha/'>Home Assistant 0.37</a>
|
||||
<a href='/components/ha/'>Home Assistant 0.38</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
|
|
@ -159,9 +159,6 @@ You need the <code class="highlighter-rouge">ffmpeg</code> binary in your system
|
|||
<div class='section'>
|
||||
<h1 class='title delta'>Related components</h1>
|
||||
<ul class='divided'>
|
||||
<li><a href='/components/binary_sensor.ffmpeg/'>
|
||||
FFmpeg Binary Sensor
|
||||
</a></li>
|
||||
<li><a href='/components/camera.ffmpeg/'>
|
||||
FFmpeg Camera
|
||||
</a></li>
|
||||
|
|
@ -251,6 +248,9 @@ You need the <code class="highlighter-rouge">ffmpeg</code> binary in your system
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -138,7 +138,7 @@
|
|||
<a href='/components/http/'>HTTP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ha/'>Home Assistant 0.37</a>
|
||||
<a href='/components/ha/'>Home Assistant 0.38</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Home Assistant 0.37 - Home Assistant</title>
|
||||
<title>Home Assistant 0.38 - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="">
|
||||
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<link rel="canonical" href="https://home-assistant.io/components/ha/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Home Assistant 0.37">
|
||||
<meta property="og:title" content="Home Assistant 0.38">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/ha/">
|
||||
<meta property="og:type" content="article">
|
||||
|
|
@ -25,7 +25,7 @@
|
|||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:site" content="@home_assistant">
|
||||
|
||||
<meta name="twitter:title" content="Home Assistant 0.37">
|
||||
<meta name="twitter:title" content="Home Assistant 0.38">
|
||||
<meta name="twitter:description" content="">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
|
|
@ -84,7 +84,7 @@
|
|||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Home Assistant 0.37
|
||||
Home Assistant 0.38
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
|
@ -115,7 +115,7 @@
|
|||
<img src='/images/supported_brands/home-assistant.png' />
|
||||
</div>
|
||||
<div class='section'>
|
||||
Introduced in release: 0.37
|
||||
Introduced in release: 0.38
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Category Other</h1>
|
||||
|
|
@ -142,7 +142,7 @@
|
|||
<a href='/components/http/'>HTTP</a>
|
||||
</li>
|
||||
<li>
|
||||
Home Assistant 0.37
|
||||
Home Assistant 0.38
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
|
|
@ -123,6 +123,12 @@
|
|||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>For the default virtual environment of a <a href="/getting-started/installation-raspberry-pi/">Manual installation</a> the command would be as follows.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ln -s /usr/local/lib/python3.4/site-packages/cec /srv/hass/hass_venv/lib/python3.4/site-packages
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p class="note">If after symlinking and adding <code class="highlighter-rouge">hdmi_cec:</code> to your configuration you are getting the following error in your logs,
|
||||
<code class="highlighter-rouge">* failed to open vchiq instance</code> you will also need to add the user account Home Assistant runs under, to the <code class="highlighter-rouge">video</code> group. To add the Home Assistant user account to the <code class="highlighter-rouge">video</code> group, run the following command. <code class="highlighter-rouge">$ usermod -a -G video <hass_user_account></code>
|
||||
</p>
|
||||
|
|
@ -340,6 +346,9 @@ language: ???
|
|||
<div class='section'>
|
||||
<h1 class="title delta">Category Automation</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/alert/'>Alert</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/automation/'>Automation</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -126,7 +126,7 @@ You can manually rename the created entities by using Home Assistants <a href="h
|
|||
<li><strong>username</strong> (<em>Optional</em>): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.</li>
|
||||
<li><strong>password</strong> (<em>Optional</em>): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.</li>
|
||||
<li><strong>primary</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">true</code> when using multiple hosts and this host should provide the services and variables.</li>
|
||||
<li><strong>variables</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">true</code> if you want to use CCU2/Homegear variables. Should only be enabled for the primary host.</li>
|
||||
<li><strong>variables</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">true</code> if you want to use CCU2/Homegear variables. Should only be enabled for the primary host. When using a CCU credentials are required.</li>
|
||||
</ul>
|
||||
|
||||
<h4>Example configuration with multiple protocols and some other options set:</h4>
|
||||
|
|
@ -153,7 +153,7 @@ You can manually rename the created entities by using Home Assistants <a href="h
|
|||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3>The <code class="highlighter-rouge">resolvenames</code> option</h3>
|
||||
<h3><a class="title-link" name="the-resolvenames-option" href="#the-resolvenames-option"></a> The <code class="highlighter-rouge">resolvenames</code> option</h3>
|
||||
|
||||
<p>We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won’t include non-ASCII characters in entity-names.</p>
|
||||
|
||||
|
|
@ -165,19 +165,33 @@ You can manually rename the created entities by using Home Assistants <a href="h
|
|||
|
||||
<p>Resolving names can take some time. So when you start Home Assistant you won’t see you devices at first. For a setup with 20+ devices it can take up to a minute until all devices show up in the UI.</p>
|
||||
|
||||
<h3>Multiple hosts</h3>
|
||||
<h3><a class="title-link" name="multiple-hosts" href="#multiple-hosts"></a> Multiple hosts</h3>
|
||||
|
||||
<p>In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters.<br />
|
||||
Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host.<br />
|
||||
This does <em>not</em> affect the entites in Home Assistant. They all use their own connection and work as expected.</p>
|
||||
|
||||
<h3>Variables</h3>
|
||||
<h3><a class="title-link" name="reading-attributes-of-entities" href="#reading-attributes-of-entities"></a> Reading attributes of entities</h3>
|
||||
|
||||
<p>It is possible to read and set values of system variables you have setup on the CCU/Homegear. An example of how that is done can be found below. The supported types for setting values are float- and bool-variables.<br />
|
||||
Each variable will be available as it’s own entity in the form of <code class="highlighter-rouge">homematic.name</code>. The predefined <code class="highlighter-rouge">homematic.homematic</code> variable has the number of service messages as it’s value. You can use these variable-entities like any other entity in Home Assistant to trigger automations.<br />
|
||||
<p>Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the <a href="https://home-assistant.io/components/sensor.template/">template sensor</a> component. Here’s an example of a template sensor that exposes the valve state of a thermostat.</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><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">template</span>
|
||||
<span class="s">sensors</span><span class="pi">:</span>
|
||||
<span class="s">bedroom_valve</span><span class="pi">:</span>
|
||||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.climate.leq123456.attributes.Valve</span><span class="nv"> </span><span class="s">}}'</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">climate.leq123456</span>
|
||||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Bedroom</span><span class="nv"> </span><span class="s">valve'</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="variables" href="#variables"></a> Variables</h3>
|
||||
|
||||
<p>It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables. <br />
|
||||
The states of the variables are available through the attributes of your hub entity (e.g. <code class="highlighter-rouge">homematic.rf</code>). Use templates (as mentioned above) to make your variables available to automations or as entities.
|
||||
The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed.</p>
|
||||
|
||||
<h3>Events</h3>
|
||||
<h3><a class="title-link" name="events" href="#events"></a> Events</h3>
|
||||
|
||||
<p>When HomeMatic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available:</p>
|
||||
|
||||
|
|
@ -186,7 +200,7 @@ The values of variables are polled from the CCU/Homegear in an interval of 30 se
|
|||
<li><strong>homematic.impulse</strong>: For impulse sensors</li>
|
||||
</ul>
|
||||
|
||||
<h4>Devices with buttons</h4>
|
||||
<h4><a class="title-link" name="devices-with-buttons" href="#devices-with-buttons"></a> Devices with buttons</h4>
|
||||
|
||||
<p>Devices with buttons (e.g. HM-Sen-MDIR-WM55, remote controls) may not be fully visible in the UI. This is intended, as buttons don’t serve any value here and all they do is trigger events.
|
||||
As an example:
|
||||
|
|
@ -211,7 +225,7 @@ The HM-Sen-MDIR-WM55 motion detector will be displayed as 2 entities. A motion s
|
|||
<p>The channel parameter is equal to the channel of the button you are configuring the automation for. You can view the available channels in the UI you use to pair your devices.
|
||||
The name depends on if you chose to resolve names or not. If not, it will be the device ID (e.g. LEQ1234657). If you chose to resolve names (and that is successful), it will be the name you have set in your CCU or in the metadata (e.g. “Kitchen Switch”).</p>
|
||||
|
||||
<h3>Services</h3>
|
||||
<h3><a class="title-link" name="services" href="#services"></a> Services</h3>
|
||||
|
||||
<ul>
|
||||
<li><em>homematic.virtualkey</em>: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys.</li>
|
||||
|
|
@ -220,7 +234,7 @@ The name depends on if you chose to resolve names or not. If not, it will be the
|
|||
<li><em>homematic.set_dev_value</em>: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC.</li>
|
||||
</ul>
|
||||
|
||||
<h4>Examples</h4>
|
||||
<h4><a class="title-link" name="examples" href="#examples"></a> Examples</h4>
|
||||
<p>Simulate a button being pressed</p>
|
||||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="nn">...</span>
|
||||
<span class="s">action</span><span class="pi">:</span>
|
||||
|
|
@ -243,17 +257,18 @@ The name depends on if you chose to resolve names or not. If not, it will be the
|
|||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Set variable</p>
|
||||
<p>Set boolean variable to true</p>
|
||||
<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">homematic.set_var_value</span>
|
||||
<span class="s">data</span><span class="pi">:</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">homematic.varname_bool</span>
|
||||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">homematic.rf</span>
|
||||
<span class="s">name</span><span class="pi">:</span> <span class="s">Variablename</span>
|
||||
<span class="s">value</span><span class="pi">:</span> <span class="s">true</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4>Advanced examples</h4>
|
||||
<h4><a class="title-link" name="advanced-examples" href="#advanced-examples"></a> Advanced examples</h4>
|
||||
|
||||
<p>If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented.<br />
|
||||
Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above <code class="highlighter-rouge">rf</code>, <code class="highlighter-rouge">wired</code> and <code class="highlighter-rouge">ip</code> would be valid values.</p>
|
||||
|
|
@ -408,6 +423,9 @@ Using this service provides you direct access to the setValue-method of the prim
|
|||
<li>
|
||||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/rflink/'>Rflink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/scsgate/'>SCSGate</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -218,7 +218,7 @@ Please note, that sources from <code class="highlighter-rouge">trusted_networks<
|
|||
HTTP
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/ha/'>Home Assistant 0.37</a>
|
||||
<a href='/components/ha/'>Home Assistant 0.38</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/introduction/'>Introduction</a>
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue