mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Add config flow to Wake on LAN (#33660)
* Add config flow to Wake on LAN * Update source/_integrations/wake_on_lan.markdown * Update source/_integrations/wake_on_lan.markdown * tiny tweak * Change to new button entity * Update example * mod * spelling * Tiny tweak --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
642424760d
commit
c0045fa91a
@ -2,12 +2,15 @@
|
|||||||
title: Wake on LAN
|
title: Wake on LAN
|
||||||
description: Instructions on how to setup the Wake on LAN integration in Home Assistant.
|
description: Instructions on how to setup the Wake on LAN integration in Home Assistant.
|
||||||
ha_category:
|
ha_category:
|
||||||
|
- Button
|
||||||
- Network
|
- Network
|
||||||
- Switch
|
- Switch
|
||||||
ha_release: 0.49
|
ha_release: 0.49
|
||||||
ha_iot_class: Local Push
|
ha_iot_class: Local Push
|
||||||
ha_domain: wake_on_lan
|
ha_domain: wake_on_lan
|
||||||
|
ha_config_flow: true
|
||||||
ha_platforms:
|
ha_platforms:
|
||||||
|
- button
|
||||||
- switch
|
- switch
|
||||||
ha_codeowners:
|
ha_codeowners:
|
||||||
- '@ntilley905'
|
- '@ntilley905'
|
||||||
@ -21,12 +24,25 @@ The **Wake on LAN** {% term integration %} enables the ability to send _magic pa
|
|||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
- [Switch](#switch)
|
- [Button](#button) enabled from the UI
|
||||||
|
- [Switch](#switch) enabled from YAML configuration
|
||||||
|
|
||||||
## Configuration
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
To use this {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
{% configuration_basic %}
|
||||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
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
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
@ -60,11 +76,16 @@ This usually only works if the target device is connected to the same network. R
|
|||||||
The action to route the packet is most likely named "IP Helper". It may support Wake on LAN, but not all routers support this.
|
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 %}
|
{% endnote %}
|
||||||
|
|
||||||
## Switch
|
## Button
|
||||||
|
|
||||||
The `wake_on_lan` (WOL) switch {% term integration %} allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
|
The `wake_on_lan` (WOL) switch {% term integration %} allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
|
||||||
|
|
||||||
### Switch configuration
|
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](https://en.wikipedia.org/wiki/Wake-on-LAN) 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.
|
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.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user