diff --git a/components/switch.wake_on_lan/index.html b/components/switch.wake_on_lan/index.html
index 9fcccb3821..39a9845277 100644
--- a/components/switch.wake_on_lan/index.html
+++ b/components/switch.wake_on_lan/index.html
@@ -94,6 +94,7 @@
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 turn_off
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.
To enable this switch in your installation, add the following to your configuration.yaml
file:
@@ -114,6 +115,39 @@ The WOL switch can only turn on your computer and monitor the state. There is no
turn_off (Optional): Defines an action to run when the switch is turned off.
+ Examples
+
+Here are some real life examples of how to use the turn_off variable.
+
+ Suspending linux
+Suggested recipe for letting the turn_off script suspend a Linux computer (the target)
+from Home Assistant running on another Linux computer (the server).
+
+
+ - On the server, log in as the user account Home Assistant is running under. (I’m using
hass
in this example)
+ - On the server, create ssh keys by running
ssh-keygen
. Just press enter on all questions.
+ - On the target, create a new account that Home Assistant can ssh into:
sudo adduser hass
. 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 hass@
in the ssh commands below.
+ - On the server, transfer your public ssh key by
ssh-copy-id hass@TARGET
where TARGET is your target machine’s name or IP address. Enter the password you created in step 3.
+ - On the server, verify that you can reach your target machine without password by
ssh TARGET
.
+ - On the target, we need to let the hass user execute the program needed to suspend/shut down the target computer. I’m using
pm-suspend
, use poweroff
to turn off the computer. First, get the full path: which pm-suspend
. On my system, this is /usr/sbin/pm-suspend
.
+ - On the target, using an account with sudo access (typically your main account),
sudo visudo
. Add this line last in the file: hass ALL=NOPASSWD:/usr/sbin/pm-suspend
, where you replace hass
with the name of your user on the target, if different, and /usr/sbin/pm-suspend
with the command of your choice, if different.
+ - On the server, add the following to your configuration, replacing TARGET with the target’s name:
+``` yaml
+switch:
+
+ - platform: wake_on_lan
+ name: “TARGET”
+ …
+ turn_off:
+ service: shell_command.turn_off_TARGET
+
+
+
+
+shell_command:
+ turn_off_TARGET: ‘ssh hass@TARGET sudo pm-suspend’
+```
+
diff --git a/sitemap.xml b/sitemap.xml
index 68b4ff8ed6..520a294bff 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -2462,62 +2462,62 @@
https://home-assistant.io/demo/frontend.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/index.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00
https://home-assistant.io/static/mdi-demo.html
-2016-12-18T08:45:01+00:00
+2016-12-18T08:55:08+00:00