242 lines
16 KiB
HTML
242 lines
16 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>TellStick - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Telldus TellStick service enabler and tools.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/addons/tellstick/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="TellStick">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/addons/tellstick/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Telldus TellStick service enabler and tools.">
|
||
<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="TellStick">
|
||
<meta name="twitter:description" content="Telldus TellStick service enabler and tools.">
|
||
<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/_addons/tellstick.markdown'>Edit this page on GitHub</a></div>
|
||
<header>
|
||
<h1 class="title indent">
|
||
TellStick
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>Setting up the <a href="http://telldus.com">Tellstick</a> service and tools contained in the <a href="http://developer.telldus.com/">telldus-core</a> package and adding configuration to enable Tellstick and Tellstick Duo to work on your Hass.io.</p>
|
||
<p>To use this add-on, you first install it from the list of Built-in add-ons in Hass.io.
|
||
After installation you are presented with a default and example configuration, to alter this you must follow both the JSON format and also be aligned with the <a href="https://developer.telldus.com/wiki/TellStick_conf">valid parameters for Tellstick configuration file (tellstick.conf)</a>.</p>
|
||
<p>After any changes have been made to the configuration, you need to restart the add-on for the changes to take effect.</p>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>id</strong> (<em>Required</em>): A number and must be unique for each device.</li>
|
||
<li><strong>name</strong> (<em>Required</em>): A name for easy identification of the device.</li>
|
||
<li><strong>protocol</strong> (<em>Required</em>): This is the protocol the device uses. More on the different protocols later down.</li>
|
||
<li><strong>model</strong> (<em>Optional</em>): The model parameter is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus self-learning, etc.</li>
|
||
<li><strong>house</strong> (<em>Optional</em>): Depending on protocol the values here can vary a lot to identify or group per house or type.</li>
|
||
<li><strong>unit</strong> (<em>Optional</em>): Unit identifier, in most cases a value between 1 to 16 and often used in combination with the house.</li>
|
||
<li><strong>fade</strong> (<em>Optional</em>): Fade is either <code class="highlighter-rouge">true</code> or <code class="highlighter-rouge">false</code> and tells a dimmer if it should fade smooth or instant between values (only for IKEA protocol as it seems).</li>
|
||
<li><strong>code</strong> (<em>Optional</em>): A number series based on ones and zeroes often used for dip-switch based devices.</li>
|
||
</ul>
|
||
<p>You will need to add internal communication details to <code class="highlighter-rouge">configuration.yaml</code> to enable the integration from Hass.io and the add-on.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
|
||
<span class="s">tellstick</span><span class="pi">:</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">core-tellstick</span>
|
||
<span class="s">port</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">50800</span><span class="pi">,</span> <span class="nv">50801</span><span class="pi">]</span>
|
||
|
||
</code></pre>
|
||
</div>
|
||
<p>To add <a href="https://home-assistant.io/components/light.tellstick/">lights</a>, <a href="https://home-assistant.io/components/sensor.tellstick/">sensors</a> and <a href="https://home-assistant.io/components/switch.tellstick/">switches</a> you follow the guidelines for each type individually that is <a href="https://home-assistant.io/components/tellstick/">described for Home Assistant</a></p>
|
||
<p>The add-on will also enable you to interact with the <code class="highlighter-rouge">tdtool</code> via a Home Assistant services call, see example below for self-learning device.</p>
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
<p>Example for adding more devices in the add-on configuration (note the comma separator between devices):</p>
|
||
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nt">"devices"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Outdoor light"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"protocol"</span><span class="p">:</span><span class="w"> </span><span class="s2">"everflourish"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"model"</span><span class="p">:</span><span class="w"> </span><span class="s2">"selflearning-switch"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"house"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hallway dimmer"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"protocol"</span><span class="p">:</span><span class="w"> </span><span class="s2">"risingsun"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"model"</span><span class="p">:</span><span class="w"> </span><span class="s2">"selflearning-dimmer"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"house"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">]</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
</div>
|
||
<h2>Service calls</h2>
|
||
<p>If you wish to teach a selflearning device in your TellStick configuration:</p>
|
||
<p>Go to Home Assistant <a href="http://hassio.local:8123/dev-service">service call</a> in Developer tools and select.</p>
|
||
<ul>
|
||
<li>Service: <code class="highlighter-rouge">hassio.addon_stdin</code></li>
|
||
<li>Enter service Data:
|
||
<code class="highlighter-rouge"><span class="p">{</span><span class="nt">"addon"</span><span class="p">:</span><span class="s2">"core_tellstick"</span><span class="p">,</span><span class="nt">"input"</span><span class="p">:{</span><span class="nt">"function"</span><span class="p">:</span><span class="s2">"learn"</span><span class="p">,</span><span class="nt">"device"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">}}</span></code></li>
|
||
</ul>
|
||
<p>Replace <code class="highlighter-rouge">1</code> with the corresponding ID of the device in your TellStick configuration.</p>
|
||
<p>You can also use this to list devices or sensors and read the output in the add-on log:
|
||
<code class="highlighter-rouge"><span class="p">{</span><span class="nt">"addon"</span><span class="p">:</span><span class="s2">"core_tellstick"</span><span class="p">,</span><span class="nt">"input"</span><span class="p">:{</span><span class="nt">"function"</span><span class="p">:</span><span class="s2">"list-sensors"</span><span class="p">}}</span></code></p>
|
||
<h4>Supported service commands</h4>
|
||
<ul>
|
||
<li>
|
||
<p><code class="highlighter-rouge">"function":"list"</code>: List currently configured devices with name and device id and all discovered sensors.</p>
|
||
</li>
|
||
<li><code class="highlighter-rouge">"function":"list-sensors"</code></li>
|
||
<li>
|
||
<p><code class="highlighter-rouge">"function":"list-devices"</code>: Alternative devices/sensors listing: Shows devices and/or sensors using key=value format (with tabs as separators, one device/sensor per line, no header lines.)</p>
|
||
</li>
|
||
<li>
|
||
<p><code class="highlighter-rouge">"function":"on","device":"x"</code>: Turns on device. ’x’ could either be an integer of the device-id, or the name of the device.</p>
|
||
</li>
|
||
<li>
|
||
<p><code class="highlighter-rouge">"function":"off","device":"x"</code>: Turns off device. ’x’ could either be an integer of the device-id, or the name of the device.</p>
|
||
</li>
|
||
<li>
|
||
<p><code class="highlighter-rouge">"function":"bell","device":"x"</code>: Sends bell command to devices supporting this. ’x’ could either be an integer of the device-id, or the name of the device.</p>
|
||
</li>
|
||
<li><code class="highlighter-rouge">"function":"learn","device":"x"</code>: Sends a special learn command to devices supporting this. This is normally devices of ’selflearning’ type. ’x’ could either be an integer of the device-id, or the name of the device.</li>
|
||
</ul>
|
||
</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 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>
|