232 lines
15 KiB
HTML
232 lines
15 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>Run local scripts - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to run a local script for Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/hassio/run_local/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Run local scripts">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/hassio/run_local/">
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:description" content="Instructions on how to run a local script for 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="Run local scripts">
|
||
<meta name="twitter:description" content="Instructions on how to run a local script for Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/hassio/run_local.markdown'>Edit this page on GitHub</a></div>
|
||
<header>
|
||
<h1 class="title indent">
|
||
Run local scripts
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>Hass.io is a managed environment, which means that you can’t install applications that can be embedded into Home Assistant using the <code class="highlighter-rouge">command_line</code> sensor/switch.</p>
|
||
<p>There are three options if you need to run a script to read data from a sensor or send commands to other devices on Hass.io.</p>
|
||
<p>The first option is to write a custom component for Home Assistant. Using Python, you can communicate with your device. For more information about developing a custom component, take a look at the <a href="/developers/component_loading/">developer documentation</a>.</p>
|
||
<p>The second option is to use STDIN inside add-on and use the service <code class="highlighter-rouge">hassio.addon_stdin</code> to send data. More about this options look into <a href="/developers/hassio/addon_communication/">developer documentation</a> for internal add-on communication. There is also describe how do you can easy access to Home-Assistant Rest API.</p>
|
||
<p>The third option is to make a local add-on for Hass.io that sends the data to Home Assistant via MQTT. Before we dive into this, read up on <a href="/developers/hassio/addon_tutorial/">Hass.io add-on development</a> first.</p>
|
||
<p>For security and speed, Hass.io does not provide a way for containers to communicate directly. So the first step is to set up a communication channel. We’re going to use MQTT for this using the <a href="/addons/mosquitto/">MQTT broker add-on</a>.</p>
|
||
<h3><a class="title-link" name="sensors" href="#sensors"></a> Sensors</h3>
|
||
<p>We loop in our script to fetch data and push it to MQTT and wait until the next process is ready. Here is a basic example and structure for that process.</p>
|
||
<p>Our Dockerfile need to install:</p>
|
||
<div class="highlighter-rouge"><pre class="highlight"><code>RUN apk --no-cache add jq mosquitto-clients
|
||
</code></pre>
|
||
</div>
|
||
<p>Now we can process it with <code class="highlighter-rouge">run.sh</code>:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c">#!/bin/bash</span>
|
||
<span class="nb">set</span> -e
|
||
|
||
<span class="nv">CONFIG_PATH</span><span class="o">=</span>/data/options.json
|
||
|
||
<span class="c"># possible options for processing</span>
|
||
<span class="nv">MQTT_SERVER</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.server'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">MQTT_PORT</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.port'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">TOPIC</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.topic'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">USER</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.user'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">PASSWORD</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.password'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">WAIT_TIME</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.seconds'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
|
||
<span class="c"># read data</span>
|
||
<span class="k">while </span><span class="nb">true
|
||
</span><span class="k">do
|
||
if </span><span class="nv">OUTPUT</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>/read_my_sensor.sh<span class="k">)</span><span class="s2">"</span>
|
||
<span class="k">then
|
||
</span>mosquitto_pub -h <span class="s2">"</span><span class="nv">$MQTT_SERVER</span><span class="s2">"</span> -p <span class="s2">"</span><span class="nv">$MQTT_PORT</span><span class="s2">"</span> -u <span class="s2">"</span><span class="nv">$USER</span><span class="s2">"</span> -P <span class="s2">"</span><span class="nv">$PASSWORD</span><span class="s2">"</span> -t <span class="s2">"</span><span class="nv">$TOPIC</span><span class="s2">"</span> -m <span class="s2">"</span><span class="nv">$OUTPUT</span><span class="s2">"</span> <span class="o">||</span> <span class="nb">true
|
||
</span><span class="k">else
|
||
</span><span class="nb">echo</span> <span class="s2">"</span><span class="k">$(</span>data<span class="k">)</span><span class="s2"> [ERROR] can't read sensor: </span><span class="nv">$OUTPUT</span><span class="s2">"</span>
|
||
<span class="k">fi
|
||
|
||
</span>sleep <span class="s2">"</span><span class="nv">$WAIT_TIME</span><span class="s2">"</span>
|
||
<span class="k">done</span>
|
||
</code></pre>
|
||
</div>
|
||
<h3><a class="title-link" name="commands" href="#commands"></a> Commands</h3>
|
||
<p>We wait for incoming data from the MQTT broker. We can also use an <code class="highlighter-rouge">input_boolean</code> that triggers an automation to publish a custom command to MQTT topic that can process multiple things in one add-on.</p>
|
||
<p>Our Dockerfile need to install:</p>
|
||
<div class="highlighter-rouge"><pre class="highlight"><code>RUN apk --no-cache add jq mosquitto-clients
|
||
</code></pre>
|
||
</div>
|
||
<p>Now we can process it with <code class="highlighter-rouge">run.sh</code>:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c">#!/bin/bash</span>
|
||
<span class="nb">set</span> -e
|
||
|
||
<span class="nv">CONFIG_PATH</span><span class="o">=</span>/data/options.json
|
||
|
||
<span class="c"># possible options for processing</span>
|
||
<span class="nv">MQTT_SERVER</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.server'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">MQTT_PORT</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.port'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">TOPIC</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.topic'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">USER</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.user'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
<span class="nv">PASSWORD</span><span class="o">=</span><span class="k">$(</span>jq --raw-output <span class="s1">'.password'</span> <span class="nv">$CONFIG_PATH</span><span class="k">)</span>
|
||
|
||
<span class="c"># read data</span>
|
||
<span class="k">while </span><span class="nb">read</span> -r message
|
||
<span class="k">do
|
||
if</span> <span class="o">[</span> <span class="s2">"</span><span class="nv">$message</span><span class="s2">"</span> <span class="o">==</span> <span class="s2">"on"</span> <span class="o">]</span>; <span class="k">then</span>
|
||
/do_command_on.sh <span class="o">||</span> <span class="nb">true
|
||
</span><span class="k">else</span>
|
||
/do_command_off.sh <span class="o">||</span> <span class="nb">true
|
||
</span><span class="k">fi
|
||
|
||
done</span> < <<span class="o">(</span>mosquitto_sub -h <span class="s2">"</span><span class="nv">$MQTT_SERVER</span><span class="s2">"</span> -p <span class="s2">"</span><span class="nv">$MQTT_PORT</span><span class="s2">"</span> -u <span class="s2">"</span><span class="nv">$USER</span><span class="s2">"</span> -P <span class="s2">"</span><span class="nv">$PASSWORD</span><span class="s2">"</span> -t <span class="s2">"</span><span class="nv">$TOPIC</span><span class="s2">"</span> -q 1<span class="o">)</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='section'>
|
||
<h1 class="title delta">Topics</h1>
|
||
<ul class='divided sidebar-menu'>
|
||
<li>
|
||
<a href='/hassio/'>Hass.io </a>
|
||
<ul>
|
||
<li><a href='/hassio/installation/'>Installation </a></li>
|
||
<li><a href='/addons/'>Available add-ons </a></li>
|
||
<li><a href='/hassio/installing_third_party_addons/'>Installing third-party add-ons </a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class='divided sidebar-menu'>
|
||
<li>
|
||
Advanced
|
||
<ul>
|
||
<li><a href='/hassio/zwave/'>Z-Wave </a></li>
|
||
<li><a href='/hassio/external_storage/'>External storage </a></li>
|
||
<li><a class='active' href='/hassio/run_local/'>Execute local things </a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class='divided sidebar-menu'>
|
||
<li><a href='/developers/hassio/addon_development/'>Looking to create an add-on?</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|