234 lines
No EOL
8.9 KiB
HTML
234 lines
No EOL
8.9 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>Keyboard - 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">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/keyboard_remote/">
|
||
<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">
|
||
<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='/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">
|
||
Keyboard
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>Receive signals from a keyboard and use it as a remote control.</p>
|
||
|
||
<p>This component allows to use a keyboard as remote control. It will fire <code class="highlighter-rouge">keyboard_remote_command_received</code> events witch 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">device_descriptor</span><span class="pi">:</span> <span class="s1">'</span><span class="s">/dev/input/by-id/foo'</span>
|
||
<span class="s">key_value</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>device_descriptor</strong> (<em>Required</em>): List of URLS for your feeds.</li>
|
||
<li><strong>key_value</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>
|
||
</ul>
|
||
|
||
<p>And an automation rule to bring breath live 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 light on</span>
|
||
<span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
|
||
<span class="s">event_type</span><span class="pi">:</span> <span class="s">keyboard_remote_command_received</span>
|
||
<span class="s">event_data</span><span class="pi">:</span>
|
||
<span class="s">key_code</span><span class="pi">:</span> <span class="s">107</span> <span class="c1"># inspect log to obtain desired keycode</span>
|
||
<span class="s">action</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.all</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='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'>
|
||
<img src='/images/supported_brands/keyboard.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>: Local Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.29
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Other</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/browser/'>Browser</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/configurator/'>Configurator</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/demo/'>Demo platforms</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/discovery/'>Discovery</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/feedreader/'>Feedreader</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/http/'>HTTP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/introduction/'>Introduction</a>
|
||
</li>
|
||
<li>
|
||
Keyboard
|
||
</li>
|
||
<li>
|
||
<a href='/components/logger/'>Logger</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mqtt_eventstream/'>MQTT Eventstream</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/persistent_notification/'>Persistent notification</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/upnp/'>UPnP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/updater/'>Updater</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zeroconf/'>Zeroconf/Avahi/Bonjour</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>.<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>
|
||
</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> |