git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.network.internal.action;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.openhab.binding.network.internal.handler.NetworkHandler;
  18 import org.openhab.core.automation.annotation.RuleAction;
  19 import org.openhab.core.thing.binding.ThingActions;
  20 import org.openhab.core.thing.binding.ThingActionsScope;
  21 import org.openhab.core.thing.binding.ThingHandler;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 /**
  26  * The class is responsible to call corresponding actions on {@link NetworkHandler}.
  27  *
  28  * @author Wouter Born - Initial contribution
  29  */
  30 @ThingActionsScope(name = "network")
  31 @NonNullByDefault
  32 public class NetworkActions implements ThingActions {
  33
  34     private final Logger logger = LoggerFactory.getLogger(NetworkActions.class);
  35
  36     private @Nullable NetworkHandler handler;
  37
  38     @Override
  39     public void setThingHandler(@Nullable ThingHandler handler) {
  40         if (handler instanceof NetworkHandler networkHandler) {
  41             this.handler = networkHandler;
  42         }
  43     }
  44
  45     @Override
  46     public @Nullable ThingHandler getThingHandler() {
  47         return handler;
  48     }
  49
  50     /**
  51      * @deprecated Use sendWakeOnLanPacketViaMac or sendWakeOnLanPacketViaIp instead.
  52      */
  53     @Deprecated
  54     @RuleAction(label = "send a WoL packet", description = "Send a Wake-on-LAN packet to wake the device.")
  55     public void sendWakeOnLanPacket() {
  56         sendWakeOnLanPacketViaMac();
  57     }
  58
  59     public static void sendWakeOnLanPacket(ThingActions actions) {
  60         ((NetworkActions) actions).sendWakeOnLanPacketViaMac();
  61     }
  62
  63     @RuleAction(label = "send a WoL packet", description = "Send a Wake-on-LAN packet to wake the device via Mac.")
  64     public void sendWakeOnLanPacketViaMac() {
  65         NetworkHandler localHandler = handler;
  66         if (localHandler != null) {
  67             localHandler.sendWakeOnLanPacketViaMac();
  68         } else {
  69             logger.warn("Failed to send Wake-on-LAN packet (handler null)");
  70         }
  71     }
  72
  73     public static void sendWakeOnLanPacketViaMac(ThingActions actions) {
  74         ((NetworkActions) actions).sendWakeOnLanPacketViaMac();
  75     }
  76
  77     @RuleAction(label = "send a WoL packet", description = "Send a Wake-on-LAN packet to wake the device via IP.")
  78     public void sendWakeOnLanPacketViaIp() {
  79         NetworkHandler localHandler = handler;
  80         if (localHandler != null) {
  81             localHandler.sendWakeOnLanPacketViaIp();
  82         } else {
  83             logger.warn("Failed to send Wake-on-LAN packet (handler null)");
  84         }
  85     }
  86
  87     public static void sendWakeOnLanPacketViaIp(ThingActions actions) {
  88         ((NetworkActions) actions).sendWakeOnLanPacketViaIp();
  89     }
  90 }