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.epsonprojector.internal.discovery;
  14
  15 import static org.openhab.binding.epsonprojector.internal.EpsonProjectorBindingConstants.*;
  16
  17 import java.io.IOException;
  18 import java.net.SocketException;
  19 import java.util.Map;
  20 import java.util.Set;
  21 import java.util.concurrent.ScheduledFuture;
  22 import java.util.concurrent.TimeUnit;
  23
  24 import org.eclipse.jdt.annotation.NonNullByDefault;
  25 import org.eclipse.jdt.annotation.Nullable;
  26 import org.openhab.core.config.discovery.AbstractDiscoveryService;
  27 import org.openhab.core.config.discovery.DiscoveryResultBuilder;
  28 import org.openhab.core.config.discovery.DiscoveryService;
  29 import org.openhab.core.net.NetworkAddressService;
  30 import org.openhab.core.thing.ThingTypeUID;
  31 import org.openhab.core.thing.ThingUID;
  32 import org.osgi.service.component.annotations.Activate;
  33 import org.osgi.service.component.annotations.Component;
  34 import org.osgi.service.component.annotations.Reference;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39  * The {@link EpsonProjectoreDiscoveryService} class implements a service
  40  * for discovering Epson projectors using the AMX Device Discovery protocol.
  41  *
  42  * @author Mark Hilbush - Initial contribution
  43  * @author Michael Lobstein - Adapted for the Epson Projector binding
  44  */
  45 @NonNullByDefault
  46 @Component(service = DiscoveryService.class, configurationPid = "discovery.epsonprojector")
  47 public class EpsonProjectorDiscoveryService extends AbstractDiscoveryService {
  48     private final Logger logger = LoggerFactory.getLogger(EpsonProjectorDiscoveryService.class);
  49     private @Nullable ScheduledFuture<?> epsonDiscoveryJob;
  50
  51     // Discovery parameters
  52     public static final boolean BACKGROUND_DISCOVERY_ENABLED = true;
  53     public static final int BACKGROUND_DISCOVERY_DELAY_TIMEOUT_SEC = 10;
  54
  55     private NetworkAddressService networkAddressService;
  56
  57     private boolean terminate = false;
  58
  59     @Activate
  60     public EpsonProjectorDiscoveryService(@Reference NetworkAddressService networkAddressService) {
  61         super(SUPPORTED_THING_TYPES_UIDS, 0, BACKGROUND_DISCOVERY_ENABLED);
  62         this.networkAddressService = networkAddressService;
  63         epsonDiscoveryJob = null;
  64         terminate = false;
  65     }
  66
  67     @Override
  68     public Set<ThingTypeUID> getSupportedThingTypes() {
  69         return SUPPORTED_THING_TYPES_UIDS;
  70     }
  71
  72     @Override
  73     protected void startBackgroundDiscovery() {
  74         if (epsonDiscoveryJob == null) {
  75             terminate = false;
  76             logger.debug("Starting background discovery job in {} seconds", BACKGROUND_DISCOVERY_DELAY_TIMEOUT_SEC);
  77             epsonDiscoveryJob = scheduler.schedule(this::discover, BACKGROUND_DISCOVERY_DELAY_TIMEOUT_SEC,
  78                     TimeUnit.SECONDS);
  79         }
  80     }
  81
  82     @Override
  83     protected void stopBackgroundDiscovery() {
  84         ScheduledFuture<?> epsonDiscoveryJob = this.epsonDiscoveryJob;
  85         if (epsonDiscoveryJob != null) {
  86             terminate = true;
  87             epsonDiscoveryJob.cancel(false);
  88             this.epsonDiscoveryJob = null;
  89         }
  90     }
  91
  92     @Override
  93     public void startScan() {
  94     }
  95
  96     @Override
  97     public void stopScan() {
  98     }
  99
 100     private synchronized void discover() {
 101         logger.debug("Discovery job is running");
 102         MulticastListener epsonMulticastListener;
 103         String local = "127.0.0.1";
 104
 105         try {
 106             String ip = networkAddressService.getPrimaryIpv4HostAddress();
 107             epsonMulticastListener = new MulticastListener((ip != null ? ip : local));
 108         } catch (SocketException se) {
 109             logger.debug("Discovery job got Socket exception creating multicast socket: {}", se.getMessage());
 110             return;
 111         } catch (IOException ioe) {
 112             logger.debug("Discovery job got IO exception creating multicast socket: {}", ioe.getMessage());
 113             return;
 114         }
 115
 116         while (!terminate) {
 117             try {
 118                 // Wait for a discovery beacon to return properties for an Epson projector.
 119                 Map<String, Object> thingProperties = epsonMulticastListener.waitForBeacon();
 120
 121                 if (thingProperties != null) {
 122                     // The MulticastListener found a projector, add it as new thing
 123                     String uid = (String) thingProperties.get(THING_PROPERTY_MAC);
 124                     String ipAddress = (String) thingProperties.get(THING_PROPERTY_HOST);
 125
 126                     if (uid != null) {
 127                         logger.trace("Projector with UID {} discovered at IP: {}", uid, ipAddress);
 128
 129                         ThingUID thingUid = new ThingUID(THING_TYPE_PROJECTOR_TCP, uid);
 130                         logger.trace("Creating epson projector discovery result for: {}, IP={}", uid, ipAddress);
 131                         thingDiscovered(DiscoveryResultBuilder.create(thingUid).withProperties(thingProperties)
 132                                 .withLabel("Epson Projector " + uid).withRepresentationProperty(THING_PROPERTY_MAC)
 133                                 .build());
 134                     }
 135                 }
 136             } catch (IOException ioe) {
 137                 logger.debug("Discovery job got exception waiting for beacon: {}", ioe.getMessage());
 138             }
 139         }
 140         epsonMulticastListener.shutdown();
 141         logger.debug("Discovery job is exiting");
 142     }
 143 }