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