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.tr064.internal;
  14
  15 import static org.openhab.binding.tr064.internal.Tr064BindingConstants.*;
  16
  17 import java.util.Date;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Set;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.openhab.binding.tr064.internal.dto.scpd.root.SCPDDeviceType;
  25 import org.openhab.core.config.discovery.AbstractDiscoveryService;
  26 import org.openhab.core.config.discovery.DiscoveryResult;
  27 import org.openhab.core.config.discovery.DiscoveryResultBuilder;
  28 import org.openhab.core.thing.ThingTypeUID;
  29 import org.openhab.core.thing.ThingUID;
  30 import org.openhab.core.thing.binding.BridgeHandler;
  31 import org.openhab.core.thing.binding.ThingHandler;
  32 import org.openhab.core.thing.binding.ThingHandlerService;
  33 import org.openhab.core.util.UIDUtils;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * The {@link Tr064DiscoveryService} discovers sub devices of a root device.
  39  *
  40  * @author Jan N. Klug - Initial contribution
  41  */
  42 @NonNullByDefault
  43 public class Tr064DiscoveryService extends AbstractDiscoveryService implements ThingHandlerService {
  44     private static final int SEARCH_TIME = 5;
  45     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = Set.of(THING_TYPE_SUBDEVICE);
  46
  47     private final Logger logger = LoggerFactory.getLogger(Tr064DiscoveryService.class);
  48     private @Nullable Tr064RootHandler bridgeHandler;
  49
  50     public Tr064DiscoveryService() {
  51         super(SEARCH_TIME);
  52     }
  53
  54     @Override
  55     public void setThingHandler(ThingHandler thingHandler) {
  56         if (thingHandler instanceof Tr064RootHandler tr064RootHandler) {
  57             this.bridgeHandler = tr064RootHandler;
  58         }
  59     }
  60
  61     @Override
  62     public @Nullable ThingHandler getThingHandler() {
  63         return bridgeHandler;
  64     }
  65
  66     @Override
  67     public void deactivate() {
  68         BridgeHandler bridgeHandler = this.bridgeHandler;
  69         if (bridgeHandler == null) {
  70             logger.warn("Bridgehandler not found, could not cleanup discovery results.");
  71             return;
  72         }
  73         removeOlderResults(new Date().getTime(), bridgeHandler.getThing().getUID());
  74     }
  75
  76     @Override
  77     public Set<ThingTypeUID> getSupportedThingTypes() {
  78         return SUPPORTED_THING_TYPES;
  79     }
  80
  81     @Override
  82     public void startScan() {
  83         Tr064RootHandler bridgeHandler = this.bridgeHandler;
  84         if (bridgeHandler == null) {
  85             logger.warn("Could not start discovery, bridge handler not set");
  86             return;
  87         }
  88         List<SCPDDeviceType> devices = bridgeHandler.getAllSubDevices();
  89         ThingUID bridgeUID = bridgeHandler.getThing().getUID();
  90         devices.forEach(device -> {
  91             logger.trace("Trying to add {} to discovery results on {}", device, bridgeUID);
  92             String udn = device.getUDN();
  93             if (udn != null) {
  94                 ThingTypeUID thingTypeUID;
  95                 if ("urn:dslforum-org:device:LANDevice:1".equals(device.getDeviceType())) {
  96                     thingTypeUID = THING_TYPE_SUBDEVICE_LAN;
  97                 } else {
  98                     thingTypeUID = THING_TYPE_SUBDEVICE;
  99                 }
 100                 ThingUID thingUID = new ThingUID(thingTypeUID, bridgeUID, UIDUtils.encode(udn));
 101
 102                 DiscoveryResult result = DiscoveryResultBuilder.create(thingUID) //
 103                         .withLabel(device.getFriendlyName()) //
 104                         .withBridge(bridgeUID) //
 105                         .withProperties(Map.of("uuid", udn, "deviceType", device.getDeviceType())) //
 106                         .withRepresentationProperty("uuid") //
 107                         .build();
 108                 thingDiscovered(result);
 109             }
 110         });
 111     }
 112
 113     @Override
 114     protected synchronized void stopScan() {
 115         super.stopScan();
 116         removeOlderResults(getTimestampOfLastScan());
 117     }
 118 }