# ruff: noqa """Small module for use with the wake on lan protocol. taken from https://github.com/remcohaszing/pywakeonlan/blob/main/wakeonlan/__init__.py Provided under MIT license Copyright © 2012 Remco Haszing Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ import logging import socket BROADCAST_IP = "255.255.255.255" DEFAULT_PORT = 9 def create_magic_packet(macaddress: str) -> bytes: """Create a magic packet. A magic packet is a packet that can be used with the for wake on lan protocol to wake up a computer. The packet is constructed from the mac address given as a parameter. Args: macaddress: the mac address that should be parsed into a magic packet. """ if len(macaddress) == 17: sep = macaddress[2] macaddress = macaddress.replace(sep, "") elif len(macaddress) == 14: sep = macaddress[4] macaddress = macaddress.replace(sep, "") if len(macaddress) != 12: raise ValueError("Incorrect MAC address format") return bytes.fromhex("F" * 12 + macaddress * 16) def send_magic_packet( *macs: str, ip_address: str = BROADCAST_IP, port: int = DEFAULT_PORT, interface: str | None = None, logger: logging.Logger | None = None, ) -> None: """Wake up computers having any of the given mac addresses. Wake on lan must be enabled on the host device. Args: macs: One or more macaddresses of machines to wake. Keyword Args: ip_address: the ip address of the host to send the magic packet to. port: the port of the host to send the magic packet to. interface: the ip address of the network adapter to route the magic packet through. logger: a logger """ packets = [create_magic_packet(mac) for mac in macs] with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sock: if interface is not None: sock.bind((interface, 0)) sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) sock.connect((ip_address, port)) for packet in packets: if logger: logger.debug("Sending magic packet to %s", macs) sock.send(packet)