jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/hassio/run_local/index.html
Travis CI 4968d5674f Site updated at 2017-05-24 16:34:01 UTC
2017-05-24 16:34:01 +00:00

206 lines
14 KiB
HTML
Raw Blame History

<!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 script - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how-to run 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 script">
<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 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 script">
<meta name="twitter:description" content="Instructions on how-to run 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" 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="/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>
</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">
<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 Script
</h1>
</header>
<hr class="divider">
<p>On a normal Home Assistant installation you have access to the base machine and can install or add scripts that you can call with a <code class="highlighter-rouge">command_line</code> sensor/switch. Since Hass.IO uses Docker, you can not use this old way to perform local stuff. On its face, it looks quite restrictive, but it makes the whole system stable.</p>
<p>However, if you need to run a script to read data for a sensor or send commands to other devices on Hass.IO, you can do that with a add-on or on inside the Home Assistant container with a custom component. Here is one way to accomplish that using an add-on. For custom component, look at the <a href="/developers/component_loading/">devoloper site</a> and also read the <a href="/hassio/addon_tutorial/">add-ons tutorial</a>. Now you can get started with your custom component in the right way.</p>
<p>First you need install a MQTT broker. You can use our <a href="/addons/mosquitto/">MQTT broker add-on</a>. Make sure you use logins and disable anonymous access if you want to secure the system. We provide no Hass.IO way to exchange data, that will be not realy good for security and is also to slow to exchange data between containers or stop and go stuff. That is the reason why we use a mqtt broker for it.</p>
<h3><a class="title-link" name="sensors" href="#sensors"></a> Sensors</h3>
<p>Short story of that caption: We loop in our script to fetch data and push it to MQTT and wait until 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 tzdata 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>Short story of that caption: We wait for incoming data from 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 tzdata 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> &lt; &lt;<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>
<li><a href='/hassio/external_storage/'>External storage </a></li>
<li><a class='active' href='/hassio/run_local/'>Execute local things </a></li>
<li><a href='/hassio/architecture/'>Architecture </a></li>
</ul>
</li>
</ul>
<ul class='divided sidebar-menu'>
<li>
<a href='/hassio/addon_development/'>Add-on Development </a>
<ul>
<li><a href='/hassio/addon_tutorial/'>Tutorial: Making your first add-on </a></li>
<li><a href='/hassio/addon_config/'>Configuration </a></li>
<li><a href='/hassio/addon_testing/'>Local Testing </a></li>
<li><a href='/hassio/addon_publishing/'>Publishing </a></li>
<li><a href='/hassio/addon_repository/'>Repositories </a></li>
</ul>
</li>
<li><a href='/hassio/debugging/'>Debugging Hass.io </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>
</body>
</html>
Reference in a new issue View git blame Copy permalink