jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/kira/index.html
Travis CI 933563f0be Site updated at 2017-06-17 20:00:42 UTC
2017-06-17 20:00:42 +00:00

371 lines
24 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>Kira - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Keene Electronics IR over IP modules (Kira) into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/kira/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Kira">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/kira/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Keene Electronics IR over IP modules (Kira) 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="Kira">
<meta name="twitter:description" content="Instructions how to integrate Keene Electronics IR over IP modules (Kira) into 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">
<header>
<h1 class="title indent">
Kira
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">kira</code> component is the main component to integrate Keene Electronics IR over IP <a href="https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html">Kira</a> modules with Home Assistant.</p>
<h3><a class="title-link" name="example-configuration" href="#example-configuration"></a> Example Configuration</h3>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">kira</span><span class="pi">:</span>
</code></pre>
</div>
<p>Kira modules have no built-in mechanism for auto-discovery, so will need to be configured to send packets to Home Assistant. Documentation for this can be found on the manufacturer’s website <a href="https://www.keene.co.uk/pages/iranywhere/index.html">Here</a>.</p>
<h3><a class="title-link" name="configuration-options" href="#configuration-options"></a> Configuration Options</h3>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">kira</span><span class="pi">:</span>
<span class="s">sensors</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">kira_sensor</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">0.0.0.0</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">65432</span>
<span class="s">remotes</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">kira_remote</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.100.1</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">65432</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>sensors</strong> (<em>Optional</em>): Kira sensors to register
<ul>
<li><strong>name</strong> (<em>Optional</em>): Name of this sensor.</li>
<li><strong>host</strong> (<em>Optional</em>): Bind address for this sensor. 0.0.0.0 is default.</li>
<li><strong>port</strong> (<em>Optional</em>): UDP port to listen for packets on. 65432 is default.</li>
</ul>
</li>
<li><strong>remotes</strong> (<em>Optional</em>): Remote Kira modules to register
<ul>
<li><strong>name</strong> (<em>Optional</em>): Name of this remote.</li>
<li><strong>host</strong> (<em>Required</em>): IP address of Kira module to send commands to.</li>
<li><strong>port</strong> (<em>Optional</em>): UDP port to send packets to. 65432 is default.</li>
</ul>
</li>
</ul>
<p>If no sensors or remotes are specified, a sensor with default values will be added.</p>
<h3><a class="title-link" name="code-configuration" href="#code-configuration"></a> Code Configuration</h3>
<p>The first time the Kira component is loaded, <code class="highlighter-rouge">kira_codes.yaml</code> will be created in the Home Assistant configuration directory.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example kira_codes.yaml entry</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">LivingRoomTVOn</span>
<span class="s">code</span><span class="pi">:</span> <span class="s2">"</span><span class="s">K</span><span class="nv"> </span><span class="s">2322</span><span class="nv"> </span><span class="s">228A</span><span class="nv"> </span><span class="s">1126</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0227</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0207</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0658</span><span class="nv"> </span><span class="s">025D</span><span class="nv"> </span><span class="s">0207</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0227</span><span class="nv"> </span><span class="s">0220</span><span class="nv"> </span><span class="s">0227</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0222</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0222</span><span class="nv"> </span><span class="s">0220</span><span class="nv"> </span><span class="s">067D</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0658</span><span class="nv"> </span><span class="s">0222</span><span class="nv"> </span><span class="s">0227</span><span class="nv"> </span><span class="s">025C</span><span class="nv"> </span><span class="s">0640</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0658</span><span class="nv"> </span><span class="s">025D</span><span class="nv"> </span><span class="s">0640</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0658</span><span class="nv"> </span><span class="s">025D</span><span class="nv"> </span><span class="s">0640</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0222</span><span class="nv"> </span><span class="s">025C</span><span class="nv"> </span><span class="s">0207</span><span class="nv"> </span><span class="s">0222</span><span class="nv"> </span><span class="s">0678</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0207</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0227</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">0222</span><span class="nv"> </span><span class="s">025C</span><span class="nv"> </span><span class="s">063B</span><span class="nv"> </span><span class="s">025C</span><span class="nv"> </span><span class="s">0640</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0660</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0658</span><span class="nv"> </span><span class="s">025D</span><span class="nv"> </span><span class="s">0207</span><span class="nv"> </span><span class="s">0222</span><span class="nv"> </span><span class="s">0678</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0660</span><span class="nv"> </span><span class="s">0220</span><span class="nv"> </span><span class="s">0678</span><span class="nv"> </span><span class="s">023E</span><span class="nv"> </span><span class="s">0202</span><span class="nv"> </span><span class="s">025D</span><span class="nv"> </span><span class="s">0207</span><span class="nv"> </span><span class="s">023F</span><span class="nv"> </span><span class="s">2000"</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">kira</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">HDMI_1</span>
<span class="s">code</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">0026</span><span class="nv"> </span><span class="s">0000</span><span class="nv"> </span><span class="s">0155</span><span class="nv"> </span><span class="s">00aa</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0014</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0014</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0014</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0014</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0040</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0014</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0015</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">060b</span><span class="nv"> </span><span class="s">0155</span><span class="nv"> </span><span class="s">0055</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">0e58</span><span class="nv"> </span><span class="s">0155</span><span class="nv"> </span><span class="s">0055</span><span class="nv"> </span><span class="s">0016</span><span class="nv"> </span><span class="s">00aa"</span>
<span class="s">device</span><span class="pi">:</span> <span class="s">LivingRoomTv</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">pronto</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">RGB</span>
<span class="s">code</span><span class="pi">:</span> <span class="s2">"</span><span class="s">F709</span><span class="nv"> </span><span class="s">DC24"</span>
<span class="s">device</span><span class="pi">:</span> <span class="s">LivingRoomTv</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">nec</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Required</em>): The name of this code.</li>
<li><strong>code</strong> (<em>Required</em>): The data for this code (see below).</li>
<li><strong>device</strong> (<em>Optional</em>): The device this code is associated with. Default is “unknown”.</li>
<li><strong>type</strong> (<em>Optional</em>): The type of this code. If this field is omitted, the type will be autodetected if possible.</li>
<li><strong>repeat</strong> (<em>Optional</em>): The number of times to repeat this code (on transmit). Default is 1.</li>
</ul>
<p>Some manufacturers (e.g. Samsung) require an IR code to be sent a number of times in a row in rapid succession (usually 3). This doesn’t apply to the vast majority of devices, but it can be helpful if needed.</p>
<h3><a class="title-link" name="code-types" href="#code-types"></a> Code Types</h3>
<p>When creating an entry in <code class="highlighter-rouge">kira_codes.yaml</code>, a few different kinds of codes can be used.</p>
<ul>
<li><strong>kira</strong>: This is the native wire protocol used by Kira modules. These can be captured using netcat.</li>
<li><strong>pronto</strong>: Pronto codes are supported.</li>
<li><strong>nec</strong>: If the device uses NEC IR codes and the manufacturer has published them, they can be used here.</li>
</ul>
<p><strong>NOTE</strong>: NEC codes by themselves contain enough information to recognize an IR sequence, but not enough to reconstruct it. Codes of this type are receive-only (usable by sensors but not remotes).</p>
</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/kira.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/keene.png' />
</div>
<div class='section'>
Introduced in release: 0.45
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/remote.kira/'>
Kira Remote
</a></li>
<li><a href='/components/sensor.kira/'>
Kira Sensor
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Hub</h1>
<ul class='divided'>
<li>
<a href='/components/apcupsd/'>APCUPSd</a>
</li>
<li>
<a href='/components/alarmdecoder/'>AlarmDecoder Alarm</a>
</li>
<li>
<a href='/components/android_ip_webcam/'>Android IP Webcam</a>
</li>
<li>
<a href='/components/arlo/'>Arlo</a>
</li>
<li>
<a href='/components/axis/'>Axis</a>
</li>
<li>
<a href='/components/wemo/'>Belkin WeMo</a>
</li>
<li>
<a href='/components/blink/'>Blink</a>
</li>
<li>
<a href='/components/bloomsky/'>BloomSky</a>
</li>
<li>
<a href='/components/digital_ocean/'>Digital Ocean</a>
</li>
<li>
<a href='/components/dyson/'>Dyson</a>
</li>
<li>
<a href='/components/eight_sleep/'>Eight Sleep</a>
</li>
<li>
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
</li>
<li>
<a href='/components/enocean/'>EnOcean</a>
</li>
<li>
<a href='/components/ffmpeg/'>FFmpeg</a>
</li>
<li>
<a href='/components/homematic/'>Homematic</a>
</li>
<li>
<a href='/components/tradfri/'>IKEA Trådfri (Tradfri)</a>
</li>
<li>
<a href='/components/isy994/'>ISY994 Controller</a>
</li>
<li>
<a href='/components/insteon_local/'>Insteon (local)</a>
</li>
<li>
<a href='/components/insteon_hub/'>Insteon Hub</a>
</li>
<li>
<a href='/components/insteon_plm/'>Insteon PLM</a>
</li>
<li>
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
</li>
<li>
<a href='/components/juicenet/'>Juicenet</a>
</li>
<li>
Kira
</li>
<li>
<a href='/components/litejet/'>LiteJet</a>
</li>
<li>
<a href='/components/lutron/'>Lutron</a>
</li>
<li>
<a href='/components/lutron_caseta/'>Lutron Caseta</a>
</li>
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
<li>
<a href='/components/mochad/'>Mochad</a>
</li>
<li>
<a href='/components/modbus/'>Modbus</a>
</li>
<li>
<a href='/components/mysensors/'>MySensors</a>
</li>
<li>
<a href='/components/neato/'>Neato Robotics</a>
</li>
<li>
<a href='/components/nest/'>Nest</a>
</li>
<li>
<a href='/components/netatmo/'>Netatmo</a>
</li>
<li>
<a href='/components/nuimo_controller/'>Nuimo controller</a>
</li>
<li>
<a href='/components/octoprint/'>OctoPrint</a>
</li>
<li>
<a href='/components/pilight/'>Pilight</a>
</li>
<li>
<a href='/components/qwikswitch/'>QwikSwitch QSUSB Hub</a>
</li>
<li>
<a href='/components/rflink/'>RFLink</a>
</li>
<li>
<a href='/components/rfxtrx/'>RFXtrx</a>
</li>
<li>
<a href='/components/ring/'>Ring</a>
</li>
<li>
<a href='/components/scsgate/'>SCSGate</a>
</li>
<li>
<a href='/components/spc/'>SPC</a>
</li>
<li>
<a href='/components/sleepiq/'>SleepIQ</a>
</li>
<li>
<a href='/components/tado/'>Tado</a>
</li>
<li>
<a href='/components/telegram_bot/'>Telegram chatbot</a>
</li>
<li>
<a href='/components/tellstick/'>TellStick</a>
</li>
<li>
<a href='/components/tellduslive/'>Telldus Live</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>
<li>
<a href='/components/vera/'>Vera</a>
</li>
<li>
<a href='/components/verisure/'>Verisure</a>
</li>
<li>
<a href='/components/volvooncall/'>Volvo On Call</a>
</li>
<li>
<a href='/components/wink/'>Wink</a>
</li>
<li>
<a href='/components/zwave/'>Z-Wave</a>
</li>
<li>
<a href='/components/zha/'>Zigbee Home Automation</a>
</li>
<li>
<a href='/components/zoneminder/'>ZoneMinder</a>
</li>
<li>
<a href='/components/ecobee/'>ecobee</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