io.openems.edge.bridge.modbus.api

Class AbstractOpenemsModbusComponent

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.bridge.modbus.api.AbstractOpenemsModbusComponent

All Implemented Interfaces:

OpenemsComponent

Direct Known Subclasses:

AbstractEssStreetscooter, AbstractFeneconDessCharger, AbstractGoodWeEtCharger, AbstractOpenemsSunSpecComponent, AbstractSocomecMeter, BatteryBoxC130Impl, BmwBatteryImpl, ClusterVersionB, ClusterVersionCImpl, EssDcChargerFeneconCommercial40, EssFeneconBydContainer, EssFeneconCommercial40Impl, EssKacoBlueplanetGridsave50, EssSinexcelImpl, FeneconDessEss, FeneconDessGridMeter, FeneconDessPvMeter, FeneconHomeBatteryImpl, FeneconMiniEssImpl, FeneconMiniGridMeter, FeneconMiniPvMeter, FeneconProEss, FeneconProPvMeter, GoodWeEssImpl, GoodWeGridMeter, GridconPCS, KmtronicRelayOutput, MeterArtemesAM2, MeterBControlEM300Impl, MeterCarloGavazziEm300Impl, MeterJanitzaUmg604Impl, MeterJanitzaUmg96rme, MeterMicrocareSdm630Impl, MeterPqplusUmd97, MeterSchneiderActi9Smartlink, MeterSmaShm20Impl, MeterWeidmueller525, RefuEss, RefuStore88kImpl, SingleRack, SingleRackVersionBImpl, SingleRackVersionCImpl, SolarLogImpl, SunnyIsland6Ess, Wago

public abstract class AbstractOpenemsModbusComponent
extends AbstractOpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractOpenemsModbusComponent.BitConverter
class	AbstractOpenemsModbusComponent.ChannelMapper<T extends AbstractModbusElement<?>> Maps an Element to one or more ModbusChannels using converters, that convert the value forward and backwards.

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

OpenemsComponent.ChannelId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOpenemsModbusComponent(ChannelId[] firstInitialChannelIds, ChannelId[]... furtherInitialChannelIds) Default constructor for AbstractOpenemsModbusComponent.

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context, java.lang.String id, java.lang.String alias, boolean enabled) Handles @Activate of implementations.
protected boolean	activate(org.osgi.service.component.ComponentContext context, java.lang.String id, java.lang.String alias, boolean enabled, int unitId, org.osgi.service.cm.ConfigurationAdmin cm, java.lang.String modbusReference, java.lang.String modbusId) Call this method from Component implementations activate().
protected void	activate(java.lang.String id)
static java.lang.Short	convert(int value, int upperBytes) Converts upper/lower bytes to Short.
protected void	deactivate() Handles @Deactivate of implementations.
protected abstract ModbusProtocol	defineModbusProtocol() Defines the Modbus protocol.
java.lang.Integer	getUnitId()
protected AbstractModbusElement<?>	m(BitsWordElement bitsWordElement) Maps the given BitsWordElement.
protected <T extends AbstractModbusElement<?>> T	m(ChannelId channelId, T element) Maps the given element 1-to-1 to the Channel identified by channelId.
protected <T extends AbstractModbusElement<?>> AbstractModbusElement<?>	m(ChannelId channelId, T element, ElementToChannelConverter converter) Maps the given element to the Channel identified by channelId, applying the given @link{ElementToChannelConverter}.
protected <T extends AbstractModbusElement<?>> AbstractOpenemsModbusComponent.ChannelMapper<T>	m(T element) Creates a ChannelMapper that can be used with builder pattern inside the protocol definition.
protected void	setModbus(BridgeModbus modbus) Set the Modbus bridge.
protected void	unsetModbus(BridgeModbus modbus) Unset the Modbus bridge.

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

_channel, addChannel, addChannels, addChannels, alias, channels, 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

Constructor Detail

AbstractOpenemsModbusComponent

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

Default constructor for AbstractOpenemsModbusComponent.

Automatically initializes (i.e. creates Channel instances for each given ChannelId using the Channel-Doc.

It is important to list all Channel-ID enums of all inherited OpenEMS-Natures, i.e. for every OpenEMS Java interface you are implementing, you need to list the interface' ChannelID-enum here like Interface.ChannelId.values().

Use as follows:

 public YourPhantasticOpenemsComponent() {
        super(//
                        OpenemsComponent.ChannelId.values(), //
                        YourPhantasticOpenemsComponent.ChannelId.values());
 }
 

Note: the separation in firstInitialChannelIds and furtherInitialChannelIds is only there to enforce that calling the constructor cannot be forgotten. This way it needs to be called with at least one parameter - which is always at least "OpenemsComponent.ChannelId.values()". Just use it as if it was:

 AbstractOpenemsComponent(ChannelId[]... channelIds)
 

Parameters:

firstInitialChannelIds - the Channel-IDs to initialize.

furtherInitialChannelIds - the Channel-IDs to initialize.

Method Detail

activate

protected void activate(java.lang.String id)

activate

protected boolean activate(org.osgi.service.component.ComponentContext context,
                           java.lang.String id,
                           java.lang.String alias,
                           boolean enabled,
                           int unitId,
                           org.osgi.service.cm.ConfigurationAdmin cm,
                           java.lang.String modbusReference,
                           java.lang.String modbusId)
                    throws OpenemsException

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()'

unitId - Unit-ID of the Modbus target

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

modbusReference - The name of the @Reference setter method for the Modbus bridge - e.g. 'Modbus' if you have a setModbus()-method

modbusId - The ID of the Modbus bridge. Typically 'config.modbus_id()'

Returns:

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

Throws:

OpenemsException - on error

activate

protected void activate(org.osgi.service.component.ComponentContext context,
                        java.lang.String id,
                        java.lang.String alias,
                        boolean enabled)

Description copied from class: AbstractOpenemsComponent

Handles @Activate of implementations. Prints log output.

Overrides:

activate in class AbstractOpenemsComponent

Parameters:

context - the OSGi ComponentContext

id - the unique OpenEMS Component ID

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

enabled - is the Component enabled?

deactivate

protected void deactivate()

Description copied from class: AbstractOpenemsComponent

Handles @Deactivate of implementations. Prints log output.

Overrides:

deactivate in class AbstractOpenemsComponent

getUnitId

public java.lang.Integer getUnitId()

setModbus

protected void setModbus(BridgeModbus modbus)

Set the Modbus bridge. Should be called by @Reference

Parameters:

modbus - the BridgeModbus Reference

unsetModbus

protected void unsetModbus(BridgeModbus modbus)

Unset the Modbus bridge. Should be called by @Reference

Parameters:

modbus - the BridgeModbus Reference

defineModbusProtocol

protected abstract ModbusProtocol defineModbusProtocol()
                                                throws OpenemsException

Defines the Modbus protocol.

Returns:

the ModbusProtocol

Throws:

OpenemsException - on error

m

protected final <T extends AbstractModbusElement<?>> AbstractOpenemsModbusComponent.ChannelMapper<T> m(T element)

Creates a ChannelMapper that can be used with builder pattern inside the protocol definition.

Parameters:

element - the ModbusElement

Returns:

a AbstractOpenemsModbusComponent.ChannelMapper

m

protected final AbstractModbusElement<?> m(BitsWordElement bitsWordElement)

Maps the given BitsWordElement.

Parameters:

bitsWordElement - the ModbusElement

Returns:

the element parameter

m

protected final <T extends AbstractModbusElement<?>> T m(ChannelId channelId,
                                                         T element)

Maps the given element 1-to-1 to the Channel identified by channelId.

Parameters:

channelId - the Channel-ID

element - the ModbusElement

Returns:

the element parameter

m

protected final <T extends AbstractModbusElement<?>> AbstractModbusElement<?> m(ChannelId channelId,
                                                                                T element,
                                                                                ElementToChannelConverter converter)

Maps the given element to the Channel identified by channelId, applying the given @link{ElementToChannelConverter}.

Parameters:

channelId - the Channel-ID

element - the ModbusElement

converter - the ElementToChannelConverter

Returns:

the element parameter

convert

public static java.lang.Short convert(int value,
                                      int upperBytes)

Converts upper/lower bytes to Short.

Parameters:

value - the int value

upperBytes - 1 = upper two bytes, 0 = lower two bytes

Returns:

the Short