io.openems.edge.bridge.mbus.api

Class AbstractOpenemsMbusComponent

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.bridge.mbus.api.AbstractOpenemsMbusComponent

All Implemented Interfaces:

OpenemsComponent

Direct Known Subclasses:

MeterAbbB23Mbus

public abstract class AbstractOpenemsMbusComponent
extends AbstractOpenemsComponent

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.common.component.OpenemsComponent

OpenemsComponent.ChannelId

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<ChannelRecord>	channelDataRecordsList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOpenemsMbusComponent(ChannelId[] firstInitialChannelIds, ChannelId[]... furtherInitialChannelIds)

Method Summary

Modifier and Type	Method and Description
protected boolean	activate(org.osgi.service.component.ComponentContext context, java.lang.String id, java.lang.String alias, boolean enabled, int primaryAddress, org.osgi.service.cm.ConfigurationAdmin cm, java.lang.String mbusReference, java.lang.String mbusId) Call this method from Component implementations activate().
protected abstract void	addChannelDataRecords() Define channels of the mbus device and the record position of its corresponding values or the datatype if the channel displays secondary address values.
java.util.List<ChannelRecord>	getChannelDataRecordsList()
java.lang.Integer	getPrimaryAddress()

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, activate, addChannel, addChannels, addChannels, alias, channels, deactivate, getComponentContext, id, isEnabled, logDebug, logError, logInfo, logWarn, modified, removeChannel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

_getChannelAs, channel, channel, debugLog, getModbusSlaveNatureTable, getState, getStateChannel, hasFaults, serviceFactoryPid, servicePid, updateConfigurationProperty, updateReferenceFilter

Field Detail

channelDataRecordsList

protected final java.util.List<ChannelRecord> channelDataRecordsList

Constructor Detail

AbstractOpenemsMbusComponent

protected AbstractOpenemsMbusComponent(ChannelId[] firstInitialChannelIds,
                                       ChannelId[]... furtherInitialChannelIds)

Method Detail

getChannelDataRecordsList

public java.util.List<ChannelRecord> getChannelDataRecordsList()

getPrimaryAddress

public java.lang.Integer getPrimaryAddress()

activate

protected boolean activate(org.osgi.service.component.ComponentContext context,
                           java.lang.String id,
                           java.lang.String alias,
                           boolean enabled,
                           int primaryAddress,
                           org.osgi.service.cm.ConfigurationAdmin cm,
                           java.lang.String mbusReference,
                           java.lang.String mbusId)

Call this method from Component implementations activate().

Parameters:

context - ComponentContext of this component. Receive it from parameter for @Activate

id - ID of this component. Typically 'config.id()'

alias - Human-readable name of this Component. Typically 'config.alias()'. Defaults to 'id' if empty

enabled - Whether the component should be enabled. Typically 'config.enabled()'

primaryAddress - Primary address of the M-Bus device. Typically 'config.primaryAddress'

cm - An instance of ConfigurationAdmin. Receive it using @Reference

mbusReference - The name of the @Reference setter method for the M-Bus bridge

mbusId - The ID of the M-Bus bridge. Typically 'config.mbus_id()'

Returns:

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

addChannelDataRecords

protected abstract void addChannelDataRecords()

Define channels of the mbus device and the record position of its corresponding values or the datatype if the channel displays secondary address values.