Package org.apache.plc4x.java.modbus.tcp

Class ModbusTcpDriver

java.lang.Object

org.apache.plc4x.java.spi.connection.GeneratedDriverBase<ModbusTcpADU>

org.apache.plc4x.java.modbus.tcp.ModbusTcpDriver

All Implemented Interfaces:

PlcDriver

public class ModbusTcpDriver
extends GeneratedDriverBase<ModbusTcpADU>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModbusTcpDriver.ByteLengthEstimator	Estimate the Length of a Packet

Field Summary

Fields inherited from class org.apache.plc4x.java.spi.connection.GeneratedDriverBase

PROPERTY_PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE, PROPERTY_PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE, PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE, PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT, URI_PATTERN

Constructor Summary

Constructors

Constructor	Description
ModbusTcpDriver()

Method Summary

Modifier and Type	Method	Description
protected boolean	awaitDisconnectComplete()	This protocol doesn't have a disconnect procedure, so there is no need to wait for a login to finish.
protected boolean	awaitSetupComplete()	Modbus doesn't have a login procedure, so there is no need to wait for a login to finish.
protected boolean	canPing()
protected boolean	canRead()
protected boolean	canWrite()
PlcDiscoveryRequest.Builder	discoveryRequestBuilder()
protected Class<? extends PlcConnectionConfiguration>	getConfigurationClass()
protected Optional<String>	getDefaultTransportCode()
protected BaseOptimizer	getOptimizer()
String	getProtocolCode()
String	getProtocolName()
protected ProtocolStackConfigurer<ModbusTcpADU>	getStackConfigurer()
protected List<String>	getSupportedTransportCodes()
protected ModbusTagHandler	getTagHandler()
protected Optional<Class<? extends PlcTransportConfiguration>>	getTransportConfigurationClass(String transportCode)
protected PlcValueHandler	getValueHandler()
ModbusTag	prepareTag(String tagAddress)

Methods inherited from class org.apache.plc4x.java.spi.connection.GeneratedDriverBase

awaitDiscoverComplete, canBrowse, canSubscribe, fireDiscoverEvent, getAllFields, getConnection, getConnection, getMetadata, getStackConfigurer, initializePipeline, resolveTransportConfigurationClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModbusTcpDriver

public ModbusTcpDriver()

Method Detail

getProtocolCode

public String getProtocolCode()

getProtocolName

public String getProtocolName()

getConfigurationClass

protected Class<? extends PlcConnectionConfiguration> getConfigurationClass()

Specified by:

getConfigurationClass in class GeneratedDriverBase<ModbusTcpADU>

getTransportConfigurationClass

protected Optional<Class<? extends PlcTransportConfiguration>> getTransportConfigurationClass(String transportCode)

Overrides:

getTransportConfigurationClass in class GeneratedDriverBase<ModbusTcpADU>

getDefaultTransportCode

protected Optional<String> getDefaultTransportCode()

Overrides:

getDefaultTransportCode in class GeneratedDriverBase<ModbusTcpADU>

getSupportedTransportCodes

protected List<String> getSupportedTransportCodes()

Overrides:

getSupportedTransportCodes in class GeneratedDriverBase<ModbusTcpADU>

discoveryRequestBuilder

public PlcDiscoveryRequest.Builder discoveryRequestBuilder()

awaitSetupComplete

protected boolean awaitSetupComplete()

Modbus doesn't have a login procedure, so there is no need to wait for a login to finish.

Overrides:

awaitSetupComplete in class GeneratedDriverBase<ModbusTcpADU>

Returns:

false

awaitDisconnectComplete

protected boolean awaitDisconnectComplete()

This protocol doesn't have a disconnect procedure, so there is no need to wait for a login to finish.

Overrides:

awaitDisconnectComplete in class GeneratedDriverBase<ModbusTcpADU>

Returns:

false

canPing

protected boolean canPing()

Overrides:

canPing in class GeneratedDriverBase<ModbusTcpADU>

canRead

protected boolean canRead()

Overrides:

canRead in class GeneratedDriverBase<ModbusTcpADU>

canWrite

protected boolean canWrite()

Overrides:

canWrite in class GeneratedDriverBase<ModbusTcpADU>

getOptimizer

protected BaseOptimizer getOptimizer()

Overrides:

getOptimizer in class GeneratedDriverBase<ModbusTcpADU>

getTagHandler

protected ModbusTagHandler getTagHandler()

Specified by:

getTagHandler in class GeneratedDriverBase<ModbusTcpADU>

getValueHandler

protected PlcValueHandler getValueHandler()

Specified by:

getValueHandler in class GeneratedDriverBase<ModbusTcpADU>

getStackConfigurer

protected ProtocolStackConfigurer<ModbusTcpADU> getStackConfigurer()

Specified by:

getStackConfigurer in class GeneratedDriverBase<ModbusTcpADU>

prepareTag

public ModbusTag prepareTag(String tagAddress)