io.openems.edge.common.component

Interface OpenemsComponent

All Known Subinterfaces:

AllAlphabeticallyScheduler, AsymmetricEss, AsymmetricMeter, BackendApi, BalancingSchedule, Battery, BatteryBoxC130, BmwBattery, BridgeModbus, BridgeModbusSerial, BridgeModbusTcp, BridgeOnewire, ClusterVersionC, ComponentManager, ComponentManagerProvider, ConsumptionHourlyPredictor, Controller, Cycle, DailyScheduler, DelayedSellToGrid, DigitalInput, DigitalOutput, EssDcCharger, EssFeneconCommercial40, EssSellToGridLimit, EssSinexcel, Evcs, EvcsController, FixedOrderScheduler, GenericManagedSymmetricEss, GoodWeEtBatteryInverter, HourlyPredictor, HybridEss, InfluxTimedata, KacoBlueplanetGridsave, ManagedAsymmetricEss, ManagedEvcs, ManagedSinglePhaseEss, ManagedSymmetricBatteryInverter, ManagedSymmetricEss, ManagedSymmetricPvInverter, MeasuringEvcs, Meta, MetaEss, MeterBControlEM300, MeterCarloGavazziEm300, MeterJanitzaUmg604, ModbusSlave, ModbusTcpApi, ModbusTcpApiReadOnly, ModbusTcpApiReadWrite, PowerComponent, ProductionHourlyPredictor, RefuStore88k, RestApi, RestApiReadOnly, RestApiReadWrite, Rrd4jTimedata, Scheduler, Shelly25, ShellyPlug, SinglePhaseEss, SinglePhaseMeter, SingleRackVersionB, SingleRackVersionC, SocEvcs, SocomecMeter, SocomecMeterSinglephase, SocomecMeterThreephase, SolarLog, SoltaroBatteryVersionC, SoltaroCluster, StartStoppable, Sum, SurplusFeedToGridController, SymmetricBatteryInverter, SymmetricEss, SymmetricMeter, TeslaPowerwall2Core, Thermometer, Timedata, TimedataProvider, VirtualMeter

All Known Implementing Classes:

Abl, AbstractCsvDatasource, AbstractEssStreetscooter, AbstractEvcsCluster, AbstractFeneconDessCharger, AbstractGoodWeEtCharger, AbstractModbusBridge, AbstractModbusTcpApi, AbstractOcppEvcsComponent, AbstractOpenemsComponent, AbstractOpenemsMbusComponent, AbstractOpenemsModbusComponent, AbstractOpenemsSunSpecComponent, AbstractPersistenceModelPredictor, AbstractPredictiveDelayCharge, AbstractRestApi, AbstractSunSpecBatteryInverter, AbstractSunSpecMeter, AbstractSunSpecPvInverter, AcIsland, AcPredictiveDelayCharge, AllAlphabeticallySchedulerImpl, AsymmetricFixActivePower, AsymmetricFixReactivePower, BackendApiImpl, Balancing, BalancingScheduleImpl, BatteryBoxC130Impl, BatteryDummy, BatteryHandlingController, BmwBatteryImpl, BridgeMbusImpl, BridgeModbusSerialImpl, BridgeModbusTcpImpl, BridgeOnewireImpl, BydContainerWatchdog, ChannelSingleThreshold, ChannelThreshold, ClusterVersionB, ClusterVersionCImpl, ComponentManagerImpl, ConsumptionPredictor, ControllerChpSoc, ControllerHeatingElementImpl, CosPhi, CsvDatasourceDirect, CsvDatasourcePredefined, CycleImpl, DailySchedulerImpl, DcPredictiveDelayCharge, DebugDetailedLog, DebugLog, DelayChargeController, DelayedSellToGridImpl, DigitalInputOutput, DummyAsymmetricMeter, DummyBattery, DummyComponentManager, DummyController, DummyCycle, DummyHybridEss, DummyInputOutput, DummyManagedAsymmetricEss, DummyManagedEvcs, DummyManagedSymmetricBatteryInverter, DummyManagedSymmetricEss, DummyMetaEss, DummyModbusBridge, DummySum, DummySymmetricMeter, Ess0Streetscooter, Ess1Streetscooter, EssAsymmetric, EssCluster, EssDcChargerFeneconCommercial40, EssFeneconBydContainer, EssFeneconCommercial40Impl, EssKacoBlueplanetGridsave50, EssOneFullCycle, EssSellToGridLimitImpl, EssSinexcelImpl, EssSinglePhase, EssSymmetric, EvcsClusterPeakShaving, EvcsClusterSelfConsumption, EvcsControllerImpl, EvcsFixActivePower, FeneconDessCharger1, FeneconDessCharger2, FeneconDessEss, FeneconDessGridMeter, FeneconDessPvMeter, FeneconMiniEssImpl, FeneconMiniGridMeter, FeneconMiniPvMeter, FeneconProEss, FeneconProPvMeter, FixDigitalOutput, FixedOrderSchedulerImpl, GenericManagedSymmetricEssImpl, GoodWeEtBatteryInverterImpl, GoodWeEtChargerPv1, GoodWeEtChargerPv2, GoodWeEtGridMeter, GridconPCS, GridMeter, GridMeter, HighLoadTimeslot, Host, IesKeywattSingleCcs, InfluxTimedataImpl, IoAlarm, JsonLogicController, KacoBlueplanet, KacoBlueplanetGridsaveImpl, KebaKeContact, KmtronicRelayOutput, KostalPikoCharger, KostalPikoCoreImpl, KostalPikoEss, KostalPikoGridMeter, LimitTotalDischargeController, MetaImpl, MeterAbbB23Mbus, MeterArtemesAM2, MeterBControlEM300Impl, MeterCarloGavazziEm300Impl, MeterDiscovergy, MeterJanitzaUmg604Impl, MeterJanitzaUmg96rme, MeterMicrocareSdm630Impl, MeterPqplusUmd97, MeterSchneiderActi9Smartlink, MeterWeidmueller525, MinDischargePeriod, ModbusSimulator, ModbusTcpApiReadOnlyImpl, ModbusTcpApiReadWriteImpl, NrcMeter, OcppServerImpl, OneWireThermometer, PeakShaving, PeakShaving, PhaseRectification, PowerComponentImpl, ProductionMeter, ProductionPredictor, PvInverter, PvInverterCluster, PvInverterFixPowerLimit, PvInverterSellToGridLimit, ReactivePowerVoltageCharacteristic, RefuEss, RefuStore88kImpl, RestApiReadOnlyImpl, RestApiReadWriteImpl, RevPiDigitalIoDevice, Rrd4jTimedataImpl, Shelly25Impl, ShellyPlugImpl, SimulatedEvcs, SimulatorApp, SimulatorTimedata, SingleDatasourceDirect, SingleRack, SingleRackVersionBImpl, SingleRackVersionCImpl, SmaPvInverter, SocomecMeterSinglephaseImpl, SocomecMeterThreephaseImpl, SolarEdge, SolarEdgeGridMeter, SolarLogImpl, SumImpl, SunnyIsland6Ess, SurplusFeedInController, SurplusFeedToGridControllerImpl, SymmetricFixActivePower, SymmetricFixReactivePower, SymmetricLimitActivePower, SymmetricLinearPowerBand, SymmetricRandomPower, TeslaPowerwall2Battery, TeslaPowerwall2CoreImpl, TimeslotPeakshaving, VirtualAdd, Wago, WebsocketApi

public interface OpenemsComponent

This is the base interface for and should be implemented by every service component in OpenEMS Edge.

Every OpenEMS service has:

• a unique ID (see id())
• an enabled/disabled state (see isEnabled())
• an OSGi service PID (see servicePid()
• Channels (see Channel), identified by OpenemsComponent.ChannelId or String-ID and provided via channel(String), channel(io.openems.edge.common.channel.ChannelId) and channels()
• a kind of 'toString' method which provides the most important info about the component. (see debugLog())

The recommended implementation of an OpenEMS component is via AbstractOpenemsComponent.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OpenemsComponent.ChannelId

Method Summary

Modifier and Type	Method and Description
Channel<?>	_channel(java.lang.String channelName) Deprecated.
default <T extends Channel<?>> T	_getChannelAs(OpenemsComponent.ChannelId channelId, java.lang.Class<T> type) Gets the Channel as the given Type.
java.lang.String	alias() Returns a human-readable name of this Component..
default <T extends Channel<?>> T	channel(ChannelId channelId) Returns a Channel defined by its ChannelId.
default <T extends Channel<?>> T	channel(java.lang.String channelName) Returns a Channel defined by its ChannelId string representation.
java.util.Collection<Channel<?>>	channels() Returns all Channels.
default java.lang.String	debugLog() Gets some output that is suitable for a continuous Debug log.
org.osgi.service.component.ComponentContext	getComponentContext() Returns the ComponentContext.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode) Used for Modbus/TCP Api Controller.
default Level	getState() Gets the Component State Level.
default StateCollectorChannel	getStateChannel() Gets the Component State-Channel.
default boolean	hasFaults() Does this OpenEMS Component report any Faults?
java.lang.String	id() Returns a unique ID for this OpenEMS component.
boolean	isEnabled() Returns whether this component is enabled.
default java.lang.String	serviceFactoryPid() Returns the Service Factory-PID.
default java.lang.String	servicePid() Returns the Service PID.
static void	updateConfigurationProperty(org.osgi.service.cm.ConfigurationAdmin cm, java.lang.String pid, java.lang.String property, java.lang.Object value) Update a configuration property.
static boolean	updateReferenceFilter(org.osgi.service.cm.ConfigurationAdmin cm, java.lang.String pid, java.lang.String member, java.lang.String... ids) Sets a target filter for a Declarative Service @Reference member.

Method Detail

id

java.lang.String id()

Returns a unique ID for this OpenEMS component.

Returns:

the unique ID

alias

java.lang.String alias()

Returns a human-readable name of this Component..

Returns:

the human-readable name

isEnabled

boolean isEnabled()

Returns whether this component is enabled.

Returns:

true if the component is enabled

servicePid

default java.lang.String servicePid()

Returns the Service PID.

Returns:

the OSGi Service PID

serviceFactoryPid

default java.lang.String serviceFactoryPid()

Returns the Service Factory-PID.

Returns:

the OSGi Service Factory-PID

getComponentContext

org.osgi.service.component.ComponentContext getComponentContext()

Returns the ComponentContext.

Returns:

the OSGi ComponentContext

_channel

@Deprecated
Channel<?> _channel(java.lang.String channelName)

Deprecated.

Returns an undefined Channel defined by its ChannelId string representation.

Note: It is preferred to use the typed channel()-method, that's why it is marked as @Deprecated.

Parameters:

channelName - the Channel-ID as a string

Returns:

the Channel or null

channel

default <T extends Channel<?>> T channel(java.lang.String channelName)
                                  throws java.lang.IllegalArgumentException

Returns a Channel defined by its ChannelId string representation.

Type Parameters:

T - the expected typed Channel

Parameters:

channelName - the Channel-ID as a string

Returns:

the Channel or throw Exception

Throws:

java.lang.IllegalArgumentException - on error

channel

default <T extends Channel<?>> T channel(ChannelId channelId)
                                  throws java.lang.IllegalArgumentException

Returns a Channel defined by its ChannelId.

Type Parameters:

T - the Type of the Channel. See Doc.getType()

Parameters:

channelId - the Channel-ID

Returns:

the Channel

Throws:

java.lang.IllegalArgumentException - on error

channels

java.util.Collection<Channel<?>> channels()

Returns all Channels.

Returns:

a Collection of Channels

getModbusSlaveNatureTable

static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)

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

getStateChannel

default StateCollectorChannel getStateChannel()

Gets the Component State-Channel.

Returns:

the StateCollectorChannel

getState

default Level getState()

Gets the Component State Level.

Returns:

the StateCollectorChannel

_getChannelAs

default <T extends Channel<?>> T _getChannelAs(OpenemsComponent.ChannelId channelId,
                                               java.lang.Class<T> type)

Gets the Channel as the given Type.

Type Parameters:

T - the expected Channel type

Parameters:

channelId - the Channel-ID

type - the expected Type

Returns:

the Channel

debugLog

default java.lang.String debugLog()

Gets some output that is suitable for a continuous Debug log. Returns 'null' by default which causes no output.

Returns:

the debug log output

hasFaults

default boolean hasFaults()

Does this OpenEMS Component report any Faults?

Evaluates all StateChannels and returns true if any Channel with Level.FAULT is set.

Returns:

true if there is a Fault.

updateReferenceFilter

static boolean updateReferenceFilter(org.osgi.service.cm.ConfigurationAdmin cm,
                                     java.lang.String pid,
                                     java.lang.String member,
                                     java.lang.String... ids)

Sets a target filter for a Declarative Service @Reference member.

Usage:

 updateReferenceFilter(config.service_pid(), "Controllers", controllersIds);
 

Generates a 'target' filter on the 'Controllers' member so, that the the expected service to be injected needs to fulfill:

• the service must be enabled
• the service must not have the same PID as the calling component
• the service "id" must be one of the provided "controllersIds"

Parameters:

cm - a ConfigurationAdmin instance. Get one using

               @Reference
               ConfigurationAdmin cm;
               

pid - PID of the calling component (use 'config.service_pid()' or '(String)prop.get(Constants.SERVICE_PID)'; if null, PID filter is not added to the resulting target filter

member - Name of the Method or Field with the Reference annotation, e.g.

ids - Component IDs to be filtered for; for empty list, no ids are added to the target filter

Returns:

true if the filter was updated. You may use it to abort the activate() method.

updateConfigurationProperty

static void updateConfigurationProperty(org.osgi.service.cm.ConfigurationAdmin cm,
                                        java.lang.String pid,
                                        java.lang.String property,
                                        java.lang.Object value)

Update a configuration property.

Usage:

 updateConfigurationProperty(cm, servicePid, "propertyName", "propertyValue");
 

Parameters:

cm - a ConfigurationAdmin instance. Get one using

                 @Reference
                 ConfigurationAdmin cm;
                 

pid - PID of the calling component (use 'config.service_pid()' or '(String)prop.get(Constants.SERVICE_PID)'

property - Name of the configuration property

value - New configuration value