io.openems.edge.bridge.modbus.api

Interface BridgeModbus

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

BridgeModbusSerial, BridgeModbusTcp

All Known Implementing Classes:

AbstractModbusBridge, BridgeModbusSerialImpl, BridgeModbusTcpImpl, DummyModbusBridge, ModbusSimulator

@ProviderType
public interface BridgeModbus
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BridgeModbus.ChannelId

Method Summary

Modifier and Type	Method and Description
default void	_setCycleTimeIsTooShort(boolean value) Internal method to set the 'nextValue' on BridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT Channel.
default void	_setExecutionDuration(long value) Internal method to set the 'nextValue' on BridgeModbus.ChannelId.EXECUTION_DURATION Channel.
default void	_setSlaveCommunicationFailed(boolean value) Internal method to set the 'nextValue' on BridgeModbus.ChannelId.SLAVE_COMMUNICATION_FAILED Channel.
void	addProtocol(java.lang.String sourceId, ModbusProtocol protocol) Adds a Protocol with a source identifier to this Modbus Bridge.
default Value<java.lang.Boolean>	getCycleTimeIsTooShort() Gets the Cycle-Time-is-too-short State.
default StateChannel	getCycleTimeIsTooShortChannel() Gets the Channel for BridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT.
default Value<java.lang.Long>	getExecutionDuration() Gets the Execution Duration in [ms], see BridgeModbus.ChannelId.EXECUTION_DURATION.
default LongReadChannel	getExecutionDurationChannel() Gets the Channel for BridgeModbus.ChannelId.EXECUTION_DURATION.
default Value<java.lang.Boolean>	getSlaveCommunicationFailed() Gets the Slave Communication Failed State.
default StateChannel	getSlaveCommunicationFailedChannel() Gets the Channel for BridgeModbus.ChannelId.SLAVE_COMMUNICATION_FAILED.
void	removeProtocol(java.lang.String sourceId) Removes a Protocol from this Modbus Bridge.

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

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getModbusSlaveNatureTable, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid, updateConfigurationProperty, updateReferenceFilter

Method Detail

getSlaveCommunicationFailedChannel

default StateChannel getSlaveCommunicationFailedChannel()

Gets the Channel for BridgeModbus.ChannelId.SLAVE_COMMUNICATION_FAILED.

Returns:

the Channel

getSlaveCommunicationFailed

default Value<java.lang.Boolean> getSlaveCommunicationFailed()

Gets the Slave Communication Failed State. See BridgeModbus.ChannelId.SLAVE_COMMUNICATION_FAILED.

Returns:

the Channel Value

_setSlaveCommunicationFailed

default void _setSlaveCommunicationFailed(boolean value)

Internal method to set the 'nextValue' on BridgeModbus.ChannelId.SLAVE_COMMUNICATION_FAILED Channel.

Parameters:

value - the next value

getCycleTimeIsTooShortChannel

default StateChannel getCycleTimeIsTooShortChannel()

Gets the Channel for BridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT.

Returns:

the Channel

getCycleTimeIsTooShort

default Value<java.lang.Boolean> getCycleTimeIsTooShort()

Gets the Cycle-Time-is-too-short State. See BridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT.

Returns:

the Channel Value

_setCycleTimeIsTooShort

default void _setCycleTimeIsTooShort(boolean value)

Internal method to set the 'nextValue' on BridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT Channel.

Parameters:

value - the next value

getExecutionDurationChannel

default LongReadChannel getExecutionDurationChannel()

Gets the Channel for BridgeModbus.ChannelId.EXECUTION_DURATION.

Returns:

the Channel

getExecutionDuration

default Value<java.lang.Long> getExecutionDuration()

Gets the Execution Duration in [ms], see BridgeModbus.ChannelId.EXECUTION_DURATION.

Returns:

the Channel Value

_setExecutionDuration

default void _setExecutionDuration(long value)

Internal method to set the 'nextValue' on BridgeModbus.ChannelId.EXECUTION_DURATION Channel.

Parameters:

value - the next value

addProtocol

void addProtocol(java.lang.String sourceId,
                 ModbusProtocol protocol)

Adds a Protocol with a source identifier to this Modbus Bridge.

Parameters:

sourceId - the unique source identifier

protocol - the Modbus Protocol

removeProtocol

void removeProtocol(java.lang.String sourceId)

Removes a Protocol from this Modbus Bridge.

Parameters:

sourceId - the unique source identifier