electricity_meter.h

/*
 Copyright (C) AC SOFTWARE SP. Z O.O.
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#ifndef SRC_SUPLA_SENSOR_ELECTRICITY_METER_H_
#define SRC_SUPLA_SENSOR_ELECTRICITY_METER_H_
 
#include <supla-common/srpc.h>
#include <supla/action_handler.h>
#include <supla/element_with_channel_actions.h>
 
#include "../channel_extended.h"
#include "../local_action.h"
 
#define MAX_PHASES 3
 
namespace Supla {
namespace Sensor {
 
#pragma pack(push, 1)
struct EnergyMeasurmentsStorage {
  union {
    _supla_int64_t totalFwdActEnergy = 0;
    _supla_int64_t fwdActEnergy;
  };
  union {
    _supla_int64_t totalRvrActEnergy = 0;
    _supla_int64_t rvrActEnergy;
  };
  union {
    _supla_int64_t totalFwdReactEnergy = 0;
    _supla_int64_t fwdReactEnergy;
  };
  union {
    _supla_int64_t totalRvrReactEnergy = 0;
    _supla_int64_t rvrReactEnergy;
  };
};
 
struct VectorBalancedEnergyStorage {
  _supla_int64_t fwdActEnergyBalanced = 0;
  _supla_int64_t rvrActEnergyBalanced = 0;
};
#pragma pack(pop)
 
#define EM_VAR_ALL_ENERGY_REGISTERS                                  \
  (EM_VAR_FORWARD_ACTIVE_ENERGY | EM_VAR_REVERSE_ACTIVE_ENERGY |     \
  EM_VAR_FORWARD_REACTIVE_ENERGY | EM_VAR_REVERSE_REACTIVE_ENERGY |  \
  EM_VAR_FORWARD_ACTIVE_ENERGY_BALANCED |                            \
  EM_VAR_REVERSE_ACTIVE_ENERGY_BALANCED)
 
class ElectricityMeter : public ElementWithChannelActions,
                         public ActionHandler {
 public:
  ElectricityMeter();
 
  virtual void updateChannelValues();
 
  // energy in 0.00001 kWh
  void setFwdActEnergy(int phase, unsigned _supla_int64_t energy);
 
  // energy in 0.00001 kWh
  void setRvrActEnergy(int phase, unsigned _supla_int64_t energy);
 
  // energy in 0.00001 kWh
  void setFwdReactEnergy(int phase, unsigned _supla_int64_t energy);
 
  // energy in 0.00001 kWh
  void setRvrReactEnergy(int phase, unsigned _supla_int64_t energy);
 
  // Vector balanced forward energy
  // energy in 0.00001 kWh
  void setFwdBalancedEnergy(uint64_t energy);
 
  // Vector balanced reverse energy
  // energy in 0.00001 kWh
  void setRvrBalancedEnergy(uint64_t energy);
 
  // voltage in 0.01 V
  void setVoltage(int phase, unsigned _supla_int16_t voltage);
 
  // current in 0.001 A
  void setCurrent(int phase, unsigned _supla_int_t current);
 
  // Frequency in 0.01 Hz
  void setFreq(unsigned _supla_int16_t freq);
 
  // power in 0.00001 W
  void setPowerActive(int phase, int64_t power);
 
  // power in 0.00001 var
  void setPowerReactive(int phase, int64_t power);
 
  // power in 0.00001 VA
  void setPowerApparent(int phase, int64_t power);
 
  // power in 0.001
  void setPowerFactor(int phase, _supla_int_t powerFactor);
 
  // phase angle in 0.1 degree
  void setPhaseAngle(int phase, _supla_int_t phaseAngle);
 
  // voltage phase angle between phase 1 and 2
  void setVoltagePhaseAngle12(unsigned _supla_int16_t voltagePhaseAngle);
 
  // voltage phase angle between phase 1 and 3
  void setVoltagePhaseAngle13(unsigned _supla_int16_t voltagePhaseAngle);
 
  // sets voltage phase sequence to clockwise or counterclockwise
  void setVoltagePhaseSequence(bool clockwise);
 
  // sets current phase sequence to clockwise or counterclockwise
  void setCurrentPhaseSequence(bool clockwise);

  void clearVoltagePhaseSequenceFlag();

  void clearCurrentPhaseSequenceFlag();
 
  // energy 1 == 0.00001 kWh
  unsigned _supla_int64_t getFwdActEnergy(int phase);
 
  // energy 1 == 0.00001 kWh
  unsigned _supla_int64_t getRvrActEnergy(int phase);
 
  // energy 1 == 0.00001 kWh
  uint64_t getFwdBalancedActEnergy();
 
  // energy 1 == 0.00001 kWh
  uint64_t getRvrBalancedActEnergy();
 
  // energy 1 == 0.00001 kWh
  unsigned _supla_int64_t getFwdReactEnergy(int phase);
 
  // energy 1 == 0.00001 kWh
  unsigned _supla_int64_t getRvrReactEnergy(int phase);
 
  // voltage 1 == 0.01 V
  unsigned _supla_int16_t getVoltage(int phase);
 
  // current 1 == 0.001 A
  unsigned _supla_int_t getCurrent(int phase);
 
  // Frequency 1 == 0.01 Hz
  unsigned _supla_int16_t getFreq();
 
  // power 1 == 0.00001 W
  int64_t getPowerActive(int phase);
 
  // power 1 == 0.00001 var
  int64_t getPowerReactive(int phase);
 
  // power 1 == 0.00001 VA
  int64_t getPowerApparent(int phase);
 
  // power 1 == 0.001
  _supla_int_t getPowerFactor(int phase);
 
  // phase angle 1 == 0.1 degree
  _supla_int_t getPhaseAngle(int phase);
 
  // Phase angle between voltage phase 1 and 2 in 0.1 degree, 0..360
  uint16_t getVoltagePhaseAngle12() const;
 
  // Phase angle between voltage phase 1 and 3 in 0.1 degree, 0..360
  uint16_t getVoltagePhaseAngle13() const;
 
  // Returns true when voltage phase sequence is set
  bool isVoltagePhaseSequenceSet() const;
 
  // Voltage phase sequence clockwise or counterclockwise
  bool isVoltagePhaseSequenceClockwise() const;
 
  // Returns true when current phase sequence is set
  bool isCurrentPhaseSequenceSet() const;
 
  // Current phase sequence clockwise or counterclockwise
  bool isCurrentPhaseSequenceClockwise() const;
 
  // energy 1 == 0.00001 kWh
  static unsigned _supla_int64_t
    getFwdActEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue,
        int phase);
 
  // energy 1 == 0.00001 kWh
  static unsigned _supla_int64_t
    getTotalFwdActEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // energy 1 == 0.00001 kWh
  static uint64_t
    getFwdBalancedActEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // energy 1 == 0.00001 kWh
  static unsigned _supla_int64_t
    getRvrActEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue,
        int phase);
 
  // energy 1 == 0.00001 kWh
  static unsigned _supla_int64_t
    getTotalRvrActEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // energy 1 == 0.00001 kWh
  static uint64_t
    getRvrBalancedActEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // energy 1 == 0.00001 kWh
  static unsigned _supla_int64_t
    getFwdReactEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue,
        int phase);
 
  // energy 1 == 0.00001 kWh
  static unsigned _supla_int64_t
    getRvrReactEnergy(const TElectricityMeter_ExtendedValue_V3 &emValue,
        int phase);
 
  // voltage 1 == 0.01 V
  static unsigned _supla_int16_t
    getVoltage(const TElectricityMeter_ExtendedValue_V3 &emValue, int phase);
 
  // current 1 == 0.001 A
  static unsigned _supla_int_t
    getCurrent(const TElectricityMeter_ExtendedValue_V3 &emValue, int phase);
 
  // Frequency 1 == 0.01 Hz
  static unsigned _supla_int16_t
    getFreq(const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // power 1 == 0.00001 W
  static int64_t getPowerActive(
      const TElectricityMeter_ExtendedValue_V3 &emValue, int phase);
 
  // power 1 == 0.00001 var
  static int64_t getPowerReactive(
      const TElectricityMeter_ExtendedValue_V3 &emValue, int phase);
 
  // power 1 == 0.00001 VA
  static int64_t getPowerApparent(
      const TElectricityMeter_ExtendedValue_V3 &emValue, int phase);
 
  // power 1 == 0.001
  static _supla_int_t getPowerFactor(
      const TElectricityMeter_ExtendedValue_V3 &emValue, int phase);
 
  // phase angle 1 == 0.1 degree
  static _supla_int_t getPhaseAngle(
      const TElectricityMeter_ExtendedValue_V3 &emValue, int phase);
 
  // Phase angle between voltage phase 1 and 2 in 0.1 degree, 0..360
  static uint16_t getVoltagePhaseAngle12(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // Phase angle between voltage phase 1 and 3 in 0.1 degree, 0..360
  static uint16_t getVoltagePhaseAngle13(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // Returns true when voltage phase sequence is set
  static bool isVoltagePhaseSequenceSet(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // Voltage phase sequence clockwise or counterclockwise
  static bool isVoltagePhaseSequenceClockwise(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // Returns true when current phase sequence is set
  static bool isCurrentPhaseSequenceSet(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  // Current phase sequence clockwise or counterclockwise
  static bool isCurrentPhaseSequenceClockwise(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isVoltagePhaseAngle12Used(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isVoltagePhaseAngle13Used(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isFwdActEnergyUsed(
    const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isRvrActEnergyUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isFwdReactEnergyUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isRvrReactEnergyUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isFwdBalancedActEnergyUsed(
    const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isRvrBalancedActEnergyUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isVoltageUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isCurrentUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isFreqUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isPowerActiveUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isPowerReactiveUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isPowerApparentUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isPowerFactorUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  static bool isPhaseAngleUsed(
      const TElectricityMeter_ExtendedValue_V3 &emValue);
 
  void resetReadParameters();
  void resetReadParametersForPhase(int phase);
 
  // Please implement this class for reading value from elecricity meter device.
  // It will be called every 5 s. Use set methods defined above in order to
  // set values on channel. Don't use any other method to modify channel values.
  virtual void readValuesFromDevice();
 
  void onRegistered(Supla::Protocol::SuplaSrpc *suplaSrpc) override;
  void onLoadConfig(SuplaDeviceClass *sdc) override;
  Supla::ApplyConfigResult applyChannelConfig(TSD_ChannelConfig *config,
                                              bool local) override;
  void fillChannelConfig(void *channelConfig,
                         int *size,
                         uint8_t configType) override;
 
  // Put here initialization code for electricity meter device.
  // It will be called within SuplaDevce.begin method.
  // It should also read first data set, so at the end it should call those two
  // methods:
  // readValuesFromDevice();
  // updateChannelValues();
  void onInit() override;
 
  void iterateAlways() override;
 
  // Implement this method to reset stored energy value (i.e. to set energy
  // counter back to 0 kWh
  virtual void resetStorage();
 
  // default calcfg implementation allows to resetStorage remotely.
  // If you override it please remember to implement this functionality
  // or call this method from base classs.
  int handleCalcfgFromServer(TSD_DeviceCalCfgRequest *request) override;
 
  void handleAction(int event, int action) override;
 
  void setRefreshRate(unsigned int sec);
 
  void sendDataWithDelay(int delayMs = 0);
 
  Channel *getChannel() override;
  const Channel *getChannel() const override;
  void purgeConfig() override;
 
  void enableChannelConfig();
  void addCtType(uint64_t ctType);
  void addPhaseLedType(uint64_t ledType);
  bool isCtTypeSupported(uint64_t ctType) const;
 
  int8_t getPhaseLedType() const;
  int32_t getLedVoltageLow() const;
  int32_t getLedVoltageHigh() const;
  int32_t getLedPowerLow() const;
  int32_t getLedPowerHigh() const;
  bool isPhaseLedTypeSupported(uint64_t ledType) const;
 
 protected:
  TElectricityMeter_ExtendedValue_V3 emValue = {};
  ChannelExtended extChannel;
  uint32_t lastChannelUpdateTime = 0;
  uint32_t rawCurrent[MAX_PHASES] = {};
  int64_t rawActivePower[MAX_PHASES] = {};
  int64_t rawReactivePower[MAX_PHASES] = {};
  int64_t rawApparentPower[MAX_PHASES] = {};
 
  uint32_t lastReadTime = 0;
  uint16_t refreshRateSec = 5;
  bool valueChanged = false;
  bool currentMeasurementAvailable = false;
  bool powerActiveMeasurementAvailable = false;
  bool powerReactiveMeasurementAvailable = false;
  bool powerApparentMeasurementAvailable = false;
 
  uint64_t availableCtTypes = 0;  // from proto EM_CT_TYPE_
  uint64_t availablePhaseLedTypes = 0;  // from proto EM_PHASE_LED_TYPE_
  bool channelConfigUsed = false;
  int8_t usedCtType = -1;         // correspond with bit position of CT type
                                 // Value -1 - default/not used
  int8_t usedPhaseLedType = -1;   // correspond with bit position of LED type
                                 // Value -1 - default/not used
  int32_t ledVoltageLow = 21000;   // 210.00 V
  int32_t ledVoltageHigh = 25000;  // 250.00 V
  int32_t ledPowerLow = -5000;     // -50.00 W
  int32_t ledPowerHigh = 5000;     //  50.00 W
};
 
};  // namespace Sensor
};  // namespace Supla
 
#endif  // SRC_SUPLA_SENSOR_ELECTRICITY_METER_H_