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.nest.internal.wwn.discovery;
  14
  15 import static org.openhab.binding.nest.internal.wwn.WWNBindingConstants.*;
  16 import static org.openhab.core.thing.Thing.PROPERTY_FIRMWARE_VERSION;
  17
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Set;
  21 import java.util.function.BiConsumer;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.openhab.binding.nest.internal.wwn.config.WWNDeviceConfiguration;
  26 import org.openhab.binding.nest.internal.wwn.config.WWNStructureConfiguration;
  27 import org.openhab.binding.nest.internal.wwn.dto.BaseWWNDevice;
  28 import org.openhab.binding.nest.internal.wwn.dto.WWNCamera;
  29 import org.openhab.binding.nest.internal.wwn.dto.WWNSmokeDetector;
  30 import org.openhab.binding.nest.internal.wwn.dto.WWNStructure;
  31 import org.openhab.binding.nest.internal.wwn.dto.WWNThermostat;
  32 import org.openhab.binding.nest.internal.wwn.handler.WWNAccountHandler;
  33 import org.openhab.binding.nest.internal.wwn.listener.WWNThingDataListener;
  34 import org.openhab.core.config.discovery.AbstractDiscoveryService;
  35 import org.openhab.core.config.discovery.DiscoveryResultBuilder;
  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 /**
  44  * This service connects to the Nest account and creates the correct discovery results for devices
  45  * as they are found through the WWN API.
  46  *
  47  * @author David Bennett - Initial contribution
  48  * @author Wouter Born - Add representation properties
  49  */
  50 @NonNullByDefault
  51 public class WWNDiscoveryService extends AbstractDiscoveryService implements ThingHandlerService {
  52
  53     private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = Set.of(THING_TYPE_CAMERA, THING_TYPE_THERMOSTAT,
  54             THING_TYPE_SMOKE_DETECTOR, THING_TYPE_STRUCTURE);
  55
  56     private final Logger logger = LoggerFactory.getLogger(WWNDiscoveryService.class);
  57
  58     private final DiscoveryDataListener<WWNCamera> cameraDiscoveryDataListener = new DiscoveryDataListener<>(
  59             WWNCamera.class, THING_TYPE_CAMERA, this::addDeviceDiscoveryResult);
  60     private final DiscoveryDataListener<WWNSmokeDetector> smokeDetectorDiscoveryDataListener = new DiscoveryDataListener<>(
  61             WWNSmokeDetector.class, THING_TYPE_SMOKE_DETECTOR, this::addDeviceDiscoveryResult);
  62     private final DiscoveryDataListener<WWNStructure> structureDiscoveryDataListener = new DiscoveryDataListener<>(
  63             WWNStructure.class, THING_TYPE_STRUCTURE, this::addStructureDiscoveryResult);
  64     private final DiscoveryDataListener<WWNThermostat> thermostatDiscoveryDataListener = new DiscoveryDataListener<>(
  65             WWNThermostat.class, THING_TYPE_THERMOSTAT, this::addDeviceDiscoveryResult);
  66
  67     @SuppressWarnings("rawtypes")
  68     private final List<DiscoveryDataListener> discoveryDataListeners = List.of(cameraDiscoveryDataListener,
  69             smokeDetectorDiscoveryDataListener, structureDiscoveryDataListener, thermostatDiscoveryDataListener);
  70
  71     private @NonNullByDefault({}) WWNAccountHandler accountHandler;
  72
  73     private static class DiscoveryDataListener<T> implements WWNThingDataListener<T> {
  74         private Class<T> dataClass;
  75         private ThingTypeUID thingTypeUID;
  76         private BiConsumer<T, ThingTypeUID> onDiscovered;
  77
  78         private DiscoveryDataListener(Class<T> dataClass, ThingTypeUID thingTypeUID,
  79                 BiConsumer<T, ThingTypeUID> onDiscovered) {
  80             this.dataClass = dataClass;
  81             this.thingTypeUID = thingTypeUID;
  82             this.onDiscovered = onDiscovered;
  83         }
  84
  85         @Override
  86         public void onNewData(T data) {
  87             onDiscovered.accept(data, thingTypeUID);
  88         }
  89
  90         @Override
  91         public void onUpdatedData(T oldData, T data) {
  92         }
  93
  94         @Override
  95         public void onMissingData(String nestId) {
  96         }
  97     }
  98
  99     public WWNDiscoveryService() {
 100         super(SUPPORTED_THING_TYPES, 60, true);
 101     }
 102
 103     @Override
 104     @SuppressWarnings("unchecked")
 105     public void activate() {
 106         discoveryDataListeners.forEach(listener -> accountHandler.addThingDataListener(listener.dataClass, listener));
 107         addDiscoveryResultsFromLastUpdates();
 108     }
 109
 110     @Override
 111     @SuppressWarnings("unchecked")
 112     public void deactivate() {
 113         discoveryDataListeners
 114                 .forEach(listener -> accountHandler.removeThingDataListener(listener.dataClass, listener));
 115     }
 116
 117     @Override
 118     public @Nullable ThingHandler getThingHandler() {
 119         return accountHandler;
 120     }
 121
 122     @Override
 123     public void setThingHandler(ThingHandler handler) {
 124         if (handler instanceof WWNAccountHandler) {
 125             accountHandler = (WWNAccountHandler) handler;
 126         }
 127     }
 128
 129     @Override
 130     protected void startScan() {
 131         addDiscoveryResultsFromLastUpdates();
 132     }
 133
 134     @SuppressWarnings("unchecked")
 135     private void addDiscoveryResultsFromLastUpdates() {
 136         discoveryDataListeners.forEach(listener -> addDiscoveryResultsFromLastUpdates(listener.dataClass,
 137                 listener.thingTypeUID, listener.onDiscovered));
 138     }
 139
 140     private <T> void addDiscoveryResultsFromLastUpdates(Class<T> dataClass, ThingTypeUID thingTypeUID,
 141             BiConsumer<T, ThingTypeUID> onDiscovered) {
 142         List<T> lastUpdates = accountHandler.getLastUpdates(dataClass);
 143         lastUpdates.forEach(lastUpdate -> onDiscovered.accept(lastUpdate, thingTypeUID));
 144     }
 145
 146     private void addDeviceDiscoveryResult(BaseWWNDevice device, ThingTypeUID typeUID) {
 147         ThingUID bridgeUID = accountHandler.getThing().getUID();
 148         ThingUID thingUID = new ThingUID(typeUID, bridgeUID, device.getDeviceId());
 149         logger.debug("Discovered {}", thingUID);
 150         Map<String, Object> properties = Map.of(WWNDeviceConfiguration.DEVICE_ID, device.getDeviceId(),
 151                 PROPERTY_FIRMWARE_VERSION, device.getSoftwareVersion());
 152         thingDiscovered(DiscoveryResultBuilder.create(thingUID) //
 153                 .withThingType(typeUID) //
 154                 .withLabel(device.getNameLong()) //
 155                 .withBridge(bridgeUID) //
 156                 .withProperties(properties) //
 157                 .withRepresentationProperty(WWNDeviceConfiguration.DEVICE_ID) //
 158                 .build() //
 159         );
 160     }
 161
 162     public void addStructureDiscoveryResult(WWNStructure structure, ThingTypeUID typeUID) {
 163         ThingUID bridgeUID = accountHandler.getThing().getUID();
 164         ThingUID thingUID = new ThingUID(typeUID, bridgeUID, structure.getStructureId());
 165         logger.debug("Discovered {}", thingUID);
 166         Map<String, Object> properties = Map.of(WWNStructureConfiguration.STRUCTURE_ID, structure.getStructureId());
 167         thingDiscovered(DiscoveryResultBuilder.create(thingUID) //
 168                 .withThingType(THING_TYPE_STRUCTURE) //
 169                 .withLabel(structure.getName()) //
 170                 .withBridge(bridgeUID) //
 171                 .withProperties(properties) //
 172                 .withRepresentationProperty(WWNStructureConfiguration.STRUCTURE_ID) //
 173                 .build() //
 174         );
 175     }
 176 }