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

   1 /**
   2  * Copyright (c) 2010-2024 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.nobohub.internal.discovery;
  14
  15 import static org.openhab.binding.nobohub.internal.NoboHubBindingConstants.NOBO_HUB_BROADCAST_ADDRESS;
  16 import static org.openhab.binding.nobohub.internal.NoboHubBindingConstants.NOBO_HUB_BROADCAST_PORT;
  17 import static org.openhab.binding.nobohub.internal.NoboHubBindingConstants.NOBO_HUB_MULTICAST_PORT;
  18 import static org.openhab.binding.nobohub.internal.NoboHubBindingConstants.PROPERTY_HOSTNAME;
  19 import static org.openhab.binding.nobohub.internal.NoboHubBindingConstants.PROPERTY_NAME;
  20 import static org.openhab.binding.nobohub.internal.NoboHubBindingConstants.PROPERTY_VENDOR_NAME;
  21 import static org.openhab.binding.nobohub.internal.NoboHubBindingConstants.THING_TYPE_HUB;
  22 import static org.openhab.binding.nobohub.internal.NoboHubHandlerFactory.DISCOVERABLE_DEVICE_TYPES_UIDS;
  23
  24 import java.io.IOException;
  25 import java.net.DatagramPacket;
  26 import java.net.DatagramSocket;
  27 import java.net.InetAddress;
  28 import java.net.MulticastSocket;
  29 import java.time.Duration;
  30 import java.util.Date;
  31 import java.util.HashMap;
  32 import java.util.Map;
  33
  34 import org.eclipse.jdt.annotation.NonNullByDefault;
  35 import org.openhab.binding.nobohub.internal.NoboHubBridgeHandler;
  36 import org.openhab.core.config.discovery.AbstractThingHandlerDiscoveryService;
  37 import org.openhab.core.config.discovery.DiscoveryResult;
  38 import org.openhab.core.config.discovery.DiscoveryResultBuilder;
  39 import org.openhab.core.thing.Thing;
  40 import org.openhab.core.thing.ThingUID;
  41 import org.osgi.service.component.annotations.Component;
  42 import org.osgi.service.component.annotations.ServiceScope;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45
  46 /**
  47  * This class identifies devices that are available on the Nobø hub and adds discovery results for them.
  48  *
  49  * @author Jørgen Austvik - Initial contribution
  50  * @author Espen Fossen - Initial contribution
  51  */
  52 @NonNullByDefault
  53 @Component(scope = ServiceScope.PROTOTYPE, service = NoboHubDiscoveryService.class, configurationPid = "discovery.nobohub")
  54 public class NoboHubDiscoveryService extends AbstractThingHandlerDiscoveryService<NoboHubBridgeHandler> {
  55     private final Logger logger = LoggerFactory.getLogger(NoboHubDiscoveryService.class);
  56
  57     public NoboHubDiscoveryService() {
  58         super(NoboHubBridgeHandler.class, DISCOVERABLE_DEVICE_TYPES_UIDS, 10, true);
  59     }
  60
  61     @Override
  62     protected void startScan() {
  63         scheduler.execute(scanner);
  64     }
  65
  66     @Override
  67     protected synchronized void stopScan() {
  68         super.stopScan();
  69         removeOlderResults(getTimestampOfLastScan());
  70     }
  71
  72     @Override
  73     public void dispose() {
  74         super.dispose();
  75         removeOlderResults(new Date().getTime());
  76     }
  77
  78     private final Runnable scanner = new Runnable() {
  79         @Override
  80         public void run() {
  81             boolean found = false;
  82             logger.info("Detecting Glen Dimplex Nobø Hubs, trying Multicast");
  83             try {
  84                 MulticastSocket socket = new MulticastSocket(NOBO_HUB_MULTICAST_PORT);
  85                 found = waitOnSocket(socket, "multicast");
  86             } catch (IOException ioex) {
  87                 logger.error("Failed detecting Nobø Hub via multicast", ioex);
  88             }
  89
  90             if (!found) {
  91                 logger.debug("Detecting Glen Dimplex Nobø Hubs, trying Broadcast");
  92
  93                 try {
  94                     DatagramSocket socket = new DatagramSocket(NOBO_HUB_BROADCAST_PORT,
  95                             InetAddress.getByName(NOBO_HUB_BROADCAST_ADDRESS));
  96                     found = waitOnSocket(socket, "broadcast");
  97                 } catch (IOException ioex) {
  98                     logger.error("Failed detecting Nobø Hub via multicast, will try with Broadcast", ioex);
  99                 }
 100             }
 101         }
 102
 103         private boolean waitOnSocket(DatagramSocket socket, String type) throws IOException {
 104             try (socket) {
 105                 socket.setBroadcast(true);
 106
 107                 byte[] buffer = new byte[1024];
 108                 DatagramPacket data = new DatagramPacket(buffer, buffer.length);
 109                 String received = "";
 110                 while (!received.startsWith("__NOBOHUB__")) {
 111                     socket.setSoTimeout((int) Duration.ofSeconds(4).toMillis());
 112                     socket.receive(data);
 113                     received = new String(buffer, 0, data.getLength());
 114                 }
 115
 116                 logger.debug("Hub detection using {}: Received: {} from {}", type, received, data.getAddress());
 117
 118                 String[] parts = received.split("__", 3);
 119                 if (3 != parts.length) {
 120                     logger.debug("Data error, didn't contain three parts: '{}''", String.join("','", parts));
 121                     return false;
 122                 }
 123
 124                 String serialNumberStart = parts[parts.length - 1];
 125                 addDevice(serialNumberStart, data.getAddress().getHostName());
 126                 return true;
 127             }
 128         }
 129
 130         private void addDevice(String serialNumberStart, String hostName) {
 131             ThingUID bridge = new ThingUID(THING_TYPE_HUB, serialNumberStart);
 132             String label = "Nobø Hub " + serialNumberStart;
 133
 134             Map<String, Object> properties = new HashMap<>(4);
 135             properties.put(Thing.PROPERTY_SERIAL_NUMBER, serialNumberStart);
 136             properties.put(PROPERTY_NAME, label);
 137             properties.put(Thing.PROPERTY_VENDOR, PROPERTY_VENDOR_NAME);
 138             properties.put(PROPERTY_HOSTNAME, hostName);
 139
 140             logger.debug("Adding device {} to inbox: {} {} at {}", bridge, label, serialNumberStart, hostName);
 141             DiscoveryResult discoveryResult = DiscoveryResultBuilder.create(bridge).withLabel(label)
 142                     .withProperties(properties).withRepresentationProperty(Thing.PROPERTY_SERIAL_NUMBER).build();
 143             thingDiscovered(discoveryResult);
 144         }
 145     };
 146 }