jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-20 15:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update switch Wake on Lan configuration variable (#6489)

Browse Source 
* Update switch Wake on Lan configuration variable

Update style of switch wake on lan documentation to follow new configuration variables description.

Note: the numbered list, I assume that it should remain as the code is now?

Related to #6385.

* Update switch.wake_on_lan.markdown

Added default for name

* Adjustment to the name since the default is set

* ✏️ Corrects two types

* ✏️ Tweak
This commit is contained in:
Klaas Schoute 2018-10-04 09:38:12 +02:00 committed by Franck Nijhof
parent 2d5a70a839
commit 70bfaef8b4
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
source/_components/switch.wake_on_lan.markdown
View File

@ -31,13 +31,30 @@ switch:
mac_address: "00-01-02-03-04-05"
```
Configuration variables:
- **mac_address** (*Required*): MAC address to send the wake up command to.
- **name** (*Optional*): The name of the switch. Default is 'Wake on LAN'.
- **host** (*Optional*): The IP address or hostname to check the state of the device (on/off).
- **turn_off** (*Optional*): Defines an [action](/getting-started/automation/) to run when the switch is turned off.
- **broadcast_address** (*Optional*): The IP address of the host to send the magic packet to (default 255.255.255.255).
{% configuration %}
mac_address:
description: MAC address to send the wake up command to.
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).
required: false
type: string
turn_off:
description: Defines an [action](/getting-started/automation/) 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
{% endconfiguration %}
## {% linkable_title Examples %}