git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2021 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.fronius.internal.handler;
  14
  15 import java.util.Map;
  16
  17 import org.openhab.binding.fronius.internal.FroniusBaseDeviceConfiguration;
  18 import org.openhab.binding.fronius.internal.FroniusBindingConstants;
  19 import org.openhab.binding.fronius.internal.FroniusBridgeConfiguration;
  20 import org.openhab.binding.fronius.internal.api.MeterRealtimeBodyDataDTO;
  21 import org.openhab.binding.fronius.internal.api.MeterRealtimeResponseDTO;
  22 import org.openhab.core.library.types.QuantityType;
  23 import org.openhab.core.library.unit.Units;
  24 import org.openhab.core.thing.Thing;
  25
  26 /**
  27  * The {@link FroniusMeterHandler} is responsible for updating the data, which are
  28  * sent to one of the channels.
  29  *
  30  * @author Jimmy Tanagra - Initial contribution
  31  * @author Thomas Kordelle - Actually constants should be all upper case.
  32  */
  33 public class FroniusMeterHandler extends FroniusBaseThingHandler {
  34
  35     private MeterRealtimeBodyDataDTO meterRealtimeBodyData;
  36     private FroniusBaseDeviceConfiguration config;
  37
  38     public FroniusMeterHandler(Thing thing) {
  39         super(thing);
  40     }
  41
  42     @Override
  43     protected String getDescription() {
  44         return "Fronius Smart Meter";
  45     }
  46
  47     @Override
  48     public void refresh(FroniusBridgeConfiguration bridgeConfiguration) {
  49         updateData(bridgeConfiguration, config);
  50         updateChannels();
  51         updateProperties();
  52     }
  53
  54     @Override
  55     public void initialize() {
  56         config = getConfigAs(FroniusBaseDeviceConfiguration.class);
  57         super.initialize();
  58     }
  59
  60     /**
  61      * Update the channel from the last data retrieved
  62      *
  63      * @param channelId the id identifying the channel to be updated
  64      * @return the last retrieved data
  65      */
  66     @Override
  67     protected Object getValue(String channelId) {
  68         if (meterRealtimeBodyData == null) {
  69             return null;
  70         }
  71
  72         final String[] fields = channelId.split("#");
  73         if (fields.length < 1) {
  74             return null;
  75         }
  76         final String fieldName = fields[0];
  77
  78         switch (fieldName) {
  79             case FroniusBindingConstants.METER_ENABLE:
  80                 return meterRealtimeBodyData.getEnable();
  81             case FroniusBindingConstants.METER_LOCATION:
  82                 return meterRealtimeBodyData.getMeterLocationCurrent();
  83             case FroniusBindingConstants.METER_CURRENT_AC_PHASE_1:
  84                 return new QuantityType<>(meterRealtimeBodyData.getCurrentACPhase1(), Units.AMPERE);
  85             case FroniusBindingConstants.METER_CURRENT_AC_PHASE_2:
  86                 return new QuantityType<>(meterRealtimeBodyData.getCurrentACPhase2(), Units.AMPERE);
  87             case FroniusBindingConstants.METER_CURRENT_AC_PHASE_3:
  88                 return new QuantityType<>(meterRealtimeBodyData.getCurrentACPhase3(), Units.AMPERE);
  89             case FroniusBindingConstants.METER_VOLTAGE_AC_PHASE_1:
  90                 return new QuantityType<>(meterRealtimeBodyData.getVoltageACPhase1(), Units.VOLT);
  91             case FroniusBindingConstants.METER_VOLTAGE_AC_PHASE_2:
  92                 return new QuantityType<>(meterRealtimeBodyData.getVoltageACPhase2(), Units.VOLT);
  93             case FroniusBindingConstants.METER_VOLTAGE_AC_PHASE_3:
  94                 return new QuantityType<>(meterRealtimeBodyData.getVoltageACPhase3(), Units.VOLT);
  95             case FroniusBindingConstants.METER_POWER_PHASE_1:
  96                 return new QuantityType<>(meterRealtimeBodyData.getPowerRealPPhase1(), Units.WATT);
  97             case FroniusBindingConstants.METER_POWER_PHASE_2:
  98                 return new QuantityType<>(meterRealtimeBodyData.getPowerRealPPhase2(), Units.WATT);
  99             case FroniusBindingConstants.METER_POWER_PHASE_3:
 100                 return new QuantityType<>(meterRealtimeBodyData.getPowerRealPPhase3(), Units.WATT);
 101             case FroniusBindingConstants.METER_POWER_FACTOR_PHASE_1:
 102                 return meterRealtimeBodyData.getPowerFactorPhase1();
 103             case FroniusBindingConstants.METER_POWER_FACTOR_PHASE_2:
 104                 return meterRealtimeBodyData.getPowerFactorPhase2();
 105             case FroniusBindingConstants.METER_POWER_FACTOR_PHASE_3:
 106                 return meterRealtimeBodyData.getPowerFactorPhase3();
 107             case FroniusBindingConstants.METER_ENERGY_REAL_SUM_CONSUMED:
 108                 return new QuantityType<>(meterRealtimeBodyData.getEnergyRealWACSumConsumed(), Units.WATT_HOUR);
 109             case FroniusBindingConstants.METER_ENERGY_REAL_SUM_PRODUCED:
 110                 return new QuantityType<>(meterRealtimeBodyData.getEnergyRealWACSumProduced(), Units.WATT_HOUR);
 111             default:
 112                 break;
 113         }
 114
 115         return null;
 116     }
 117
 118     private void updateProperties() {
 119         if (meterRealtimeBodyData == null) {
 120             return;
 121         }
 122
 123         Map<String, String> properties = editProperties();
 124
 125         properties.put(FroniusBindingConstants.METER_MODEL, meterRealtimeBodyData.getDetails().getModel());
 126         properties.put(FroniusBindingConstants.METER_SERIAL, meterRealtimeBodyData.getDetails().getSerial());
 127
 128         updateProperties(properties);
 129     }
 130
 131     /**
 132      * Get new data
 133      */
 134     private void updateData(FroniusBridgeConfiguration bridgeConfiguration, FroniusBaseDeviceConfiguration config) {
 135         MeterRealtimeResponseDTO meterRealtimeResponse = getMeterRealtimeData(bridgeConfiguration.hostname,
 136                 config.deviceId);
 137         if (meterRealtimeResponse == null) {
 138             meterRealtimeBodyData = null;
 139         } else {
 140             meterRealtimeBodyData = meterRealtimeResponse.getBody().getData();
 141         }
 142     }
 143
 144     /**
 145      * Make the MeterRealtimeData request
 146      *
 147      * @param ip address of the device
 148      * @param deviceId of the device
 149      * @return {MeterRealtimeResponse} the object representation of the json response
 150      */
 151     private MeterRealtimeResponseDTO getMeterRealtimeData(String ip, int deviceId) {
 152         String location = FroniusBindingConstants.METER_REALTIME_DATA_URL.replace("%IP%",
 153                 (ip != null ? ip.trim() : ""));
 154         location = location.replace("%DEVICEID%", Integer.toString(deviceId));
 155         return collectDataFormUrl(MeterRealtimeResponseDTO.class, location);
 156     }
 157 }