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

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