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.dsmr.internal.discovery;
  14
  15 import java.util.Collection;
  16 import java.util.List;
  17 import java.util.Map.Entry;
  18 import java.util.Objects;
  19 import java.util.Set;
  20 import java.util.stream.Collectors;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.openhab.binding.dsmr.internal.device.cosem.CosemObject;
  25 import org.openhab.binding.dsmr.internal.device.cosem.CosemObjectType;
  26 import org.openhab.binding.dsmr.internal.device.p1telegram.P1Telegram;
  27 import org.openhab.binding.dsmr.internal.device.p1telegram.P1TelegramListener;
  28 import org.openhab.binding.dsmr.internal.handler.DSMRBridgeHandler;
  29 import org.openhab.binding.dsmr.internal.handler.DSMRMeterHandler;
  30 import org.openhab.binding.dsmr.internal.meter.DSMRMeterDescriptor;
  31 import org.openhab.binding.dsmr.internal.meter.DSMRMeterType;
  32 import org.openhab.core.library.types.StringType;
  33 import org.openhab.core.thing.Thing;
  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  * This implements the discovery service for new DSMR Meters on an active DSMR bridge.
  41  *
  42  * @author M. Volaart - Initial contribution
  43  * @author Hilbrand Bouwkamp - Refactored code to detect meters during actual discovery phase.
  44  */
  45 @NonNullByDefault
  46 public class DSMRMeterDiscoveryService extends DSMRDiscoveryService implements P1TelegramListener, ThingHandlerService {
  47
  48     private final Logger logger = LoggerFactory.getLogger(DSMRMeterDiscoveryService.class);
  49
  50     /**
  51      * The {@link DSMRBridgeHandler} instance
  52      */
  53     private @NonNullByDefault({}) DSMRBridgeHandler dsmrBridgeHandler;
  54
  55     /**
  56      * Constructs a new {@link DSMRMeterDiscoveryService} attached to the give bridge handler.
  57      *
  58      * @param dsmrBridgeHandler The bridge handler this discovery service is attached to
  59      */
  60     public DSMRMeterDiscoveryService() {
  61         super();
  62         this.i18nProvider = DSMRI18nProviderTracker.i18nProvider;
  63         this.localeProvider = DSMRI18nProviderTracker.localeProvider;
  64     }
  65
  66     @Override
  67     public void deactivate() {
  68         super.deactivate();
  69     }
  70
  71     @Override
  72     public @Nullable ThingHandler getThingHandler() {
  73         return dsmrBridgeHandler;
  74     }
  75
  76     @Override
  77     public void setThingHandler(ThingHandler handler) {
  78         if (handler instanceof DSMRBridgeHandler) {
  79             dsmrBridgeHandler = (DSMRBridgeHandler) handler;
  80         }
  81     }
  82
  83     @Override
  84     protected void startScan() {
  85         logger.debug("Start discovery on existing DSMR bridge.");
  86         dsmrBridgeHandler.setLenientMode(true);
  87         dsmrBridgeHandler.registerDSMRMeterListener(this);
  88     }
  89
  90     @Override
  91     protected synchronized void stopScan() {
  92         logger.debug("Stop discovery on existing DSMR bridge.");
  93         dsmrBridgeHandler.setLenientMode(false);
  94         super.stopScan();
  95         dsmrBridgeHandler.unregisterDSMRMeterListener(this);
  96     }
  97
  98     @Override
  99     public void telegramReceived(P1Telegram telegram) {
 100         if (logger.isDebugEnabled()) {
 101             logger.debug("Detect meters from #{} objects", telegram.getCosemObjects().size());
 102         }
 103         final Entry<Collection<DSMRMeterDescriptor>, List<CosemObject>> detectedMeters = meterDetector
 104                 .detectMeters(telegram);
 105         verifyUnregisteredCosemObjects(telegram, detectedMeters.getValue());
 106         validateConfiguredMeters(dsmrBridgeHandler.getThing().getThings(),
 107                 detectedMeters.getKey().stream().map(md -> md.getMeterType()).collect(Collectors.toSet()));
 108         detectedMeters.getKey().forEach(m -> meterDiscovered(m, dsmrBridgeHandler.getThing().getUID()));
 109     }
 110
 111     protected void verifyUnregisteredCosemObjects(P1Telegram telegram, List<CosemObject> list) {
 112         if (!list.isEmpty()) {
 113             if (list.stream()
 114                     .anyMatch(e -> e.getType() == CosemObjectType.METER_EQUIPMENT_IDENTIFIER
 115                             && e.getCosemValues().entrySet().stream().anyMatch(
 116                                     cv -> cv.getValue() instanceof StringType && cv.getValue().toString().isEmpty()))) {
 117                 // Unregistered meter detected. log to the user.
 118                 reportUnregisteredMeters();
 119             } else {
 120                 reportUnrecognizedCosemObjects(list);
 121                 logger.info("There are unrecognized cosem values in the data received from the meter,"
 122                         + " which means some meters might not be detected. Please report your raw data as reference: {}",
 123                         telegram.getRawTelegram());
 124             }
 125         }
 126         if (!telegram.getUnknownCosemObjects().isEmpty()) {
 127             logger.info("There are unrecognized cosem values in the data received from the meter,"
 128                     + " which means you have values that can't be read by a channel: {}. Please report them and your raw data as reference: {}",
 129                     telegram.getUnknownCosemObjects().stream()
 130                             .map(e -> String.format("obis id:%s, value:%s", e.getKey(), e.getValue()))
 131                             .collect(Collectors.joining(", ")),
 132                     telegram.getRawTelegram());
 133         }
 134     }
 135
 136     /**
 137      * Called when Unrecognized cosem objects where found. This can be a bug or a new meter not yet supported.
 138      *
 139      * @param list Map with the unrecognized.
 140      */
 141     protected void reportUnrecognizedCosemObjects(List<CosemObject> list) {
 142         list.forEach(c -> logger.info("Unrecognized cosem object '{}' found in the data: {}", c.getType(), c));
 143     }
 144
 145     /**
 146      * Called when a meter equipment identifier is found that has an empty value. This
 147      */
 148     protected void reportUnregisteredMeters() {
 149         logger.info(
 150                 "An unregistered meter has been found. Probably a new meter. Retry discovery once the meter is registered with the energy provider.");
 151     }
 152
 153     /**
 154      * Validates if the meters configured by the user match with what is detected in the telegram. Some meters are a
 155      * subset of other meters and therefore an invalid configured meter does work, but not all available data is
 156      * available to the user.
 157      *
 158      * @param things The list of configured things
 159      * @param configuredMeterTypes The set of meters detected in the telegram
 160      */
 161     private void validateConfiguredMeters(List<Thing> things, Set<DSMRMeterType> configuredMeterTypes) {
 162         // @formatter:off
 163         final Set<DSMRMeterType> configuredMeters = things.stream()
 164                 .map(Thing::getHandler)
 165                 .filter(DSMRMeterHandler.class::isInstance)
 166                 .map(DSMRMeterHandler.class::cast)
 167                 .map(DSMRMeterHandler::getMeterDescriptor)
 168                 .filter(Objects::nonNull)
 169                 .map(d -> d.getMeterType())
 170                 .collect(Collectors.toSet());
 171         // @formatter:on
 172         // Create list of all configured meters that are not in the detected list. If not empty meters might not be
 173         // correctly configured.
 174         final List<DSMRMeterType> invalidConfigured = configuredMeters.stream()
 175                 .filter(dm -> !configuredMeterTypes.contains(dm)).collect(Collectors.toList());
 176         // Create a list of all detected meters not yet configured.
 177         final List<DSMRMeterType> unconfiguredMeters = configuredMeterTypes.stream()
 178                 .filter(dm -> !configuredMeters.contains(dm)).collect(Collectors.toList());
 179
 180         if (!invalidConfigured.isEmpty()) {
 181             reportConfigurationValidationResults(invalidConfigured, unconfiguredMeters);
 182         }
 183     }
 184
 185     /**
 186      * Called when the validation finds in inconsistency between configured meters.
 187      *
 188      * @param invalidConfigured The list of invalid configured meters
 189      * @param unconfiguredMeters The list of meters that were detected, but not configured
 190      */
 191     protected void reportConfigurationValidationResults(List<DSMRMeterType> invalidConfigured,
 192             List<DSMRMeterType> unconfiguredMeters) {
 193         logger.info(
 194                 "Possible incorrect meters configured. These are configured: {}."
 195                         + "But the following unconfigured meters are found in the data received from the meter: {}",
 196                 invalidConfigured.stream().map(m -> m.name()).collect(Collectors.joining(", ")),
 197                 unconfiguredMeters.stream().map(m -> m.name()).collect(Collectors.joining(", ")));
 198     }
 199 }