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.enphase.internal.discovery;
  14
  15 import static org.openhab.binding.enphase.internal.EnphaseBindingConstants.*;
  16
  17 import java.util.HashMap;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  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.enphase.internal.EnphaseBindingConstants.EnphaseDeviceType;
  25 import org.openhab.binding.enphase.internal.dto.InventoryJsonDTO.DeviceDTO;
  26 import org.openhab.binding.enphase.internal.dto.InverterDTO;
  27 import org.openhab.binding.enphase.internal.handler.EnvoyBridgeHandler;
  28 import org.openhab.core.config.discovery.AbstractDiscoveryService;
  29 import org.openhab.core.config.discovery.DiscoveryResult;
  30 import org.openhab.core.config.discovery.DiscoveryResultBuilder;
  31 import org.openhab.core.config.discovery.DiscoveryService;
  32 import org.openhab.core.thing.ThingTypeUID;
  33 import org.openhab.core.thing.ThingUID;
  34 import org.openhab.core.thing.binding.ThingHandler;
  35 import org.openhab.core.thing.binding.ThingHandlerService;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Discovery service to discovery Enphase inverters connected to an Envoy gateway.
  41  *
  42  * @author Thomas Hentschel - Initial contribution
  43  * @author Hilbrand Bouwkamp - Initial contribution
  44  */
  45 @NonNullByDefault
  46 public class EnphaseDevicesDiscoveryService extends AbstractDiscoveryService
  47         implements ThingHandlerService, DiscoveryService {
  48
  49     private static final int TIMEOUT_SECONDS = 20;
  50
  51     private final Logger logger = LoggerFactory.getLogger(EnphaseDevicesDiscoveryService.class);
  52     private @Nullable EnvoyBridgeHandler envoyHandler;
  53
  54     public EnphaseDevicesDiscoveryService() {
  55         super(Set.of(THING_TYPE_ENPHASE_INVERTER), TIMEOUT_SECONDS, false);
  56     }
  57
  58     @Override
  59     public void setThingHandler(final @Nullable ThingHandler handler) {
  60         if (handler instanceof EnvoyBridgeHandler bridgeHandler) {
  61             envoyHandler = bridgeHandler;
  62         }
  63     }
  64
  65     @Override
  66     public @Nullable ThingHandler getThingHandler() {
  67         return envoyHandler;
  68     }
  69
  70     @Override
  71     public void deactivate() {
  72         super.deactivate();
  73     }
  74
  75     @Override
  76     protected void startScan() {
  77         removeOlderResults(getTimestampOfLastScan());
  78         final EnvoyBridgeHandler envoyHandler = this.envoyHandler;
  79
  80         if (envoyHandler == null || !envoyHandler.isOnline()) {
  81             logger.debug("Envoy handler not available or online: {}", envoyHandler);
  82             return;
  83         }
  84         final ThingUID uid = envoyHandler.getThing().getUID();
  85
  86         scanForInverterThings(envoyHandler, uid);
  87         scanForDeviceThings(envoyHandler, uid);
  88     }
  89
  90     private void scanForInverterThings(final EnvoyBridgeHandler envoyHandler, final ThingUID bridgeID) {
  91         final Map<String, @Nullable InverterDTO> inverters = envoyHandler.getInvertersData(true);
  92
  93         if (inverters == null) {
  94             logger.debug("No inverter data for Enphase inverters in discovery for Envoy {}.", bridgeID);
  95         } else {
  96             for (final Entry<String, @Nullable InverterDTO> entry : inverters.entrySet()) {
  97                 discover(bridgeID, entry.getKey(), THING_TYPE_ENPHASE_INVERTER, "Inverter ");
  98             }
  99         }
 100     }
 101
 102     /**
 103      * Scans for other device things ('other' as in: no inverters).
 104      *
 105      * @param envoyHandler
 106      * @param bridgeID
 107      */
 108     private void scanForDeviceThings(final EnvoyBridgeHandler envoyHandler, final ThingUID bridgeID) {
 109         final Map<String, @Nullable DeviceDTO> devices = envoyHandler.getDevices(true);
 110
 111         if (devices == null) {
 112             logger.debug("No device data for Enphase devices in discovery for Envoy {}.", bridgeID);
 113         } else {
 114             for (final Entry<String, @Nullable DeviceDTO> entry : devices.entrySet()) {
 115                 final DeviceDTO dto = entry.getValue();
 116                 final EnphaseDeviceType type = dto == null ? null : EnphaseDeviceType.safeValueOf(dto.type);
 117
 118                 if (type == EnphaseDeviceType.NSRB) {
 119                     discover(bridgeID, entry.getKey(), THING_TYPE_ENPHASE_RELAY, "Relay ");
 120                 }
 121             }
 122         }
 123     }
 124
 125     private void discover(final ThingUID bridgeID, final String serialNumber, final ThingTypeUID typeUID,
 126             final String label) {
 127         final String shortSerialNumber = defaultPassword(serialNumber);
 128         final ThingUID thingUID = new ThingUID(typeUID, bridgeID, shortSerialNumber);
 129         final Map<String, Object> properties = new HashMap<>(1);
 130
 131         properties.put(CONFIG_SERIAL_NUMBER, serialNumber);
 132         final DiscoveryResult discoveryResult = DiscoveryResultBuilder.create(thingUID).withBridge(bridgeID)
 133                 .withRepresentationProperty(CONFIG_SERIAL_NUMBER).withProperties(properties)
 134                 .withLabel("Enphase " + label + shortSerialNumber).build();
 135         thingDiscovered(discoveryResult);
 136     }
 137 }