Package io.openems.edge.controller.api.modbus

Class AbstractModbusTcpApi

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.controller.api.modbus.AbstractModbusTcpApi

All Implemented Interfaces:

OpenemsComponent, JsonApi, Controller, ModbusTcpApi

Direct Known Subclasses:

ModbusTcpApiReadOnlyImpl, ModbusTcpApiReadWriteImpl

public abstract class AbstractModbusTcpApi
extends AbstractOpenemsComponent
implements ModbusTcpApi, Controller, OpenemsComponent, JsonApi

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.controller.api.Controller

Controller.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.controller.api.modbus.ModbusTcpApi

ModbusTcpApi.ChannelId

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

OpenemsComponent.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
protected ApiWorker	apiWorker
static int	DEFAULT_MAX_CONCURRENT_CONNECTIONS
static int	DEFAULT_PORT
protected java.util.TreeMap<java.lang.Integer,ModbusRecord>	records	Holds the link between Modbus address and ModbusRecord.
static int	UNIT_ID

Constructor Summary

Constructors

Constructor	Description
AbstractModbusTcpApi(java.lang.String implementationName, ChannelId[] firstInitialChannelIds, ChannelId[]... furtherInitialChannelIds)

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext context, java.lang.String id, java.lang.String alias, boolean enabled, org.osgi.service.cm.ConfigurationAdmin cm, Meta metaComponent, java.lang.String[] componentIds, int apiTimeout, int port, int maxConcurrentConnections)
protected void	addComponent(ModbusSlave component)
protected void	deactivate()	Handles @Deactivate of implementations.
protected abstract AccessMode	getAccessMode()	Gets the AccessMode.
protected ModbusSlave	getComponent(java.lang.String componentId)	Gets the Component.
java.util.concurrent.CompletableFuture<JsonrpcResponseSuccess>	handleJsonrpcRequest(User user, JsonrpcRequest message)	Handles a JSON-RPC Request.
protected void	logDebug(org.slf4j.Logger log, java.lang.String message)	Log a debug message including the Component ID.
protected void	logInfo(org.slf4j.Logger log, java.lang.String message)	Log an info message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, java.lang.String message)	Log a warn message including the Component ID.
void	run()	Executes the Controller logic.

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

_channel, activate, addChannel, addChannels, addChannels, alias, channels, getComponentContext, id, isEnabled, logError, 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.controller.api.Controller

_setRunFailed, getRunFailed, getRunFailedChannel

Methods inherited from interface io.openems.edge.controller.api.modbus.ModbusTcpApi

_setProcessImageFault, _setUnableToStart, getProcessImageFault, getProcessImageFaultChannel, getUnableToStart, getUnableToStartChannel

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

Field Detail

UNIT_ID

public static final int UNIT_ID

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_MAX_CONCURRENT_CONNECTIONS

public static final int DEFAULT_MAX_CONCURRENT_CONNECTIONS

See Also:

Constant Field Values

apiWorker

protected final ApiWorker apiWorker

records

protected final java.util.TreeMap<java.lang.Integer,ModbusRecord> records

Holds the link between Modbus address and ModbusRecord.

Constructor Detail

AbstractModbusTcpApi

public AbstractModbusTcpApi(java.lang.String implementationName,
                            ChannelId[] firstInitialChannelIds,
                            ChannelId[]... furtherInitialChannelIds)

Method Detail

addComponent

protected void addComponent(ModbusSlave component)

activate

protected void activate(org.osgi.service.component.ComponentContext context,
                        java.lang.String id,
                        java.lang.String alias,
                        boolean enabled,
                        org.osgi.service.cm.ConfigurationAdmin cm,
                        Meta metaComponent,
                        java.lang.String[] componentIds,
                        int apiTimeout,
                        int port,
                        int maxConcurrentConnections)
                 throws OpenemsException

Throws:

OpenemsException

deactivate

protected void deactivate()

Description copied from class: AbstractOpenemsComponent

Handles @Deactivate of implementations. Prints log output.

Overrides:

deactivate in class AbstractOpenemsComponent

run

public void run()
         throws OpenemsError.OpenemsNamedException

Description copied from interface: Controller

Executes the Controller logic.

Specified by:

run in interface Controller

Throws:

OpenemsError.OpenemsNamedException - on error

logDebug

protected void logDebug(org.slf4j.Logger log,
                        java.lang.String message)

Description copied from class: AbstractOpenemsComponent

Log a debug message including the Component ID.

Overrides:

logDebug in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

logInfo

protected void logInfo(org.slf4j.Logger log,
                       java.lang.String message)

Description copied from class: AbstractOpenemsComponent

Log an info message including the Component ID.

Overrides:

logInfo in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

logWarn

protected void logWarn(org.slf4j.Logger log,
                       java.lang.String message)

Description copied from class: AbstractOpenemsComponent

Log a warn message including the Component ID.

Overrides:

logWarn in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

handleJsonrpcRequest

public java.util.concurrent.CompletableFuture<JsonrpcResponseSuccess> handleJsonrpcRequest(User user,
                                                                                           JsonrpcRequest message)
                                                                                    throws OpenemsError.OpenemsNamedException

Description copied from interface: JsonApi

Handles a JSON-RPC Request.

Specified by:

handleJsonrpcRequest in interface JsonApi

Parameters:

user - the authenticated User

message - the JSON-RPC Request

Returns:

a Future JSON-RPC Success Response; null response results in a OpenemsError.JSONRPC_UNHANDLED_METHOD

Throws:

OpenemsError.OpenemsNamedException - on error

getAccessMode

protected abstract AccessMode getAccessMode()

Gets the AccessMode.

Returns:

the AccessMode

getComponent

protected ModbusSlave getComponent(java.lang.String componentId)

Gets the Component.

Parameters:

componentId - the Component-ID

Returns:

the ModbusSlave Component