-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[lgwebos] Wake-on-Lan Integration (#7103)
* Adding WOL Implementation to PowerControl channel with ability to determine MAC (best effort via arp) and send WOL natively. Removed Search, as second screen service does actually show up in regular scans now. * Addressing review comments in WakeOnLanUitility and config.xml. * Add mac and windows commands to discover MAC. * Break once MAC is found in result. * Using org.eclipse.smarthome.io.net.exec.ExecUtil instead of implementing Commandline Execution in the binding itself. * Detecting which linux tool to detect MAC exists, arp or arping. * Fixed typo in debug message. * Addressing review comments on formatting. * MacAddress parameter added to README demo item and Power Control Handler updated. * Handle power on off commands in all possible LGWebOSTVSocket states. * Reformatting debug message. * Fix whitespace. * Moved If statement cases into switch statement. * Adding comments. * Applying code review recommendations. Reducing power channel updates. CONNECTING and REGISTERING still count as OFF states. * Inlining Socket's isConnected method. The method name was also misleading. Signed-off-by: Sebastian Prehn <sebastian.prehn@gmx.de> Co-authored-by: cpmeister <mistercpp2000@gmail.com>
- Loading branch information
Showing
10 changed files
with
302 additions
and
131 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
175 changes: 175 additions & 0 deletions
175
....binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/WakeOnLanUtility.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| /** | ||
| * Copyright (c) 2010-2020 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.lgwebos.internal; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.DatagramPacket; | ||
| import java.net.DatagramSocket; | ||
| import java.net.InetAddress; | ||
| import java.net.InterfaceAddress; | ||
| import java.net.NetworkInterface; | ||
| import java.util.Enumeration; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.eclipse.smarthome.io.net.exec.ExecUtil; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * Class with utility functions to support Wake On Lan (WOL) | ||
| * | ||
| * @author Arjan Mels - Initial contribution | ||
| * @author Sebastian Prehn - Modification to getMACAddress | ||
| * | ||
| */ | ||
| @NonNullByDefault | ||
| public class WakeOnLanUtility { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(WakeOnLanUtility.class); | ||
| private static final Pattern MAC_REGEX = Pattern.compile("(([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2})"); | ||
| private static final int CMD_TIMEOUT_MS = 1000; | ||
|
|
||
| private static final String COMMAND; | ||
| static { | ||
| String os = System.getProperty("os.name").toLowerCase(); | ||
| LOGGER.debug("os: {}", os); | ||
| if ((os.indexOf("win") >= 0)) { | ||
| COMMAND = "arp -a %s"; | ||
| } else if ((os.indexOf("mac") >= 0)) { | ||
| COMMAND = "arp %s"; | ||
| } else { // linux | ||
| if (checkIfLinuxCommandExists("arp")) { | ||
| COMMAND = "arp %s"; | ||
| } else if (checkIfLinuxCommandExists("arping")) { // typically OH provided docker image | ||
| COMMAND = "arping -r -c 1 -C 1 %s"; | ||
| } else { | ||
| COMMAND = ""; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get MAC address for host | ||
| * | ||
| * @param hostName Host Name (or IP address) of host to retrieve MAC address for | ||
| * @return MAC address | ||
| */ | ||
| public static @Nullable String getMACAddress(String hostName) { | ||
| if (COMMAND.isEmpty()) { | ||
| LOGGER.debug("MAC address detection not possible. No command to identify MAC found."); | ||
| return null; | ||
| } | ||
|
|
||
| String cmd = String.format(COMMAND, hostName); | ||
| String response = ExecUtil.executeCommandLineAndWaitResponse(cmd, CMD_TIMEOUT_MS); | ||
| Matcher matcher = MAC_REGEX.matcher(response); | ||
| String macAddress = null; | ||
|
|
||
| while (matcher.find()) { | ||
| String group = matcher.group(); | ||
|
|
||
| if (group.length() == 17) { | ||
| macAddress = group; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if (macAddress != null) { | ||
| LOGGER.debug("MAC address of host {} is {}", hostName, macAddress); | ||
| } else { | ||
| LOGGER.debug("Problem executing command {} to retrieve MAC address for {}: {}", cmd, hostName, response); | ||
| } | ||
| return macAddress; | ||
| } | ||
|
|
||
| /** | ||
| * Send single WOL (Wake On Lan) package on all interfaces | ||
| * | ||
| * @macAddress MAC address to send WOL package to | ||
| */ | ||
| public static void sendWOLPacket(String macAddress) { | ||
| byte[] bytes = getWOLPackage(macAddress); | ||
|
|
||
| try { | ||
| Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces(); | ||
| while (interfaces.hasMoreElements()) { | ||
| NetworkInterface networkInterface = interfaces.nextElement(); | ||
| if (networkInterface.isLoopback()) { | ||
| continue; // Do not want to use the loopback interface. | ||
| } | ||
| for (InterfaceAddress interfaceAddress : networkInterface.getInterfaceAddresses()) { | ||
| InetAddress broadcast = interfaceAddress.getBroadcast(); | ||
| if (broadcast == null) { | ||
| continue; | ||
| } | ||
|
|
||
| DatagramPacket packet = new DatagramPacket(bytes, bytes.length, broadcast, 9); | ||
| try (DatagramSocket socket = new DatagramSocket()) { | ||
| socket.send(packet); | ||
| LOGGER.trace("Sent WOL packet to {} {}", broadcast, macAddress); | ||
| } catch (IOException e) { | ||
| LOGGER.warn("Problem sending WOL packet to {} {}", broadcast, macAddress); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } catch (IOException e) { | ||
| LOGGER.warn("Problem with interface while sending WOL packet to {}", macAddress); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Create WOL UDP package: 6 bytes 0xff and then 16 times the 6 byte mac address repeated | ||
| * | ||
| * @param macStr String representation of the MAC address (either with : or -) | ||
| * @return byte array with the WOL package | ||
| * @throws IllegalArgumentException | ||
| */ | ||
| private static byte[] getWOLPackage(String macStr) throws IllegalArgumentException { | ||
| byte[] macBytes = new byte[6]; | ||
| String[] hex = macStr.split("(\\:|\\-)"); | ||
| if (hex.length != 6) { | ||
| throw new IllegalArgumentException("Invalid MAC address."); | ||
| } | ||
| try { | ||
| for (int i = 0; i < 6; i++) { | ||
| macBytes[i] = (byte) Integer.parseInt(hex[i], 16); | ||
| } | ||
| } catch (NumberFormatException e) { | ||
| throw new IllegalArgumentException("Invalid hex digit in MAC address."); | ||
| } | ||
|
|
||
| byte[] bytes = new byte[6 + 16 * macBytes.length]; | ||
| for (int i = 0; i < 6; i++) { | ||
| bytes[i] = (byte) 0xff; | ||
| } | ||
| for (int i = 6; i < bytes.length; i += macBytes.length) { | ||
| System.arraycopy(macBytes, 0, bytes, i, macBytes.length); | ||
| } | ||
|
|
||
| return bytes; | ||
| } | ||
|
|
||
| private static boolean checkIfLinuxCommandExists(String cmd) { | ||
| try { | ||
| return 0 == Runtime.getRuntime().exec(String.format("which %s", cmd)).waitFor(); | ||
| } catch (InterruptedException | IOException e) { | ||
| LOGGER.debug("Error trying to check if command {} exists: {}", cmd, e.getMessage()); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.