230 lines
No EOL
8.7 KiB
HTML
230 lines
No EOL
8.7 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 simulate key presses with Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/keyboard/">
|
|
|
|
<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/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to simulate key presses with 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 simulate key presses with 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="/ecosystem/">Ecosystem</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>The <code class="highlighter-rouge">keyboard</code> component simulates key presses on the host machine. It currently offers the following Buttons as a Service (BaaS):</p>
|
|
|
|
<ul>
|
|
<li><code class="highlighter-rouge">keyboard/volume_up</code></li>
|
|
<li><code class="highlighter-rouge">keyboard/volume_down</code></li>
|
|
<li><code class="highlighter-rouge">keyboard/volume_mute</code></li>
|
|
<li><code class="highlighter-rouge">keyboard/media_play_pause</code></li>
|
|
<li><code class="highlighter-rouge">keyboard/media_next_track</code></li>
|
|
<li><code class="highlighter-rouge">keyboard/media_prev_track</code></li>
|
|
</ul>
|
|
|
|
<p>To load this component, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
|
|
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">keyboard</span><span class="pi">:</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<h2><a class="title-link" name="dependencies" href="#dependencies"></a> Dependencies</h2>
|
|
|
|
<p>You may need to install platform-specific <a href="https://github.com/PyUserInput/PyUserInput#dependencies">dependencies for PyUserInput</a> in order to use the keyboard component. In most cases this can be done by running:</p>
|
|
|
|
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install <span class="o">[</span>package name]
|
|
</code></pre>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="windows" href="#windows"></a> Windows</h4>
|
|
|
|
<p>x64 Windows users may have trouble installing pywin through pip. Using an <a href="http://sourceforge.net/projects/pywin32/files/pywin32/">executable installer</a> should work around this issue.</p>
|
|
|
|
<p><a href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#pyhook">Similar installers</a> (unofficial) for pyhook have been ported to python 3.4 and should help with x64 pip issues with pyhook.</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/keyboard.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'>
|
|
Introduced in release: pre 0.7
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Automation</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/automation/'>Automation</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.flux/'>Flux Light Adjustment</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/hdmi_cec/'>HDMI CEC</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/ifttt/'>IFTTT</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/input_boolean/'>Input Boolean</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/input_select/'>Input Select</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/input_slider/'>Input Slider</a>
|
|
</li>
|
|
<li>
|
|
Keyboard
|
|
</li>
|
|
<li>
|
|
<a href='/components/lirc/'>LIRC</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/openalpr/'>OpenALPR</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/device_sun_light_trigger/'>Presence based lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/proximity/'>Proximity</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/rest_command/'>RESTful Command</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/script/'>Scripts</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/shell_command/'>Shell command</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>
|
|
<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> |