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 Description static class
BridgeModbus.ChannelId
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
_setCycleTimeIsTooShort(boolean value)
Internal method to set the 'nextValue' onBridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT
Channel.default void
_setExecutionDuration(long value)
Internal method to set the 'nextValue' onBridgeModbus.ChannelId.EXECUTION_DURATION
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 forBridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT
.default Value<java.lang.Long>
getExecutionDuration()
Gets the Execution Duration in [ms], seeBridgeModbus.ChannelId.EXECUTION_DURATION
.default LongReadChannel
getExecutionDurationChannel()
Gets the Channel forBridgeModbus.ChannelId.EXECUTION_DURATION
.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, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid
-
-
-
-
Method Detail
-
getCycleTimeIsTooShortChannel
default StateChannel getCycleTimeIsTooShortChannel()
Gets the Channel forBridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT
.- Returns:
- the Channel
-
getCycleTimeIsTooShort
default Value<java.lang.Boolean> getCycleTimeIsTooShort()
Gets the Cycle-Time-is-too-short State. SeeBridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT
.- Returns:
- the Channel
Value
-
_setCycleTimeIsTooShort
default void _setCycleTimeIsTooShort(boolean value)
Internal method to set the 'nextValue' onBridgeModbus.ChannelId.CYCLE_TIME_IS_TOO_SHORT
Channel.- Parameters:
value
- the next value
-
getExecutionDurationChannel
default LongReadChannel getExecutionDurationChannel()
Gets the Channel forBridgeModbus.ChannelId.EXECUTION_DURATION
.- Returns:
- the Channel
-
getExecutionDuration
default Value<java.lang.Long> getExecutionDuration()
Gets the Execution Duration in [ms], seeBridgeModbus.ChannelId.EXECUTION_DURATION
.- Returns:
- the Channel
Value
-
_setExecutionDuration
default void _setExecutionDuration(long value)
Internal method to set the 'nextValue' onBridgeModbus.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 identifierprotocol
- the Modbus Protocol
-
removeProtocol
void removeProtocol(java.lang.String sourceId)
Removes a Protocol from this Modbus Bridge.- Parameters:
sourceId
- the unique source identifier
-
-