Package io.openems.edge.meter.api

Interface VirtualMeter

All Superinterfaces:

ElectricityMeter, OpenemsComponent

All Known Subinterfaces:

MeterVirtualAdd, VirtualSubtractMeter

All Known Implementing Classes:

MeterVirtualAddImpl, VirtualSubtractMeterImpl

public interface VirtualMeter
extends ElectricityMeter

A VirtualMeter is a meter that does not exist physically.

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.meter.api.ElectricityMeter

ElectricityMeter.ChannelId

Method Summary

Modifier and Type	Method	Description
boolean	addToSum()	Whether or not to add the values of this meter to Sum.

Methods inherited from interface io.openems.edge.meter.api.ElectricityMeter

_setActiveConsumptionEnergy, _setActiveConsumptionEnergy, _setActiveConsumptionEnergyL1, _setActiveConsumptionEnergyL1, _setActiveConsumptionEnergyL2, _setActiveConsumptionEnergyL2, _setActiveConsumptionEnergyL3, _setActiveConsumptionEnergyL3, _setActivePower, _setActivePower, _setActivePowerL1, _setActivePowerL1, _setActivePowerL2, _setActivePowerL2, _setActivePowerL3, _setActivePowerL3, _setActiveProductionEnergy, _setActiveProductionEnergy, _setActiveProductionEnergyL1, _setActiveProductionEnergyL1, _setActiveProductionEnergyL2, _setActiveProductionEnergyL2, _setActiveProductionEnergyL3, _setActiveProductionEnergyL3, _setCurrent, _setCurrent, _setCurrentL1, _setCurrentL1, _setCurrentL2, _setCurrentL2, _setCurrentL3, _setCurrentL3, _setFrequency, _setFrequency, _setReactivePower, _setReactivePower, _setReactivePowerL1, _setReactivePowerL1, _setReactivePowerL2, _setReactivePowerL2, _setReactivePowerL3, _setReactivePowerL3, _setVoltage, _setVoltage, _setVoltageL1, _setVoltageL1, _setVoltageL2, _setVoltageL2, _setVoltageL3, _setVoltageL3, getActiveConsumptionEnergy, getActiveConsumptionEnergyChannel, getActiveConsumptionEnergyL1, getActiveConsumptionEnergyL1Channel, getActiveConsumptionEnergyL2, getActiveConsumptionEnergyL2Channel, getActiveConsumptionEnergyL3, getActiveConsumptionEnergyL3Channel, getActivePower, getActivePowerChannel, getActivePowerL1, getActivePowerL1Channel, getActivePowerL2, getActivePowerL2Channel, getActivePowerL3, getActivePowerL3Channel, getActiveProductionEnergy, getActiveProductionEnergyChannel, getActiveProductionEnergyL1, getActiveProductionEnergyL1Channel, getActiveProductionEnergyL2, getActiveProductionEnergyL2Channel, getActiveProductionEnergyL3, getActiveProductionEnergyL3Channel, getCurrent, getCurrentChannel, getCurrentL1, getCurrentL1Channel, getCurrentL2, getCurrentL2Channel, getCurrentL3, getCurrentL3Channel, getFrequency, getFrequencyChannel, getMeterType, getReactivePower, getReactivePowerChannel, getReactivePowerL1, getReactivePowerL1Channel, getReactivePowerL2, getReactivePowerL2Channel, getReactivePowerL3, getReactivePowerL3Channel, getVoltage, getVoltageChannel, getVoltageL1, getVoltageL1Channel, getVoltageL2, getVoltageL2Channel, getVoltageL3, getVoltageL3Channel, isManaged

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Method Details

addToSum

boolean addToSum()

Whether or not to add the values of this meter to Sum.

Use case: there are two production meters which should be joined to one virtual meter. In this case you would not want this VirtualMeter to be added to the total sum of Production power ("_sum/ActiveProductionPower").

Returns:

true if it should be added to sum.