diff --git a/components/button/wake_on_lan.rst b/components/button/wake_on_lan.rst new file mode 100644 index 000000000..3d702036a --- /dev/null +++ b/components/button/wake_on_lan.rst @@ -0,0 +1,32 @@ +Wake-on-LAN Button +==================== + +.. seo:: + :description: Instructions for setting up buttons that can send wakeup packets to computers on the network. + :image: radio-tower.svg + +The ``wake_on_lan`` button platform allows you to send a Wake-on-LAN magic packet to a computer on the network +by specifying its MAC address. + +.. code-block:: yaml + + # Example configuration entry + button: + - platform: wake_on_lan + name: "Start the Server" + target_mac_address: E9:48:B8:CA:58:A1 + +Configuration variables: +------------------------ + +- **name** (**Required**, string): The name for the button. +- **target_mac_address** (**Required**, MAC Address): The MAC Address of the target computer. +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. +- All other options from :ref:`Button `. + +See Also +-------- + +- :doc:`template` +- :apiref:`wake_on_lan/wake_on_lan.h` +- :ghedit:`Edit` diff --git a/index.rst b/index.rst index da34670f0..8f27c48ff 100644 --- a/index.rst +++ b/index.rst @@ -485,6 +485,7 @@ Button Components Button Core, components/button/index, folder-open.svg Template Button, components/button/template, description.svg Restart Button, components/button/restart, restart.svg + Wake-on-LAN, components/button/wake_on_lan, power_settings.svg Fan Components --------------