home-assistant.github.io/components/remote.itach/index.html
2017-11-20 19:38:22 +00:00

213 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>iTach Remote - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate a Global Caché iTach IP2IR gateway into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/remote.itach/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="iTach Remote">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/remote.itach/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate a Global Caché iTach IP2IR gateway into 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="iTach Remote">
<meta name="twitter:description" content="Instructions on how to integrate a Global Caché iTach IP2IR gateway into 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">
<header>
<h1 class="title indent">
iTach Remote
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">itach</code> remote platform allows you to control IR devices with a <a href="https://www.globalcache.com/products/itach/ip2irspecs">Global Caché iTach Device</a> and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page.</p>
<p>In order to utilize the digital input (binary sensor) and relay (switch) features of your Global Cache device you will need to use the <a href="https://home-assistant.io/components/gc100">gc100 component</a> and associated platforms.</p>
<p>To use your iTach remote in your installation, you will need to know the IR commands for your devices in Pronto hex format and 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">remote</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">itach</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Living Room</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">itach023fdc</span>
<span class="s">devices</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">TV</span>
<span class="s">connaddr</span><span class="pi">:</span> <span class="s">2</span>
<span class="s">commands</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ON"</span>
<span class="s">data</span><span class="pi">:</span> <span class="s2">"</span><span class="s">0000</span><span class="nv"> </span><span class="s">006D</span><span class="nv"> </span><span class="s">0000</span><span class="nv"> </span><span class="s">0022</span><span class="nv"> </span><span class="s">00AC</span><span class="nv"> </span><span class="s">00AC</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0689"</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">OFF"</span>
<span class="s">data</span><span class="pi">:</span> <span class="s2">"</span><span class="s">0000</span><span class="nv"> </span><span class="s">006D</span><span class="nv"> </span><span class="s">0000</span><span class="nv"> </span><span class="s">0022</span><span class="nv"> </span><span class="s">00AC</span><span class="nv"> </span><span class="s">00AC</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0689"</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The iTachs name to display in the front end.</li>
<li><strong>host</strong> (<em>Required</em>): The iTachs IP address.</li>
<li><strong>port</strong> (<em>Optional</em>): The iTachs port. 4998 is default.</li>
<li><strong>devices</strong> array (<em>Required</em>): Devices controlled by the iTach.
<ul>
<li><strong>name</strong> (<em>Required</em>): Name of the device.</li>
<li><strong>modaddr</strong> (<em>Optional</em>): iTach module address for the IR emitter. 1 is default.</li>
<li><strong>connaddr</strong> (<em>Required</em>): iTach connection location for the IR emitter. (Note connaddr is a misleading label. Do not put the connection address here. Technically the connection address is the combination of the module address plus the connection location).</li>
<li><strong>commands</strong> array (<em>Required</em>): Commands available to send to the device.
<ul>
<li><strong>name</strong> (<em>Required</em>): Command name.</li>
<li><strong>data</strong> (<em>Required</em>): Hex command data.</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>An example to call the component from developer tools using the <code class="highlighter-rouge">remote.send_command</code> service: <code class="highlighter-rouge"><span class="p">{</span><span class="w"> </span><span class="nt">"entity_id"</span><span class="p">:</span><span class="s2">"remote.tv"</span><span class="p">,</span><span class="w"> </span><span class="nt">"command"</span><span class="p">:</span><span class="s2">"menu"</span><span class="w"> </span><span class="p">}</span></code></p>
<p>Note: Global Cache devices expect data in their own format of “sendir…”. This component converts hex code to Global Cache IR form.</p>
<p>API Docs:</p>
<ul>
<li><a href="https://www.globalcache.com/files/docs/API-iTach.pdf">iTach</a></li>
<li><a href="http://www.globalcache.com/files/docs/API-GC-100.pdf">GC-100</a></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='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/remote.itach.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/globalcache.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>: Assumed State
</div>
<div class='section'>
Introduced in release: 0.39
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/remote/itach.py'>remote/itach.py</a>
</div>
<div class='section'>
This is a platform for
<a href='/components/remote/'>the Remotes component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Remote</h1>
<ul class='divided'>
<li>
<a href='/components/remote.apple_tv/'>Apple TV Remote</a>
</li>
<li>
<a href='/components/remote.harmony/'>Harmony Hub Remote</a>
</li>
<li>
<a href='/components/remote.kira/'>Kira Remote</a>
</li>
<li>
iTach Remote
</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>