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

Interface ModbusTcpApi

All Superinterfaces:

OpenemsComponent

All Known Implementing Classes:

AbstractModbusTcpApi, ControllerApiModbusTcpReadOnlyImpl, ControllerApiModbusTcpReadWriteImpl

public interface ModbusTcpApi
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ModbusTcpApi.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setComponentMissingFault(boolean value)	Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.COMPONENT_MISSING_FAULT Channel.
default void	_setComponentNoModbusApiFault(boolean value)	Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.COMPONENT_NO_MODBUS_API_FAULT Channel.
default void	_setProcessImageFault(boolean value)	Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.PROCESS_IMAGE_FAULT Channel.
default void	_setUnableToStart(boolean value)	Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.UNABLE_TO_START Channel.
default Value<Boolean>	getComponentMissingFault()	Gets the Component Missing Fault State.
default StateChannel	getComponentMissingFaultChannel()	Gets the Channel for ModbusTcpApi.ChannelId.COMPONENT_MISSING_FAULT.
default Value<Boolean>	getComponentNoModbusApiFault()	Gets the Component No Modbus-API Fault State.
default StateChannel	getComponentNoModbusApiFaultChannel()	Gets the Channel for ModbusTcpApi.ChannelId.COMPONENT_NO_MODBUS_API_FAULT.
default Value<Boolean>	getProcessImageFault()	Gets the Unable to Start Fault State.
default StateChannel	getProcessImageFaultChannel()	Gets the Channel for ModbusTcpApi.ChannelId.PROCESS_IMAGE_FAULT.
default Value<Boolean>	getUnableToStart()	Gets the Unable to Start Fault State.
default StateChannel	getUnableToStartChannel()	Gets the Channel for ModbusTcpApi.ChannelId.UNABLE_TO_START.

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 Details

getUnableToStartChannel

default StateChannel getUnableToStartChannel()

Gets the Channel for ModbusTcpApi.ChannelId.UNABLE_TO_START.

Returns:

the Channel

getUnableToStart

default Value<Boolean> getUnableToStart()

Gets the Unable to Start Fault State. See ModbusTcpApi.ChannelId.UNABLE_TO_START.

Returns:

the Channel Value

_setUnableToStart

default void _setUnableToStart(boolean value)

Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.UNABLE_TO_START Channel.

Parameters:

value - the next value

getProcessImageFaultChannel

default StateChannel getProcessImageFaultChannel()

Gets the Channel for ModbusTcpApi.ChannelId.PROCESS_IMAGE_FAULT.

Returns:

the Channel

getProcessImageFault

default Value<Boolean> getProcessImageFault()

Gets the Unable to Start Fault State. See ModbusTcpApi.ChannelId.PROCESS_IMAGE_FAULT.

Returns:

the Channel Value

_setProcessImageFault

default void _setProcessImageFault(boolean value)

Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.PROCESS_IMAGE_FAULT Channel.

Parameters:

value - the next value

getComponentNoModbusApiFaultChannel

default StateChannel getComponentNoModbusApiFaultChannel()

Gets the Channel for ModbusTcpApi.ChannelId.COMPONENT_NO_MODBUS_API_FAULT.

Returns:

the Channel

getComponentNoModbusApiFault

default Value<Boolean> getComponentNoModbusApiFault()

Gets the Component No Modbus-API Fault State. See ModbusTcpApi.ChannelId.COMPONENT_NO_MODBUS_API_FAULT.

Returns:

the Channel Value

_setComponentNoModbusApiFault

default void _setComponentNoModbusApiFault(boolean value)

Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.COMPONENT_NO_MODBUS_API_FAULT Channel.

Parameters:

value - the next value

getComponentMissingFaultChannel

default StateChannel getComponentMissingFaultChannel()

Gets the Channel for ModbusTcpApi.ChannelId.COMPONENT_MISSING_FAULT.

Returns:

the Channel

getComponentMissingFault

default Value<Boolean> getComponentMissingFault()

Gets the Component Missing Fault State. See ModbusTcpApi.ChannelId.COMPONENT_MISSING_FAULT.

Returns:

the Channel Value

_setComponentMissingFault

default void _setComponentMissingFault(boolean value)

Internal method to set the 'nextValue' on ModbusTcpApi.ChannelId.COMPONENT_MISSING_FAULT Channel.

Parameters:

value - the next value