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.smaenergymeter.internal.handler;
  14
  15 import static org.openhab.binding.smaenergymeter.internal.SMAEnergyMeterBindingConstants.*;
  16
  17 import java.io.IOException;
  18 import java.util.concurrent.TimeUnit;
  19
  20 import org.eclipse.jdt.annotation.Nullable;
  21 import org.openhab.binding.smaenergymeter.internal.configuration.EnergyMeterConfig;
  22 import org.openhab.binding.smaenergymeter.internal.packet.FilteringPayloadHandler;
  23 import org.openhab.binding.smaenergymeter.internal.packet.PacketListener;
  24 import org.openhab.binding.smaenergymeter.internal.packet.PacketListenerRegistry;
  25 import org.openhab.binding.smaenergymeter.internal.packet.PayloadHandler;
  26 import org.openhab.binding.smaenergymeter.internal.packet.ThrottlingPayloadHandler;
  27 import org.openhab.core.thing.ChannelUID;
  28 import org.openhab.core.thing.Thing;
  29 import org.openhab.core.thing.ThingStatus;
  30 import org.openhab.core.thing.ThingStatusDetail;
  31 import org.openhab.core.thing.binding.BaseThingHandler;
  32 import org.openhab.core.types.Command;
  33 import org.openhab.core.types.RefreshType;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * The {@link SMAEnergyMeterHandler} is responsible for handling commands, which are
  39  * sent to one of the channels.
  40  *
  41  * @author Osman Basha - Initial contribution
  42  */
  43 public class SMAEnergyMeterHandler extends BaseThingHandler implements PayloadHandler {
  44
  45     private final Logger logger = LoggerFactory.getLogger(SMAEnergyMeterHandler.class);
  46     private final PacketListenerRegistry listenerRegistry;
  47     private @Nullable PacketListener listener;
  48     private @Nullable PayloadHandler handler;
  49     private String serialNumber;
  50
  51     public SMAEnergyMeterHandler(Thing thing, PacketListenerRegistry listenerRegistry) {
  52         super(thing);
  53         this.listenerRegistry = listenerRegistry;
  54     }
  55
  56     @Override
  57     public void handleCommand(ChannelUID channelUID, Command command) {
  58         if (command == RefreshType.REFRESH) {
  59             logger.debug("Refreshing {}", channelUID);
  60             PacketListener listener = this.listener;
  61             if (listener != null) {
  62                 listener.request();
  63             }
  64         } else {
  65             logger.warn("This binding is a read-only binding and cannot handle commands");
  66         }
  67     }
  68
  69     @Override
  70     public void initialize() {
  71         logger.debug("Initializing SMAEnergyMeter handler '{}'", getThing().getUID());
  72
  73         EnergyMeterConfig config = getConfigAs(EnergyMeterConfig.class);
  74
  75         try {
  76             serialNumber = config.getSerialNumber();
  77             if (serialNumber == null) {
  78                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_PENDING,
  79                         "Meter serial number missing");
  80                 return;
  81             }
  82             String mcastGroup = config.getMcastGroup();
  83             if (mcastGroup == null) {
  84                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_PENDING, "mcast group is missing");
  85                 return;
  86             }
  87             PacketListener listener = listenerRegistry.getListener(mcastGroup, config.getPort());
  88             updateStatus(ThingStatus.UNKNOWN);
  89             logger.debug("Activated handler for SMA Energy Meter with S/N '{}'", serialNumber);
  90
  91             if (config.getPollingPeriod() <= 1) {
  92                 listener.addPayloadHandler(handler = new FilteringPayloadHandler(this, serialNumber));
  93             } else {
  94                 listener.addPayloadHandler(handler = new FilteringPayloadHandler(
  95                         new ThrottlingPayloadHandler(this, TimeUnit.SECONDS.toMillis(config.getPollingPeriod())),
  96                         serialNumber));
  97             }
  98             this.listener = listener;
  99             logger.debug("Polling job scheduled to run every {} sec. for '{}'", config.getPollingPeriod(),
 100                     getThing().getUID());
 101             // we do not set online status here, it will be set only when data is received
 102         } catch (IOException e) {
 103             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.CONFIGURATION_ERROR, e.getMessage());
 104         }
 105     }
 106
 107     @Override
 108     public void dispose() {
 109         logger.debug("Disposing SMAEnergyMeter handler '{}'", getThing().getUID());
 110         PacketListener listener = this.listener;
 111         PayloadHandler handler = this.handler;
 112         if (listener != null && handler != null) {
 113             listener.removePayloadHandler(handler);
 114             this.listener = null;
 115         }
 116     }
 117
 118     @Override
 119     public void handle(EnergyMeter energyMeter) {
 120         updateStatus(ThingStatus.ONLINE);
 121
 122         logger.debug("Update SMAEnergyMeter {} data '{}'", serialNumber, getThing().getUID());
 123
 124         updateState(CHANNEL_POWER_IN, energyMeter.getPowerIn());
 125         updateState(CHANNEL_POWER_OUT, energyMeter.getPowerOut());
 126         updateState(CHANNEL_ENERGY_IN, energyMeter.getEnergyIn());
 127         updateState(CHANNEL_ENERGY_OUT, energyMeter.getEnergyOut());
 128
 129         updateState(CHANNEL_POWER_IN_L1, energyMeter.getPowerInL1());
 130         updateState(CHANNEL_POWER_OUT_L1, energyMeter.getPowerOutL1());
 131         updateState(CHANNEL_ENERGY_IN_L1, energyMeter.getEnergyInL1());
 132         updateState(CHANNEL_ENERGY_OUT_L1, energyMeter.getEnergyOutL1());
 133
 134         updateState(CHANNEL_POWER_IN_L2, energyMeter.getPowerInL2());
 135         updateState(CHANNEL_POWER_OUT_L2, energyMeter.getPowerOutL2());
 136         updateState(CHANNEL_ENERGY_IN_L2, energyMeter.getEnergyInL2());
 137         updateState(CHANNEL_ENERGY_OUT_L2, energyMeter.getEnergyOutL2());
 138
 139         updateState(CHANNEL_POWER_IN_L3, energyMeter.getPowerInL3());
 140         updateState(CHANNEL_POWER_OUT_L3, energyMeter.getPowerOutL3());
 141         updateState(CHANNEL_ENERGY_IN_L3, energyMeter.getEnergyInL3());
 142         updateState(CHANNEL_ENERGY_OUT_L3, energyMeter.getEnergyOutL3());
 143     }
 144 }