All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

AsymmetricMeter, FeneconDessGridMeter, FeneconDessPvMeter, FeneconMiniGridMeter, FeneconMiniPvMeter, ManagedSymmetricPvInverter, MeterBControlEM300, MeterCarloGavazziEm300, MeterJanitzaUmg511, MeterJanitzaUmg604, SinglePhaseMeter, SocomecMeter, SocomecMeterSinglephase, SocomecMeterThreephase, SolarLog, VirtualMeter

All Known Implementing Classes:

AbstractSocomecMeter, AbstractSunSpecMeter, AbstractSunSpecPvInverter, DummyAsymmetricMeter, DummySymmetricMeter, FeneconDessGridMeterImpl, FeneconDessPvMeterImpl, FeneconMiniGridMeterImpl, FeneconMiniPvMeterImpl, FeneconProPvMeter, GoodWeGridMeter, GridMeter, GridMeter, KacoBlueplanet, KostalPikoGridMeter, MeterAbbB23Mbus, MeterArtemesAM2, MeterBControlEM300Impl, MeterCarloGavazziEm300Impl, MeterDiscovergy, MeterGridcon, MeterJanitzaUmg511Impl, MeterJanitzaUmg604Impl, MeterJanitzaUmg96rme, MeterMicrocareSdm630Impl, MeterPqplusUmd97, MeterSchneiderActi9Smartlink, MeterSmaShm20Impl, MeterWeidmueller525, NrcMeter, ProductionMeter, PvInverter, PvInverterCluster, SmaPvInverter, SocomecMeterSinglephaseImpl, SocomecMeterThreephaseImpl, SolarEdge, SolarEdgeGridMeter, SolarLogImpl, VirtualAdd, VirtualSubtractMeter
```
public interface SymmetricMeter
extends OpenemsComponent
```
Represents a Symmetric Meter.
- Negative ActivePower and ConsumptionActivePower represent Consumption, i.e. power that is 'leaving the system', e.g. feed-to-grid
- Positive ActivePower and ProductionActivePower 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 SymmetricMeter.ChannelId

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`_setActiveConsumptionEnergy(long value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.ACTIVE_CONSUMPTION_ENERGY` Channel.
`default void`	`_setActiveConsumptionEnergy(java.lang.Long value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.ACTIVE_CONSUMPTION_ENERGY` Channel.
`default void`	`_setActivePower(int value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.ACTIVE_POWER` Channel.
`default void`	`_setActivePower(java.lang.Integer value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.ACTIVE_POWER` Channel.
`default void`	`_setActiveProductionEnergy(long value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.ACTIVE_PRODUCTION_ENERGY` Channel.
`default void`	`_setActiveProductionEnergy(java.lang.Long value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.ACTIVE_PRODUCTION_ENERGY` Channel.
`default void`	`_setCurrent(int value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.CURRENT` Channel.
`default void`	`_setCurrent(java.lang.Integer value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.CURRENT` Channel.
`default void`	`_setFrequency(int value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.FREQUENCY` Channel.
`default void`	`_setFrequency(java.lang.Integer value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.FREQUENCY` Channel.
`default void`	`_setMaxActivePower(int value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.MAX_ACTIVE_POWER` Channel.
`default void`	`_setMaxActivePower(java.lang.Integer value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.MAX_ACTIVE_POWER` Channel.
`default void`	`_setMinActivePower(int value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.MIN_ACTIVE_POWER` Channel.
`default void`	`_setMinActivePower(java.lang.Integer value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.MIN_ACTIVE_POWER` Channel.
`default void`	`_setReactivePower(int value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.REACTIVE_POWER` Channel.
`default void`	`_setReactivePower(java.lang.Integer value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.REACTIVE_POWER` Channel.
`default void`	`_setVoltage(int value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.VOLTAGE` Channel.
`default void`	`_setVoltage(java.lang.Integer value)`	Internal method to set the 'nextValue' on `SymmetricMeter.ChannelId.VOLTAGE` Channel.
`default Value<java.lang.Long>`	`getActiveConsumptionEnergy()`	Gets the Active Consumption Energy in [Wh].
`default LongReadChannel`	`getActiveConsumptionEnergyChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.ACTIVE_CONSUMPTION_ENERGY`.
`default Value<java.lang.Integer>`	`getActivePower()`	Gets the Active Power in [W].
`default IntegerReadChannel`	`getActivePowerChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.ACTIVE_POWER`.
`default Value<java.lang.Long>`	`getActiveProductionEnergy()`	Gets the Active Production Energy in [Wh].
`default LongReadChannel`	`getActiveProductionEnergyChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.ACTIVE_PRODUCTION_ENERGY`.
`default Value<java.lang.Integer>`	`getCurrent()`	Gets the Current in [mA].
`default IntegerReadChannel`	`getCurrentChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.CURRENT`.
`default Value<java.lang.Integer>`	`getFrequency()`	Gets the Frequency in [mHz].
`default IntegerReadChannel`	`getFrequencyChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.FREQUENCY`.
`default Value<java.lang.Integer>`	`getMaxActivePower()`	Gets the Maximum Ever Active Power in [W].
`default IntegerReadChannel`	`getMaxActivePowerChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.MAX_ACTIVE_POWER`.
`MeterType`	`getMeterType()`	Gets the type of this Meter.
`default Value<java.lang.Integer>`	`getMinActivePower()`	Gets the Minimum Ever Active Power in [W].
`default IntegerReadChannel`	`getMinActivePowerChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.MIN_ACTIVE_POWER`.
`static ModbusSlaveNatureTable`	`getModbusSlaveNatureTable(AccessMode accessMode)`	Used for Modbus/TCP Api Controller.
`default Value<java.lang.Integer>`	`getReactivePower()`	Gets the Reactive Power in [var].
`default IntegerReadChannel`	`getReactivePowerChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.REACTIVE_POWER`.
`default Value<java.lang.Integer>`	`getVoltage()`	Gets the Voltage in [mV].
`default IntegerReadChannel`	`getVoltageChannel()`	Gets the Channel for `SymmetricMeter.ChannelId.VOLTAGE`.

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 Detail
  - getMeterType
```
MeterType getMeterType()
```
    Gets the type of this Meter.
    
    Returns:
    
    the MeterType
  - 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
  - getFrequencyChannel
```
default IntegerReadChannel getFrequencyChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.FREQUENCY.
    
    Returns:
    
    the Channel
  - getFrequency
```
default Value<java.lang.Integer> getFrequency()
```
    Gets the Frequency in [mHz]. See SymmetricMeter.ChannelId.FREQUENCY.
    
    Returns:
    
    the Channel Value
  - _setFrequency
```
default void _setFrequency(java.lang.Integer value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.FREQUENCY Channel.
    
    Parameters:
    
    value - the next value
  - _setFrequency
```
default void _setFrequency(int value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.FREQUENCY Channel.
    
    Parameters:
    
    value - the next value
  - getMinActivePowerChannel
```
default IntegerReadChannel getMinActivePowerChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.MIN_ACTIVE_POWER.
    
    Returns:
    
    the Channel
  - getMinActivePower
```
default Value<java.lang.Integer> getMinActivePower()
```
    Gets the Minimum Ever Active Power in [W]. See SymmetricMeter.ChannelId.MIN_ACTIVE_POWER.
    
    Returns:
    
    the Channel Value
  - _setMinActivePower
```
default void _setMinActivePower(java.lang.Integer value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.MIN_ACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - _setMinActivePower
```
default void _setMinActivePower(int value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.MIN_ACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - getMaxActivePowerChannel
```
default IntegerReadChannel getMaxActivePowerChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.MAX_ACTIVE_POWER.
    
    Returns:
    
    the Channel
  - getMaxActivePower
```
default Value<java.lang.Integer> getMaxActivePower()
```
    Gets the Maximum Ever Active Power in [W]. See SymmetricMeter.ChannelId.MAX_ACTIVE_POWER.
    
    Returns:
    
    the Channel Value
  - _setMaxActivePower
```
default void _setMaxActivePower(java.lang.Integer value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.MAX_ACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - _setMaxActivePower
```
default void _setMaxActivePower(int value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.MAX_ACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - getActivePowerChannel
```
default IntegerReadChannel getActivePowerChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.ACTIVE_POWER.
    
    Returns:
    
    the Channel
  - getActivePower
```
default Value<java.lang.Integer> getActivePower()
```
    Gets the Active Power 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 SymmetricMeter.ChannelId.ACTIVE_POWER.
    
    Returns:
    
    the Channel Value
  - _setActivePower
```
default void _setActivePower(java.lang.Integer value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.ACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - _setActivePower
```
default void _setActivePower(int value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.ACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - getReactivePowerChannel
```
default IntegerReadChannel getReactivePowerChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.REACTIVE_POWER.
    
    Returns:
    
    the Channel
  - getReactivePower
```
default Value<java.lang.Integer> getReactivePower()
```
    Gets the Reactive Power in [var]. See SymmetricMeter.ChannelId.REACTIVE_POWER.
    
    Returns:
    
    the Channel Value
  - _setReactivePower
```
default void _setReactivePower(java.lang.Integer value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.REACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - _setReactivePower
```
default void _setReactivePower(int value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.REACTIVE_POWER Channel.
    
    Parameters:
    
    value - the next value
  - getActiveProductionEnergyChannel
```
default LongReadChannel getActiveProductionEnergyChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.ACTIVE_PRODUCTION_ENERGY.
    
    Returns:
    
    the Channel
  - getActiveProductionEnergy
```
default Value<java.lang.Long> getActiveProductionEnergy()
```
    Gets the Active Production Energy in [Wh]. This relates to positive ACTIVE_POWER. See SymmetricMeter.ChannelId.ACTIVE_PRODUCTION_ENERGY.
    
    Returns:
    
    the Channel Value
  - _setActiveProductionEnergy
```
default void _setActiveProductionEnergy(java.lang.Long value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.ACTIVE_PRODUCTION_ENERGY Channel.
    
    Parameters:
    
    value - the next value
  - _setActiveProductionEnergy
```
default void _setActiveProductionEnergy(long value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.ACTIVE_PRODUCTION_ENERGY Channel.
    
    Parameters:
    
    value - the next value
  - getActiveConsumptionEnergyChannel
```
default LongReadChannel getActiveConsumptionEnergyChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.ACTIVE_CONSUMPTION_ENERGY.
    
    Returns:
    
    the Channel
  - getActiveConsumptionEnergy
```
default Value<java.lang.Long> getActiveConsumptionEnergy()
```
    Gets the Active Consumption Energy in [Wh]. This relates to negative ACTIVE_POWER. See SymmetricMeter.ChannelId.ACTIVE_CONSUMPTION_ENERGY.
    
    Returns:
    
    the Channel Value
  - _setActiveConsumptionEnergy
```
default void _setActiveConsumptionEnergy(java.lang.Long value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.ACTIVE_CONSUMPTION_ENERGY Channel.
    
    Parameters:
    
    value - the next value
  - _setActiveConsumptionEnergy
```
default void _setActiveConsumptionEnergy(long value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.ACTIVE_CONSUMPTION_ENERGY Channel.
    
    Parameters:
    
    value - the next value
  - getVoltageChannel
```
default IntegerReadChannel getVoltageChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.VOLTAGE.
    
    Returns:
    
    the Channel
  - getVoltage
```
default Value<java.lang.Integer> getVoltage()
```
    Gets the Voltage in [mV]. See SymmetricMeter.ChannelId.VOLTAGE.
    
    Returns:
    
    the Channel Value
  - _setVoltage
```
default void _setVoltage(java.lang.Integer value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.VOLTAGE Channel.
    
    Parameters:
    
    value - the next value
  - _setVoltage
```
default void _setVoltage(int value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.VOLTAGE Channel.
    
    Parameters:
    
    value - the next value
  - getCurrentChannel
```
default IntegerReadChannel getCurrentChannel()
```
    Gets the Channel for SymmetricMeter.ChannelId.CURRENT.
    
    Returns:
    
    the Channel
  - getCurrent
```
default Value<java.lang.Integer> getCurrent()
```
    Gets the Current in [mA]. See SymmetricMeter.ChannelId.CURRENT.
    
    Returns:
    
    the Channel Value
  - _setCurrent
```
default void _setCurrent(java.lang.Integer value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.CURRENT Channel.
    
    Parameters:
    
    value - the next value
  - _setCurrent
```
default void _setCurrent(int value)
```
    Internal method to set the 'nextValue' on SymmetricMeter.ChannelId.CURRENT Channel.
    
    Parameters:
    
    value - the next value

Interface SymmetricMeter

Nested Class Summary

Method Summary

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

Method Detail

getMeterType

getModbusSlaveNatureTable

getFrequencyChannel

getFrequency

_setFrequency

_setFrequency

getMinActivePowerChannel

getMinActivePower

_setMinActivePower

_setMinActivePower

getMaxActivePowerChannel

getMaxActivePower

_setMaxActivePower

_setMaxActivePower

getActivePowerChannel

getActivePower

_setActivePower

_setActivePower

getReactivePowerChannel

getReactivePower

_setReactivePower

_setReactivePower

getActiveProductionEnergyChannel

getActiveProductionEnergy

_setActiveProductionEnergy

_setActiveProductionEnergy

getActiveConsumptionEnergyChannel

getActiveConsumptionEnergy

_setActiveConsumptionEnergy

_setActiveConsumptionEnergy

getVoltageChannel

getVoltage

_setVoltage

_setVoltage

getCurrentChannel

getCurrent

_setCurrent

_setCurrent