home-assistant.io/source/_integrations/wake_on_lan.markdown

title	description	ha_category	ha_release	ha_iot_class	ha_domain	ha_config_flow	ha_platforms	ha_codeowners	ha_integration_type	related
Wake on LAN	Instructions on how to setup the Wake on LAN integration in Home Assistant.	Button Network Switch	0.49	Local Push	wake_on_lan	true	button switch	@ntilley905	integration	docs title /docs/configuration/ Configuration file

The Wake on LAN {% term integration %} enables the ability to send magic packets to Wake on LAN capable devices to turn them on.

There is currently support for the following device types within Home Assistant:

• Button enabled from the UI
• Switch enabled from YAML configuration

{% include integrations/config_flow.md %}

{% configuration_basic %} Mac address: description: "The MAC address to send the wake-up command to. For example, 00:01:02:03:04:05." Broadcast address: description: The IP address of the host to send the magic packet to. Broadcast port: description: The port to send the magic packet to. {% endconfiguration_basic %}

Integration services

Available services: send_magic_packet.

To only use this service, add the following to your {% term "configuration.yaml" %} file

# Example configuration.yaml entry
wake_on_lan:

Actions

Available actions: send_magic_packet.

Action wake_on_lan.send_magic_packet

Send a magic packet to wake up a device with 'Wake on LAN' capabilities.

Data attribute	Optional	Description
mac	no	MAC address of the device to wake up.
broadcast_address	yes	Optional broadcast IP where to send the magic packet.
broadcast_port	yes	Optional port where to send the magic packet.

Sample action data:

{
   "mac":"00:40:13:ed:f1:32"
}

{% note %} This usually only works if the target device is connected to the same network. Routing the magic packet to a different subnet requires a special configuration on your router or may not be possible. The action to route the packet is most likely named "IP Helper". It may support Wake on LAN, but not all routers support this. {% endnote %}

Button

The wake_on_lan (WOL) button {% term integration %} allows you to turn on a WOL enabled computer.

The WOL button can only turn on your computer. It will send a magic packet to the MAC address specified in the configuration. As a button, it is stateless. This means it can not monitor if the WOL-enabled computer has actually received the wake-up call and has started.

Switch

The wake_on_lan (WOL) switch {% term integration %} allows you to turn on a WOL enabled computer.

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.

It's required that the binary ping is in your $PATH.

To enable this switch in your installation, add the following to your {% term "configuration.yaml" %} file:

# Example configuration.yaml entry
switch:
  - platform: wake_on_lan
    mac: MAC_ADDRESS

{% configuration %} mac: description: "The MAC address to send the wake up command to, e.g, 00:01:02:03:04:05." required: true type: string name: description: The name of the switch. required: false default: Wake on LAN type: string host: description: The IP address or hostname to check the state of the device (on/off). If this is not provided, the state of the switch will be assumed based on the last action that was taken. required: false type: string turn_off: description: Defines an action to run when the switch is turned off. required: false type: string broadcast_address: description: The IP address of the host to send the magic packet to. required: false default: 255.255.255.255 type: string broadcast_port: description: The port to send the magic packet to. required: false type: integer {% endconfiguration %}

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).

1. On the server, log in as the user account Home Assistant is running under. In this example it's hass.
2. On the server, create SSH keys by running ssh-keygen. Just press enter on all questions.
3. On the target, create a new account that Home Assistant can ssh into: sudo adduser hass. Just press enter on all questions except password. It's recommended using the same username as on the server. If you do, you can leave out hass@ in the SSH commands below.
4. 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.
5. On the server, verify that you can reach your target machine without password by ssh TARGET.
6. On the target, we need to let the hass user execute the program needed to suspend/shut down the target computer. Here is it 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.
7. 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.
8. On the server, add the following to your configuration, replacing TARGET with the target's name:

switch:
  - platform: wake_on_lan
    name: "TARGET"
    ...
    turn_off:
      action: shell_command.turn_off_TARGET

shell_command:
  turn_off_TARGET: "ssh hass@TARGET sudo pm-suspend"

Helper button with automation

A switch defined with the wake_on_lan platform will render in the UI with both 'on' and 'off' clickable actions. If you don't intend to use the turn_off functionality, then using a virtual button & automation will look cleaner and less confusing. It will only have one action.

1. First, define a new helper button.

   • Go to {% my helpers title="Settings > Devices & services > Helpers" %} and select the + Create helper button. Choose Button and give it a name. A button named "Wake PC" will render like this:

   

2. Then, create a new automation. Go to {% my automations title="Settings > Automations & scenes" %} and select + Create Automation.

   • The trigger will be on State and the entity will be the button you created.

   • Continuing your example, the trigger YAML will look like this:

     trigger: state
     entity_id:
       - input_button.wake_pc
     

3. For the action, select Perform action and choose Wake on LAN: Send magic packet.

4. Type in the target MAC address.

   • Do not change the broadcast port unless you've configured your device to listen to a different port.

   • Continuing our example, the action YAML looks like this:

     action: wake_on_lan.send_magic_packet
     data:
       broadcast_port: 9
       mac: 00:11:22:33:44:55
     

5. Save the automation. Now, when you activate PRESS on the helper button in the UI, Home Assistant will send a wake packet to the configured MAC.