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