moritzruth/hass-wol
1
0
Fork 0
Code Issues Pull requests Packages 1 Activity

Update README.md

Browse source
This commit is contained in:
Moritz Ruth 2024-07-09 23:13:54 +02:00 • committed by git.moritzruth.de
parent db3f714ecc
commit 759fb7c3d5
Signed by: git.moritzruth.de
GPG key ID: AF72C6EBB4B578A7
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -4,9 +4,13 @@
It connects to your [MQTT broker](https://www.home-assistant.io/integrations/mqtt/) and registers a simple _Wake-on-LAN_ button for every specified host. It connects to your [MQTT broker](https://www.home-assistant.io/integrations/mqtt/) and registers a simple _Wake-on-LAN_ button for every specified host.
Note that [Home Assistant also has native support for Wake-on-LAN](https://www.home-assistant.io/integrations/wake_on_lan/).
This project is useful for when you don’t want your Home Assistant container to use host networking or when the device to be woken up is in an entirely different network.
## Usage ## Usage
This tool is intended to be used as a companion container to the Home Assistant container. This tool is intended to be used as a companion to the Home Assistant container.
Your `docker-compose.yml` may look like this: Your `docker-compose.yml` may look like this:
@ -52,9 +56,11 @@ mac_address = "20:5D:48:98:94:C0"
# ms_between_packets = 500 # ms_between_packets = 500
``` ```
## License ## License
hass-wol is licensed under the [Blue Oak Model License 1.0.0](./LICENSE.md). This project is available under the permissive [Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0).
## Related projects ## Related projects