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

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