293 lines
No EOL
12 KiB
HTML
293 lines
No EOL
12 KiB
HTML
<!doctype html>
|
|
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Command line Binary Sensor - Home Assistant</title>
|
|
<meta name="author" content="Paulus Schoutsen">
|
|
<meta name="description" content="Instructions how to integrate Command binary sensors within Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.command_line/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Command line Binary Sensor">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.command_line/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate Command binary sensors within Home Assistant.">
|
|
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
|
|
|
<meta name="twitter:card" content="summary">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
|
|
<meta name="twitter:title" content="Command line Binary Sensor">
|
|
<meta name="twitter:description" content="Instructions how to integrate Command binary sensors within Home Assistant.">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
|
|
|
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
|
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
|
|
<body >
|
|
|
|
<header>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
|
|
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/demo/favicon-192x192.png'>
|
|
<span>Home Assistant</span>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
|
<nav>
|
|
<input type="checkbox" id="toggle">
|
|
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
|
<ul class="menu pull-right">
|
|
<li>
|
|
<a>Getting started <i class="icon icon-caret-down"></i></a>
|
|
<ul>
|
|
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
|
|
<li><a href='/getting-started/configuration/'>Configuration Basics</a></li>
|
|
<li><a href='/getting-started/devices/'>Adding devices</a></li>
|
|
<li><a href='/getting-started/presence-detection/'>Presence Detection</a></li>
|
|
<li><a href='/getting-started/automation/'>Automation</a></li>
|
|
<li><a href='/topics/'>Advanced Topics</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href='/components/'>Components</a></li>
|
|
<li><a href='/cookbook/'>Examples</a></li>
|
|
<li><a 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">
|
|
Command Line Binary Sensor
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>The <code>command</code> binary sensor platform issues specific commands to get data.</p>
|
|
|
|
<p>To use your Command binary sensor in your installation, add the following to your <code>configuration.yaml</code> file:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
|
<span class="key">binary_sensor</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">command_line</span></span>
|
|
<span class="key">command</span>: <span class="string"><span class="content">cat /proc/sys/net/ipv4/ip_forward</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">'IP4 forwarding'</span></span>
|
|
<span class="key">payload_on</span>: <span class="string"><span class="delimiter">"</span><span class="content">1</span><span class="delimiter">"</span></span>
|
|
<span class="key">payload_off</span>: <span class="string"><span class="delimiter">"</span><span class="content">0</span><span class="delimiter">"</span></span>
|
|
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value.x }}'</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Configuration variables:</p>
|
|
|
|
<ul>
|
|
<li><strong>command</strong> (<em>Required</em>): The action to take to get the value.</li>
|
|
<li><strong>name</strong> (<em>Optional</em>): Let you overwrite the the name of the device. By default <em>name</em> from the device is used.</li>
|
|
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents enabled state. Default is “ON”.</li>
|
|
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents disabled state. Default is “OFF”.</li>
|
|
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract a value from the payload.</li>
|
|
</ul>
|
|
|
|
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
|
|
|
<p>In this section you find some real life examples of how to use this sensor.</p>
|
|
|
|
<h3><a class="title-link" name="sickrage" href="#sickrage"></a> SickRage</h3>
|
|
|
|
<p>Check the state of an <a href="https://github.com/sickragetv/sickrage">SickRage</a> instance.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
|
<span class="key">binary_sensor</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">command_line</span></span>
|
|
<span class="key">command</span>: <span class="string"><span class="content">netstat -na | find "33322" | find /c "LISTENING" > nul && (echo "Running") || (echo "Not running")</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">'sickragerunning'</span></span>
|
|
<span class="key">payload_on</span>: <span class="string"><span class="delimiter">"</span><span class="content">Running</span><span class="delimiter">"</span></span>
|
|
<span class="key">payload_off</span>: <span class="string"><span class="delimiter">"</span><span class="content">Not running</span><span class="delimiter">"</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h3><a class="title-link" name="check-rasplex" href="#check-rasplex"></a> Check RasPlex</h3>
|
|
|
|
<p>Check if <a href="http://www.rasplex.com/">RasPlex</a> is <code>online</code>.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="key">binary_sensor</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">command_line</span></span>
|
|
<span class="key">command</span>: <span class="string"><span class="content">'ping -c 1 rasplex.local | grep "1 received" | wc -l'</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">'is_rasplex_online'</span></span>
|
|
<span class="key">payload_on</span>: <span class="string"><span class="content">1</span></span>
|
|
<span class="key">payload_off</span>: <span class="string"><span class="content">0</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>An alternative solution could look like this:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="key">binary_sensor</span>:
|
|
<span class="key">platform</span>: <span class="string"><span class="content">command_line</span></span>
|
|
<span class="key">name</span>: <span class="string"><span class="content">Printer</span></span>
|
|
<span class="key">command</span>: <span class="string"><span class="content">ping -c 1 192.168.1.10 &> /dev/null && echo success || echo fail</span></span>
|
|
<span class="key">payload_on</span>: <span class="string"><span class="delimiter">"</span><span class="content">success</span><span class="delimiter">"</span></span>
|
|
<span class="key">payload_off</span>: <span class="string"><span class="delimiter">"</span><span class="content">fail</span><span class="delimiter">"</span></span>
|
|
</pre></div>
|
|
</div>
|
|
</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='brand-logo-container section'>
|
|
<img src='/images/supported_brands/command_line.png' />
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class='title delta'>Related components</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/notify.command_line/'>
|
|
Command line Notify
|
|
</a></li>
|
|
<li><a href='/components/rollershutter.command_line/'>
|
|
Command line Rollershutter
|
|
</a></li>
|
|
<li><a href='/components/sensor.command_line/'>
|
|
Command line Sensor
|
|
</a></li>
|
|
<li><a href='/components/switch.command_line/'>
|
|
Command line Switch
|
|
</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.bloomsky/'>BloomSky Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
Command line Binary Sensor
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.mqtt/'>MQTT 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.rest/'>RESTful 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.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://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
|
|
|
<div class="credit">
|
|
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
|
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
<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> |