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

   1 /**
   2  * Copyright (c) 2010-2020 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
  14 package org.openhab.binding.touchwand.internal.discovery;
  15
  16 import static org.openhab.binding.touchwand.internal.TouchWandBindingConstants.*;
  17
  18 import java.util.Arrays;
  19 import java.util.Date;
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import java.util.concurrent.CopyOnWriteArraySet;
  23 import java.util.concurrent.ScheduledFuture;
  24 import java.util.concurrent.TimeUnit;
  25
  26 import org.eclipse.jdt.annotation.NonNull;
  27 import org.eclipse.jdt.annotation.NonNullByDefault;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.openhab.binding.touchwand.internal.TouchWandBridgeHandler;
  30 import org.openhab.binding.touchwand.internal.TouchWandUnitStatusUpdateListener;
  31 import org.openhab.binding.touchwand.internal.dto.TouchWandUnitData;
  32 import org.openhab.binding.touchwand.internal.dto.TouchWandUnitFromJson;
  33 import org.openhab.core.config.discovery.AbstractDiscoveryService;
  34 import org.openhab.core.config.discovery.DiscoveryResultBuilder;
  35 import org.openhab.core.config.discovery.DiscoveryService;
  36 import org.openhab.core.thing.ThingStatus;
  37 import org.openhab.core.thing.ThingTypeUID;
  38 import org.openhab.core.thing.ThingUID;
  39 import org.openhab.core.thing.binding.ThingHandler;
  40 import org.openhab.core.thing.binding.ThingHandlerService;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 import com.google.gson.JsonArray;
  45 import com.google.gson.JsonElement;
  46 import com.google.gson.JsonParser;
  47 import com.google.gson.JsonSyntaxException;
  48
  49 /**
  50  * The {@link TouchWandUnitDiscoveryService} Discovery service for TouchWand units.
  51  *
  52  * @author Roie Geron - Initial contribution
  53  */
  54 @NonNullByDefault
  55 public class TouchWandUnitDiscoveryService extends AbstractDiscoveryService
  56         implements DiscoveryService, ThingHandlerService {
  57
  58     private static final int SEARCH_TIME_SEC = 10;
  59     private static final int SCAN_INTERVAL_SEC = 60;
  60     private static final int LINK_DISCOVERY_SERVICE_INITIAL_DELAY_SEC = 5;
  61     private static final String[] CONNECTIVITY_OPTIONS = { CONNECTIVITY_KNX, CONNECTIVITY_ZWAVE };
  62     private @NonNullByDefault({}) TouchWandBridgeHandler touchWandBridgeHandler;
  63     private final Logger logger = LoggerFactory.getLogger(TouchWandUnitDiscoveryService.class);
  64
  65     private @Nullable ScheduledFuture<?> scanningJob;
  66     private CopyOnWriteArraySet<TouchWandUnitStatusUpdateListener> listeners = new CopyOnWriteArraySet<>();
  67
  68     public TouchWandUnitDiscoveryService() {
  69         super(SUPPORTED_THING_TYPES_UIDS, SEARCH_TIME_SEC, true);
  70     }
  71
  72     @Override
  73     protected void startScan() {
  74         if (touchWandBridgeHandler.getThing().getStatus() != ThingStatus.ONLINE) {
  75             logger.warn("Could not scan units while bridge offline");
  76             return;
  77         }
  78
  79         logger.debug("Starting TouchWand discovery on bridge {}", touchWandBridgeHandler.getThing().getUID());
  80         String response = touchWandBridgeHandler.touchWandClient.cmdListUnits();
  81         if (response.isEmpty()) {
  82             return;
  83         }
  84
  85         JsonParser jsonParser = new JsonParser();
  86         try {
  87             JsonArray jsonArray = jsonParser.parse(response).getAsJsonArray();
  88             if (jsonArray.isJsonArray()) {
  89                 try {
  90                     for (JsonElement unit : jsonArray) {
  91                         TouchWandUnitData touchWandUnit;
  92                         touchWandUnit = TouchWandUnitFromJson.parseResponse(unit.getAsJsonObject());
  93
  94                         if (!touchWandBridgeHandler.isAddSecondaryControllerUnits()) {
  95                             if (!Arrays.asList(CONNECTIVITY_OPTIONS).contains(touchWandUnit.getConnectivity())) {
  96                                 continue;
  97                             }
  98                         }
  99                         String type = touchWandUnit.getType();
 100                         if (!Arrays.asList(SUPPORTED_TOUCHWAND_TYPES).contains(type)) {
 101                             logger.debug("Unit discovery skipping unsupported unit type : {} ", type);
 102                             continue;
 103                         }
 104                         switch (type) {
 105                             case TYPE_WALLCONTROLLER:
 106                                 addDeviceDiscoveryResult(touchWandUnit, THING_TYPE_WALLCONTROLLER);
 107                                 break;
 108                             case TYPE_SWITCH:
 109                                 addDeviceDiscoveryResult(touchWandUnit, THING_TYPE_SWITCH);
 110                                 notifyListeners(touchWandUnit);
 111                                 break;
 112                             case TYPE_DIMMER:
 113                                 addDeviceDiscoveryResult(touchWandUnit, THING_TYPE_DIMMER);
 114                                 notifyListeners(touchWandUnit);
 115                                 break;
 116                             case TYPE_SHUTTER:
 117                                 addDeviceDiscoveryResult(touchWandUnit, THING_TYPE_SHUTTER);
 118                                 break;
 119                             case TYPE_ALARMSENSOR:
 120                                 addDeviceDiscoveryResult(touchWandUnit, THING_TYPE_ALARMSENSOR);
 121                                 break;
 122                             default:
 123                                 continue;
 124                         }
 125                     }
 126                 } catch (JsonSyntaxException e) {
 127                     logger.warn("Could not parse unit {}", e.getMessage());
 128                 }
 129             }
 130         } catch (JsonSyntaxException msg) {
 131             logger.warn("Could not parse list units response {}", msg.getMessage());
 132         }
 133     }
 134
 135     private void notifyListeners(TouchWandUnitData touchWandUnit) {
 136         for (TouchWandUnitStatusUpdateListener listener : listeners) {
 137             listener.onDataReceived(touchWandUnit);
 138         }
 139     }
 140
 141     @Override
 142     protected void stopScan() {
 143         removeOlderResults(getTimestampOfLastScan());
 144         super.stopScan();
 145     }
 146
 147     @Override
 148     public void activate() {
 149         super.activate(null);
 150         removeOlderResults(new Date().getTime(), touchWandBridgeHandler.getThing().getUID());
 151     }
 152
 153     @Override
 154     public void deactivate() {
 155         removeOlderResults(new Date().getTime(), touchWandBridgeHandler.getThing().getUID());
 156         super.deactivate();
 157     }
 158
 159     @Override
 160     protected void startBackgroundDiscovery() {
 161         ScheduledFuture<?> localScanningJob = scanningJob;
 162         if (localScanningJob == null || localScanningJob.isCancelled()) {
 163             scanningJob = scheduler.scheduleWithFixedDelay(this::startScan, LINK_DISCOVERY_SERVICE_INITIAL_DELAY_SEC,
 164                     SCAN_INTERVAL_SEC, TimeUnit.SECONDS);
 165         }
 166     }
 167
 168     @Override
 169     protected void stopBackgroundDiscovery() {
 170         ScheduledFuture<?> myScanningJob = scanningJob;
 171         if (myScanningJob != null) {
 172             myScanningJob.cancel(true);
 173             scanningJob = null;
 174         }
 175     }
 176
 177     public void registerListener(TouchWandUnitStatusUpdateListener listener) {
 178         if (!listeners.contains(listener)) {
 179             logger.debug("Adding TouchWandWebSocket listener {}", listener);
 180             listeners.add(listener);
 181         }
 182     }
 183
 184     public void unregisterListener(TouchWandUnitStatusUpdateListener listener) {
 185         logger.debug("Removing TouchWandWebSocket listener {}", listener);
 186         listeners.remove(listener);
 187     }
 188
 189     @Override
 190     public int getScanTimeout() {
 191         return SEARCH_TIME_SEC;
 192     }
 193
 194     private void addDeviceDiscoveryResult(TouchWandUnitData unit, ThingTypeUID typeUID) {
 195         ThingUID bridgeUID = touchWandBridgeHandler.getThing().getUID();
 196         ThingUID thingUID = new ThingUID(typeUID, bridgeUID, unit.getId().toString());
 197         Map<String, Object> properties = new HashMap<>();
 198         properties.put(HANDLER_PROPERTIES_ID, unit.getId().toString());
 199         properties.put(HANDLER_PROPERTIES_NAME, unit.getName());
 200         // @formatter:off
 201         thingDiscovered(DiscoveryResultBuilder.create(thingUID)
 202                 .withThingType(typeUID)
 203                 .withLabel(unit.getName())
 204                 .withBridge(bridgeUID)
 205                 .withProperties(properties)
 206                 .withRepresentationProperty(HANDLER_PROPERTIES_ID)
 207                 .build()
 208         );
 209         // @formatter:on
 210     }
 211
 212     @Override
 213     public void setThingHandler(@NonNullByDefault({}) ThingHandler handler) {
 214         if (handler instanceof TouchWandBridgeHandler) {
 215             touchWandBridgeHandler = (TouchWandBridgeHandler) handler;
 216             registerListener(touchWandBridgeHandler);
 217         }
 218     }
 219
 220     @Override
 221     public @NonNull ThingHandler getThingHandler() {
 222         return touchWandBridgeHandler;
 223     }
 224 }