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

   1 /**
   2  * Copyright (c) 2010-2022 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.wemo.internal.handler;
  14
  15 import static org.openhab.binding.wemo.internal.WemoBindingConstants.*;
  16 import static org.openhab.binding.wemo.internal.WemoUtil.*;
  17
  18 import java.io.IOException;
  19 import java.util.Collections;
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import java.util.Set;
  23 import java.util.concurrent.ScheduledFuture;
  24 import java.util.concurrent.TimeUnit;
  25
  26 import org.eclipse.jdt.annotation.NonNullByDefault;
  27 import org.eclipse.jdt.annotation.Nullable;
  28 import org.openhab.binding.wemo.internal.http.WemoHttpCall;
  29 import org.openhab.core.config.core.Configuration;
  30 import org.openhab.core.io.transport.upnp.UpnpIOService;
  31 import org.openhab.core.library.types.DecimalType;
  32 import org.openhab.core.library.types.StringType;
  33 import org.openhab.core.thing.ChannelUID;
  34 import org.openhab.core.thing.Thing;
  35 import org.openhab.core.thing.ThingStatus;
  36 import org.openhab.core.thing.ThingStatusDetail;
  37 import org.openhab.core.thing.ThingTypeUID;
  38 import org.openhab.core.types.Command;
  39 import org.openhab.core.types.RefreshType;
  40 import org.openhab.core.types.State;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * The {@link WemoCrockpotHandler} is responsible for handling commands, which are
  46  * sent to one of the channels and to update their states.
  47  *
  48  * @author Hans-Jörg Merk - Initial contribution;
  49  */
  50 @NonNullByDefault
  51 public class WemoCrockpotHandler extends WemoBaseThingHandler {
  52
  53     private final Logger logger = LoggerFactory.getLogger(WemoCrockpotHandler.class);
  54
  55     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = Collections.singleton(THING_TYPE_CROCKPOT);
  56
  57     private final Object jobLock = new Object();
  58
  59     private final Map<String, String> stateMap = Collections.synchronizedMap(new HashMap<>());
  60
  61     private @Nullable ScheduledFuture<?> pollingJob;
  62
  63     public WemoCrockpotHandler(Thing thing, UpnpIOService upnpIOService, WemoHttpCall wemoHttpCaller) {
  64         super(thing, upnpIOService, wemoHttpCaller);
  65
  66         logger.debug("Creating a WemoCrockpotHandler for thing '{}'", getThing().getUID());
  67     }
  68
  69     @Override
  70     public void initialize() {
  71         super.initialize();
  72         Configuration configuration = getConfig();
  73
  74         if (configuration.get(UDN) != null) {
  75             logger.debug("Initializing WemoCrockpotHandler for UDN '{}'", configuration.get(UDN));
  76             addSubscription(BASICEVENT);
  77             pollingJob = scheduler.scheduleWithFixedDelay(this::poll, 0, DEFAULT_REFRESH_INTERVAL_SECONDS,
  78                     TimeUnit.SECONDS);
  79             updateStatus(ThingStatus.ONLINE);
  80         } else {
  81             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
  82                     "@text/config-status.error.missing-udn");
  83             logger.debug("Cannot initalize WemoCrockpotHandler. UDN not set.");
  84         }
  85     }
  86
  87     @Override
  88     public void dispose() {
  89         logger.debug("WeMoCrockpotHandler disposed.");
  90         ScheduledFuture<?> job = this.pollingJob;
  91         if (job != null && !job.isCancelled()) {
  92             job.cancel(true);
  93         }
  94         this.pollingJob = null;
  95         super.dispose();
  96     }
  97
  98     private void poll() {
  99         synchronized (jobLock) {
 100             if (pollingJob == null) {
 101                 return;
 102             }
 103             try {
 104                 logger.debug("Polling job");
 105                 // Check if the Wemo device is set in the UPnP service registry
 106                 // If not, set the thing state to ONLINE/CONFIG-PENDING and wait for the next poll
 107                 if (!isUpnpDeviceRegistered()) {
 108                     logger.debug("UPnP device {} not yet registered", getUDN());
 109                     updateStatus(ThingStatus.ONLINE, ThingStatusDetail.CONFIGURATION_PENDING,
 110                             "@text/config-status.pending.device-not-registered [\"" + getUDN() + "\"]");
 111                     return;
 112                 }
 113                 updateWemoState();
 114             } catch (Exception e) {
 115                 logger.debug("Exception during poll: {}", e.getMessage(), e);
 116             }
 117         }
 118     }
 119
 120     @Override
 121     public void handleCommand(ChannelUID channelUID, Command command) {
 122         String wemoURL = getWemoURL(BASICACTION);
 123         if (wemoURL == null) {
 124             logger.debug("Failed to send command '{}' for device '{}': URL cannot be created", command,
 125                     getThing().getUID());
 126             return;
 127         }
 128         String mode = "0";
 129         String time = null;
 130
 131         if (command instanceof RefreshType) {
 132             updateWemoState();
 133         } else if (CHANNEL_COOKMODE.equals(channelUID.getId())) {
 134             String commandString = command.toString();
 135             switch (commandString) {
 136                 case "OFF":
 137                     mode = "0";
 138                     time = "0";
 139                     break;
 140                 case "WARM":
 141                     mode = "50";
 142                     break;
 143                 case "LOW":
 144                     mode = "51";
 145                     break;
 146                 case "HIGH":
 147                     mode = "52";
 148                     break;
 149             }
 150             try {
 151                 String soapHeader = "\"urn:Belkin:service:basicevent:1#SetBinaryState\"";
 152                 String content = "<?xml version=\"1.0\"?>"
 153                         + "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">"
 154                         + "<s:Body>" + "<u:SetCrockpotState xmlns:u=\"urn:Belkin:service:basicevent:1\">" + "<mode>"
 155                         + mode + "</mode>" + "<time>" + time + "</time>" + "</u:SetCrockpotState>" + "</s:Body>"
 156                         + "</s:Envelope>";
 157                 wemoHttpCaller.executeCall(wemoURL, soapHeader, content);
 158                 updateStatus(ThingStatus.ONLINE);
 159             } catch (IOException e) {
 160                 logger.debug("Failed to send command '{}' for device '{}':", command, getThing().getUID(), e);
 161                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
 162             }
 163         }
 164     }
 165
 166     @Override
 167     public void onValueReceived(@Nullable String variable, @Nullable String value, @Nullable String service) {
 168         logger.debug("Received pair '{}':'{}' (service '{}') for thing '{}'", variable, value, service,
 169                 this.getThing().getUID());
 170
 171         updateStatus(ThingStatus.ONLINE);
 172         if (variable != null && value != null) {
 173             this.stateMap.put(variable, value);
 174         }
 175     }
 176
 177     /**
 178      * The {@link updateWemoState} polls the actual state of a WeMo device and
 179      * calls {@link onValueReceived} to update the statemap and channels..
 180      *
 181      */
 182     protected void updateWemoState() {
 183         String actionService = BASICEVENT;
 184         String wemoURL = getWemoURL(actionService);
 185         if (wemoURL == null) {
 186             logger.warn("Failed to get actual state for device '{}': URL cannot be created", getThing().getUID());
 187             return;
 188         }
 189         try {
 190             String action = "GetCrockpotState";
 191             String soapHeader = "\"urn:Belkin:service:" + actionService + ":1#" + action + "\"";
 192             String content = createStateRequestContent(action, actionService);
 193             String wemoCallResponse = wemoHttpCaller.executeCall(wemoURL, soapHeader, content);
 194             String mode = substringBetween(wemoCallResponse, "<mode>", "</mode>");
 195             String time = substringBetween(wemoCallResponse, "<time>", "</time>");
 196             String coockedTime = substringBetween(wemoCallResponse, "<coockedTime>", "</coockedTime>");
 197
 198             State newMode = new StringType(mode);
 199             State newCoockedTime = DecimalType.valueOf(coockedTime);
 200             switch (mode) {
 201                 case "0":
 202                     newMode = new StringType("OFF");
 203                     break;
 204                 case "50":
 205                     newMode = new StringType("WARM");
 206                     State warmTime = DecimalType.valueOf(time);
 207                     updateState(CHANNEL_WARMCOOKTIME, warmTime);
 208                     break;
 209                 case "51":
 210                     newMode = new StringType("LOW");
 211                     State lowTime = DecimalType.valueOf(time);
 212                     updateState(CHANNEL_LOWCOOKTIME, lowTime);
 213                     break;
 214                 case "52":
 215                     newMode = new StringType("HIGH");
 216                     State highTime = DecimalType.valueOf(time);
 217                     updateState(CHANNEL_HIGHCOOKTIME, highTime);
 218                     break;
 219             }
 220             updateState(CHANNEL_COOKMODE, newMode);
 221             updateState(CHANNEL_COOKEDTIME, newCoockedTime);
 222             updateStatus(ThingStatus.ONLINE);
 223         } catch (IOException e) {
 224             logger.debug("Failed to get actual state for device '{}': {}", getThing().getUID(), e.getMessage(), e);
 225             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
 226         }
 227     }
 228 }