Package io.openems.edge.meter.api

Interface AsymmetricMeter

All Superinterfaces:

OpenemsComponent, SymmetricMeter

All Known Subinterfaces:

FeneconDessGridMeter, FeneconDessPvMeter, MeterBControlEM300, MeterCarloGavazziEm300, MeterJanitzaUmg511, MeterJanitzaUmg604, SinglePhaseMeter, SocomecMeter, SocomecMeterSinglephase, SocomecMeterThreephase

All Known Implementing Classes:

AbstractSocomecMeter, AbstractSunSpecMeter, DummyAsymmetricMeter, FeneconDessGridMeterImpl, FeneconDessPvMeterImpl, FeneconProPvMeter, GoodWeGridMeter, GridMeter, GridMeter, MeterAbbB23Mbus, MeterArtemesAM2, MeterBControlEM300Impl, MeterCarloGavazziEm300Impl, MeterDiscovergy, MeterGridcon, MeterJanitzaUmg511Impl, MeterJanitzaUmg604Impl, MeterJanitzaUmg96rme, MeterMicrocareSdm630Impl, MeterPqplusUmd97, MeterSchneiderActi9Smartlink, MeterSmaShm20Impl, MeterWeidmueller525, NrcMeter, ProductionMeter, SocomecMeterSinglephaseImpl, SocomecMeterThreephaseImpl, SolarEdgeGridMeter

public interface AsymmetricMeter
extends SymmetricMeter

Represents an Asymmetric Meter. - Negative ActivePowerL1/L2/L3 and ConsumptionActivePowerL1/L2/L3 represent Consumption, i.e. power that is 'leaving the system', e.g. feed-to-grid - Positive ActivePowerL1/L2/L3 and ProductionActivePowerL1/L2/L3 represent Production, i.e. power that is 'entering the system', e.g. buy-from-grid

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AsymmetricMeter.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	POWER_DOC_TEXT

Method Summary

Modifier and Type	Method	Description
default void	_setActivePowerL1(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L1 Channel.
default void	_setActivePowerL1(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L1 Channel.
default void	_setActivePowerL2(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L2 Channel.
default void	_setActivePowerL2(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L2 Channel.
default void	_setActivePowerL3(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L3 Channel.
default void	_setActivePowerL3(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L3 Channel.
default void	_setCurrentL1(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L1 Channel.
default void	_setCurrentL1(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L1 Channel.
default void	_setCurrentL2(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L2 Channel.
default void	_setCurrentL2(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L2 Channel.
default void	_setCurrentL3(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L3 Channel.
default void	_setCurrentL3(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L3 Channel.
default void	_setReactivePowerL1(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L1 Channel.
default void	_setReactivePowerL1(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L1 Channel.
default void	_setReactivePowerL2(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L2 Channel.
default void	_setReactivePowerL2(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L2 Channel.
default void	_setReactivePowerL3(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L3 Channel.
default void	_setReactivePowerL3(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L3 Channel.
default void	_setVoltageL1(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L1 Channel.
default void	_setVoltageL1(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L1 Channel.
default void	_setVoltageL2(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L2 Channel.
default void	_setVoltageL2(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L2 Channel.
default void	_setVoltageL3(int value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L3 Channel.
default void	_setVoltageL3(java.lang.Integer value)	Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L3 Channel.
default Value<java.lang.Integer>	getActivePowerL1()	Gets the Active Power on L1 in [W].
default IntegerReadChannel	getActivePowerL1Channel()	Gets the Channel for AsymmetricMeter.ChannelId.ACTIVE_POWER_L1.
default Value<java.lang.Integer>	getActivePowerL2()	Gets the Active Power on L2 in [W].
default IntegerReadChannel	getActivePowerL2Channel()	Gets the Channel for AsymmetricMeter.ChannelId.ACTIVE_POWER_L2.
default Value<java.lang.Integer>	getActivePowerL3()	Gets the Active Power on L3 in [W].
default IntegerReadChannel	getActivePowerL3Channel()	Gets the Channel for AsymmetricMeter.ChannelId.ACTIVE_POWER_L3.
default Value<java.lang.Integer>	getCurrentL1()	Gets the Current on L1 in [mA].
default IntegerReadChannel	getCurrentL1Channel()	Gets the Channel for AsymmetricMeter.ChannelId.CURRENT_L1.
default Value<java.lang.Integer>	getCurrentL2()	Gets the Current on L2 in [mA].
default IntegerReadChannel	getCurrentL2Channel()	Gets the Channel for AsymmetricMeter.ChannelId.CURRENT_L2.
default Value<java.lang.Integer>	getCurrentL3()	Gets the Current on L3 in [mA].
default IntegerReadChannel	getCurrentL3Channel()	Gets the Channel for AsymmetricMeter.ChannelId.CURRENT_L3.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode)	Used for Modbus/TCP Api Controller.
default Value<java.lang.Integer>	getReactivePowerL1()	Gets the Reactive Power on L1 in [var].
default IntegerReadChannel	getReactivePowerL1Channel()	Gets the Channel for AsymmetricMeter.ChannelId.REACTIVE_POWER_L1.
default Value<java.lang.Integer>	getReactivePowerL2()	Gets the Reactive Power on L2 in [var].
default IntegerReadChannel	getReactivePowerL2Channel()	Gets the Channel for AsymmetricMeter.ChannelId.REACTIVE_POWER_L2.
default Value<java.lang.Integer>	getReactivePowerL3()	Gets the Reactive Power on L3 in [var].
default IntegerReadChannel	getReactivePowerL3Channel()	Gets the Channel for AsymmetricMeter.ChannelId.REACTIVE_POWER_L3.
default Value<java.lang.Integer>	getVoltageL1()	Gets the Voltage on L1 in [mV].
default IntegerReadChannel	getVoltageL1Channel()	Gets the Channel for AsymmetricMeter.ChannelId.VOLTAGE_L1.
default Value<java.lang.Integer>	getVoltageL2()	Gets the Voltage on L2 in [mV].
default IntegerReadChannel	getVoltageL2Channel()	Gets the Channel for AsymmetricMeter.ChannelId.VOLTAGE_L2.
default Value<java.lang.Integer>	getVoltageL3()	Gets the Voltage on L3 in [mV].
default IntegerReadChannel	getVoltageL3Channel()	Gets the Channel for AsymmetricMeter.ChannelId.VOLTAGE_L3.
static void	initializePowerSumChannels(AsymmetricMeter meter)	Initializes Channel listeners to set the Active- and Reactive-Power Channel value as the sum of L1 + L2 + L3.

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

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

_setActiveConsumptionEnergy, _setActiveConsumptionEnergy, _setActivePower, _setActivePower, _setActiveProductionEnergy, _setActiveProductionEnergy, _setCurrent, _setCurrent, _setFrequency, _setFrequency, _setMaxActivePower, _setMaxActivePower, _setMinActivePower, _setMinActivePower, _setReactivePower, _setReactivePower, _setVoltage, _setVoltage, getActiveConsumptionEnergy, getActiveConsumptionEnergyChannel, getActivePower, getActivePowerChannel, getActiveProductionEnergy, getActiveProductionEnergyChannel, getCurrent, getCurrentChannel, getFrequency, getFrequencyChannel, getMaxActivePower, getMaxActivePowerChannel, getMeterType, getMinActivePower, getMinActivePowerChannel, getReactivePower, getReactivePowerChannel, getVoltage, getVoltageChannel

Field Detail

POWER_DOC_TEXT

static final java.lang.String POWER_DOC_TEXT

See Also:

Constant Field Values

Method Detail

getModbusSlaveNatureTable

static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)

Description copied from interface: OpenemsComponent

Used for Modbus/TCP Api Controller. Provides a modbus table for the Channels of this Component.

Parameters:

accessMode - the AccessMode of the Controller

Returns:

a ModbusSlaveNatureTable

getActivePowerL1Channel

default IntegerReadChannel getActivePowerL1Channel()

Gets the Channel for AsymmetricMeter.ChannelId.ACTIVE_POWER_L1.

Returns:

the Channel

getActivePowerL1

default Value<java.lang.Integer> getActivePowerL1()

Gets the Active Power on L1 in [W]. Negative values for Consumption (power that is 'leaving the system', e.g. feed-to-grid); positive for Production (power that is 'entering the system'). See AsymmetricMeter.ChannelId.ACTIVE_POWER_L1.

Returns:

the Channel Value

_setActivePowerL1

default void _setActivePowerL1(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L1 Channel.

Parameters:

value - the next value

_setActivePowerL1

default void _setActivePowerL1(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L1 Channel.

Parameters:

value - the next value

getActivePowerL2Channel

default IntegerReadChannel getActivePowerL2Channel()

Gets the Channel for AsymmetricMeter.ChannelId.ACTIVE_POWER_L2.

Returns:

the Channel

getActivePowerL2

default Value<java.lang.Integer> getActivePowerL2()

Gets the Active Power on L2 in [W]. Negative values for Consumption (power that is 'leaving the system', e.g. feed-to-grid); positive for Production (power that is 'entering the system'). See AsymmetricMeter.ChannelId.ACTIVE_POWER_L2.

Returns:

the Channel Value

_setActivePowerL2

default void _setActivePowerL2(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L2 Channel.

Parameters:

value - the next value

_setActivePowerL2

default void _setActivePowerL2(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L2 Channel.

Parameters:

value - the next value

getActivePowerL3Channel

default IntegerReadChannel getActivePowerL3Channel()

Gets the Channel for AsymmetricMeter.ChannelId.ACTIVE_POWER_L3.

Returns:

the Channel

getActivePowerL3

default Value<java.lang.Integer> getActivePowerL3()

Gets the Active Power on L3 in [W]. Negative values for Consumption (power that is 'leaving the system', e.g. feed-to-grid); positive for Production (power that is 'entering the system'). See AsymmetricMeter.ChannelId.ACTIVE_POWER_L3.

Returns:

the Channel Value

_setActivePowerL3

default void _setActivePowerL3(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L3 Channel.

Parameters:

value - the next value

_setActivePowerL3

default void _setActivePowerL3(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.ACTIVE_POWER_L3 Channel.

Parameters:

value - the next value

getReactivePowerL1Channel

default IntegerReadChannel getReactivePowerL1Channel()

Gets the Channel for AsymmetricMeter.ChannelId.REACTIVE_POWER_L1.

Returns:

the Channel

getReactivePowerL1

default Value<java.lang.Integer> getReactivePowerL1()

Gets the Reactive Power on L1 in [var]. See AsymmetricMeter.ChannelId.REACTIVE_POWER_L1.

Returns:

the Channel Value

_setReactivePowerL1

default void _setReactivePowerL1(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L1 Channel.

Parameters:

value - the next value

_setReactivePowerL1

default void _setReactivePowerL1(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L1 Channel.

Parameters:

value - the next value

getReactivePowerL2Channel

default IntegerReadChannel getReactivePowerL2Channel()

Gets the Channel for AsymmetricMeter.ChannelId.REACTIVE_POWER_L2.

Returns:

the Channel

getReactivePowerL2

default Value<java.lang.Integer> getReactivePowerL2()

Gets the Reactive Power on L2 in [var]. See AsymmetricMeter.ChannelId.REACTIVE_POWER_L2.

Returns:

the Channel Value

_setReactivePowerL2

default void _setReactivePowerL2(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L2 Channel.

Parameters:

value - the next value

_setReactivePowerL2

default void _setReactivePowerL2(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L2 Channel.

Parameters:

value - the next value

getReactivePowerL3Channel

default IntegerReadChannel getReactivePowerL3Channel()

Gets the Channel for AsymmetricMeter.ChannelId.REACTIVE_POWER_L3.

Returns:

the Channel

getReactivePowerL3

default Value<java.lang.Integer> getReactivePowerL3()

Gets the Reactive Power on L3 in [var]. See AsymmetricMeter.ChannelId.REACTIVE_POWER_L3.

Returns:

the Channel Value

_setReactivePowerL3

default void _setReactivePowerL3(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L3 Channel.

Parameters:

value - the next value

_setReactivePowerL3

default void _setReactivePowerL3(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.REACTIVE_POWER_L3 Channel.

Parameters:

value - the next value

getVoltageL1Channel

default IntegerReadChannel getVoltageL1Channel()

Gets the Channel for AsymmetricMeter.ChannelId.VOLTAGE_L1.

Returns:

the Channel

getVoltageL1

default Value<java.lang.Integer> getVoltageL1()

Gets the Voltage on L1 in [mV]. See AsymmetricMeter.ChannelId.VOLTAGE_L1.

Returns:

the Channel Value

_setVoltageL1

default void _setVoltageL1(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L1 Channel.

Parameters:

value - the next value

_setVoltageL1

default void _setVoltageL1(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L1 Channel.

Parameters:

value - the next value

getVoltageL2Channel

default IntegerReadChannel getVoltageL2Channel()

Gets the Channel for AsymmetricMeter.ChannelId.VOLTAGE_L2.

Returns:

the Channel

getVoltageL2

default Value<java.lang.Integer> getVoltageL2()

Gets the Voltage on L2 in [mV]. See AsymmetricMeter.ChannelId.VOLTAGE_L2.

Returns:

the Channel Value

_setVoltageL2

default void _setVoltageL2(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L2 Channel.

Parameters:

value - the next value

_setVoltageL2

default void _setVoltageL2(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L2 Channel.

Parameters:

value - the next value

getVoltageL3Channel

default IntegerReadChannel getVoltageL3Channel()

Gets the Channel for AsymmetricMeter.ChannelId.VOLTAGE_L3.

Returns:

the Channel

getVoltageL3

default Value<java.lang.Integer> getVoltageL3()

Gets the Voltage on L3 in [mV]. See AsymmetricMeter.ChannelId.VOLTAGE_L3.

Returns:

the Channel Value

_setVoltageL3

default void _setVoltageL3(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L3 Channel.

Parameters:

value - the next value

_setVoltageL3

default void _setVoltageL3(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.VOLTAGE_L3 Channel.

Parameters:

value - the next value

getCurrentL1Channel

default IntegerReadChannel getCurrentL1Channel()

Gets the Channel for AsymmetricMeter.ChannelId.CURRENT_L1.

Returns:

the Channel

getCurrentL1

default Value<java.lang.Integer> getCurrentL1()

Gets the Current on L1 in [mA]. See AsymmetricMeter.ChannelId.CURRENT_L1.

Returns:

the Channel Value

_setCurrentL1

default void _setCurrentL1(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L1 Channel.

Parameters:

value - the next value

_setCurrentL1

default void _setCurrentL1(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L1 Channel.

Parameters:

value - the next value

getCurrentL2Channel

default IntegerReadChannel getCurrentL2Channel()

Gets the Channel for AsymmetricMeter.ChannelId.CURRENT_L2.

Returns:

the Channel

getCurrentL2

default Value<java.lang.Integer> getCurrentL2()

Gets the Current on L2 in [mA]. See AsymmetricMeter.ChannelId.CURRENT_L2.

Returns:

the Channel Value

_setCurrentL2

default void _setCurrentL2(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L2 Channel.

Parameters:

value - the next value

_setCurrentL2

default void _setCurrentL2(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L2 Channel.

Parameters:

value - the next value

getCurrentL3Channel

default IntegerReadChannel getCurrentL3Channel()

Gets the Channel for AsymmetricMeter.ChannelId.CURRENT_L3.

Returns:

the Channel

getCurrentL3

default Value<java.lang.Integer> getCurrentL3()

Gets the Current on L3 in [mA]. See AsymmetricMeter.ChannelId.CURRENT_L3.

Returns:

the Channel Value

_setCurrentL3

default void _setCurrentL3(java.lang.Integer value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L3 Channel.

Parameters:

value - the next value

_setCurrentL3

default void _setCurrentL3(int value)

Internal method to set the 'nextValue' on AsymmetricMeter.ChannelId.CURRENT_L3 Channel.

Parameters:

value - the next value

initializePowerSumChannels

static void initializePowerSumChannels(AsymmetricMeter meter)

Initializes Channel listeners to set the Active- and Reactive-Power Channel value as the sum of L1 + L2 + L3.

Parameters:

meter -