359 lines
No EOL
14 KiB
HTML
359 lines
No EOL
14 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>Wake on LAN Switch - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate a wake on lan switch.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/switch.wake_on_lan/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Wake on LAN Switch">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/switch.wake_on_lan/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate a wake on lan switch.">
|
||
<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="Wake on LAN Switch">
|
||
<meta name="twitter:description" content="Instructions how to integrate a wake on lan switch.">
|
||
<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">
|
||
Wake on LAN Switch
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">wake_on_lan</code> (WOL) switch platform allows you to turn on a <a href="https://en.wikipedia.org/wiki/Wake-on-LAN">WOL</a> enabled computer.</p>
|
||
|
||
<p class="note warning">
|
||
The WOL switch can only turn on your computer and monitor the state. There is no universal way to turn off a computer remotely. The <code class="highlighter-rouge">turn_off</code> variable is there to help you call a script when you have figured out how to remotely turn off your computer.
|
||
See below for suggestions on how to do this.
|
||
</p>
|
||
|
||
<p>To enable this switch in your installation, 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.yml entry</span>
|
||
<span class="s">switch</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">wake_on_lan</span>
|
||
<span class="s">mac_address</span><span class="pi">:</span> <span class="s2">"</span><span class="s">00-01-02-03-04-05"</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>mac_address</strong> (<em>Required</em>): MAC address to send the wake up command to.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): The name of the switch. Default is ‘Wake on LAN’.</li>
|
||
<li><strong>host</strong> (<em>Optional</em>): The IP address or hostname to check the state of the device (on/off).</li>
|
||
<li><strong>turn_off</strong> (<em>Optional</em>): Defines an <a href="/getting-started/automation/">action</a> to run when the switch is turned off.</li>
|
||
</ul>
|
||
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
|
||
<p>Here are some real life examples of how to use the <strong>turn_off</strong> variable.</p>
|
||
|
||
<h3><a class="title-link" name="suspending-linux" href="#suspending-linux"></a> Suspending linux</h3>
|
||
<p>Suggested recipe for letting the turn_off script suspend a Linux computer (the <strong>target</strong>)
|
||
from Home Assistant running on another Linux computer (the <strong>server</strong>).</p>
|
||
|
||
<ol>
|
||
<li>On the <strong>server</strong>, log in as the user account Home Assistant is running under. (I’m using <code class="highlighter-rouge">hass</code> in this example)</li>
|
||
<li>On the <strong>server</strong>, create ssh keys by running <code class="highlighter-rouge">ssh-keygen</code>. Just press enter on all questions.</li>
|
||
<li>On the <strong>target</strong>, create a new account that Home Assistant can ssh into: <code class="highlighter-rouge">sudo adduser hass</code>. Just press enter on all questions except password. I recommend using the same user name as on the server. If you do, you can leave out <code class="highlighter-rouge">hass@</code> in the ssh commands below.</li>
|
||
<li>On the <strong>server</strong>, transfer your public ssh key by <code class="highlighter-rouge">ssh-copy-id hass@TARGET</code> where TARGET is your target machine’s name or IP address. Enter the password you created in step 3.</li>
|
||
<li>On the <strong>server</strong>, verify that you can reach your target machine without password by <code class="highlighter-rouge">ssh TARGET</code>.</li>
|
||
<li>On the <strong>target</strong>, we need to let the hass user execute the program needed to suspend/shut down the target computer. I’m using <code class="highlighter-rouge">pm-suspend</code>, use <code class="highlighter-rouge">poweroff</code> to turn off the computer. First, get the full path: <code class="highlighter-rouge">which pm-suspend</code>. On my system, this is <code class="highlighter-rouge">/usr/sbin/pm-suspend</code>.</li>
|
||
<li>On the <strong>target</strong>, using an account with sudo access (typically your main account), <code class="highlighter-rouge">sudo visudo</code>. Add this line last in the file: <code class="highlighter-rouge">hass ALL=NOPASSWD:/usr/sbin/pm-suspend</code>, where you replace <code class="highlighter-rouge">hass</code> with the name of your user on the target, if different, and <code class="highlighter-rouge">/usr/sbin/pm-suspend</code> with the command of your choice, if different.</li>
|
||
<li>On the <strong>server</strong>, add the following to your configuration, replacing TARGET with the target’s name:
|
||
```yaml
|
||
switch:
|
||
<ul>
|
||
<li>platform: wake_on_lan
|
||
name: “TARGET”
|
||
…
|
||
turn_off:
|
||
service: shell_command.turn_off_TARGET</li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
|
||
<p>shell_command:
|
||
turn_off_TARGET: ‘ssh hass@TARGET sudo pm-suspend’
|
||
```</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/switch.wake_on_lan.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/ethernet.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.16
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/switch/'>the Switches component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Switch</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/switch.anel_pwrctrl/'>ANEL PwrCtrl Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.acer_projector/'>Acer Projector Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.bbb_gpio/'>BeagleBone Black GPIO Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wemo/'>Belkin WeMo Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.broadlink/'>Broadlink RM Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.command_line/'>Command line Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.dlink/'>D-Link Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.digitalloggers/'>Digital Loggers Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.digital_ocean/'>Digital Ocean Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.edimax/'>Edimax Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.enocean/'>EnOcean Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.hikvision/'>Hikvision Camera Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.homematic/'>Homematic Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.hook/'>Hook Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.isy994/'>ISY994 Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.insteon_local/'>Insteon (Local) Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.kankun/'>Kankun SP3 Wifi Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.litejet/'>LiteJet Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mqtt/'>MQTT Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mochad/'>Mochad Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.modbus/'>Modbus Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mysensors/'>MySensors Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.neato/'>Neato Robotics Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.netio/'>Netio Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.orvibo/'>Orvibo Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.pilight/'>Pilight Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.pulseaudio_loopback/'>PulseAudio Loopback Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.qwikswitch/'>QwikSwitch Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rest/'>RESTful Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rfxtrx/'>RFXtrx Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rpi_gpio/'>Raspberry PI GPIO Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rpi_rf/'>Raspberry Pi RF Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.scsgate/'>SCSGate Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tplink/'>TPLink Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tellstick/'>TellStick Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tellduslive/'>Telldus Live Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.template/'>Template switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.thinkingcleaner/'>Thinking Cleaner Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.vera/'>Vera Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.verisure/'>Verisure SmartPlug</a>
|
||
</li>
|
||
<li>
|
||
Wake on LAN Switch
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wink/'>Wink Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zwave/'>Z-Wave Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zigbee/'>ZigBee Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zoneminder/'>ZoneMinder Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.arest/'>aREST Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mfi/'>mFi Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mystrom/'>myStrom Switch</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> |