jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

58
components/keyboard_remote/index.html
View file

@ -3,17 +3,14 @@
<!--[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>Keyboard Remote - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to use a keyboard to remote control Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/keyboard_remote/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Keyboard Remote">
<meta property="og:site_name" content="Home Assistant">
@ -21,39 +18,31 @@
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to use a keyboard to remote control 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="Keyboard Remote">
<meta name="twitter:description" content="Instructions how to use a keyboard to remote control 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>
@ -64,75 +53,49 @@
</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">
Keyboard Remote
</h1>
</header>
<hr class="divider">
<p>Receive signals from a keyboard and use it as a remote control.</p>
<p>This component allows you to use a keyboard as remote control. It will fire <code class="highlighter-rouge">keyboard_remote_command_received</code> events which can then be used in automation rules.</p>
<p>The <code class="highlighter-rouge">evdev</code> package is used to interface with the keyboard and thus this is Linux only. It also means you can’t use your normal keyboard for this because <code class="highlighter-rouge">evdev</code> will block it.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">keyboard_remote</span><span class="pi">:</span>
<span class="s">type</span><span class="pi">:</span> <span class="s1">'</span><span class="s">key_up'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>type</strong> (<em>Required</em>): Possible values are <code class="highlighter-rouge">key_up</code>, <code class="highlighter-rouge">key_down</code>, and <code class="highlighter-rouge">key_hold</code>. Be careful, <code class="highlighter-rouge">key_hold</code> will fire a lot of events.</li>
<li><strong>device_descriptor</strong> (<em>Optional</em>): Path to the local event input device file that corresponds to the keyboard.</li>
<li><strong>device_name</strong> (<em>Optional</em>): Name of the keyboard device.</li>
</ul>
<p>Either <code class="highlighter-rouge">device_name</code> or <code class="highlighter-rouge">device_descriptor</code> must be present in the configuration entry. Indicating a device name is useful in case of repeating disconnections and re-connections of the device (for example, a bluetooth keyboard): the local input device file might change, thus breaking the configuration, while the name remains the same.
In case of presence of multiple devices of the same model, <code class="highlighter-rouge">device_descriptor</code> must be used.</p>
<p>A list of possible device descriptors and names is reported in the debug log at startup when the device indicated in the configuration entry could not be found.</p>
<p>A full configuration for Keyboard Remote could look like the one below:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">keyboard_remote</span><span class="pi">:</span>
<span class="s">device_descriptor</span><span class="pi">:</span> <span class="s1">'</span><span class="s">/dev/input/by-id/bluetooth-keyboard'</span>
<span class="s">type</span><span class="pi">:</span> <span class="s1">'</span><span class="s">key_up'</span>
</code></pre>
</div>
<p>or like the following:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">keyboard_remote</span><span class="pi">:</span>
<span class="s">device_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Bluetooth</span><span class="nv"> </span><span class="s">Keyboard'</span>
<span class="s">type</span><span class="pi">:</span> <span class="s1">'</span><span class="s">key_down'</span>
</code></pre>
</div>
<p>And an automation rule to breathe life into it:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">automation</span><span class="pi">:</span>
<span class="s">alias</span><span class="pi">:</span> <span class="s">Keyboard all lights on</span>
<span class="s">trigger</span><span class="pi">:</span>
@ -145,13 +108,10 @@ In case of presence of multiple devices of the same model, <code class="highligh
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.all</span>
</code></pre>
</div>
<h2><a class="title-link" name="disconnections" href="#disconnections"></a> Disconnections</h2>
<p>This component manages disconnections and re-connections of the keyboard, for example in the case of a bluetooth device that turns off automatically to preserve battery.</p>
<p>If the keyboard disconnects, the component will fire an event <code class="highlighter-rouge">keyboard_remote_disconnected</code>.
When the keyboard reconnects, an event <code class="highlighter-rouge">keyboard_remote_connected</code> will be fired.</p>
<p>Here’s an automation example that plays a sound through a media player whenever the keyboard connects/disconnects:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">automation</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Keyboard Connected</span>
@ -176,35 +136,24 @@ When the keyboard reconnects, an event <code class="highlighter-rouge">keyboard_
<span class="s">media_content_type</span><span class="pi">:</span> <span class="s">music</span>
</code></pre>
</div>
<h2><a class="title-link" name="permissions" href="#permissions"></a> Permissions</h2>
<p>There might be permissions problems with the event input device file. If this is the case, the user that hass runs as must be allowed read and write permissions with:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>sudo setfacl -m u:HASS_USER:rw /dev/input/event*
</code></pre>
</div>
<p>where <code class="highlighter-rouge">HASS_USER</code> is the user hass runs as.</p>
<p>If you want to make this permanent, you can use a udev rule that sets it for all event input devices. Add a file <code class="highlighter-rouge">/etc/udev/rules.d/99-userdev-input.rules</code> containing:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>KERNEL=="event*", SUBSYSTEM=="input", RUN+="/usr/bin/setfacl -m u:HASS_USER:rw $env{DEVNAME}"
</code></pre>
</div>
<p>You can check ACLs permissions with</p>
<div class="highlighter-rouge"><pre class="highlight"><code>getfacl /dev/input/event*
</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='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/keyboard_remote.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
@ -273,13 +222,10 @@ When the keyboard reconnects, an event <code class="highlighter-rouge">keyboard_
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -289,7 +235,6 @@ When the keyboard reconnects, an event <code class="highlighter-rouge">keyboard_
<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>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
@ -301,7 +246,6 @@ When the keyboard reconnects, an event <code class="highlighter-rouge">keyboard_
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -309,4 +253,4 @@ When the keyboard reconnects, an event <code class="highlighter-rouge">keyboard_
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>