Class FirmataDriver
- java.lang.Object
-
- org.apache.plc4x.java.spi.connection.GeneratedDriverBase<FirmataMessage>
-
- org.apache.plc4x.java.firmata.readwrite.FirmataDriver
-
- All Implemented Interfaces:
PlcDriver
public class FirmataDriver extends GeneratedDriverBase<FirmataMessage>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFirmataDriver.ByteLengthEstimatorEstimate the Length of a Packetstatic classFirmataDriver.CorruptPackageCleanerConsumes all Bytes till one of the potential message type indicators
-
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 FirmataDriver()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleanawaitDisconnectComplete()This protocol doesn't have a disconnect procedure, so there is no need to wait for a login to finish.protected booleancanSubscribe()protected booleancanWrite()protected Class<? extends PlcConnectionConfiguration>getConfigurationClass()protected Optional<String>getDefaultTransportCode()StringgetProtocolCode()StringgetProtocolName()protected ProtocolStackConfigurer<FirmataMessage>getStackConfigurer()protected List<String>getSupportedTransportCodes()protected PlcTagHandlergetTagHandler()protected PlcValueHandlergetValueHandler()FirmataTagprepareTag(String tagAddress)-
Methods inherited from class org.apache.plc4x.java.spi.connection.GeneratedDriverBase
awaitDiscoverComplete, awaitSetupComplete, canBrowse, canPing, canRead, fireDiscoverEvent, getAllFields, getConnection, getConnection, getMetadata, getOptimizer, getStackConfigurer, getTransportConfigurationClass, initializePipeline, resolveTransportConfigurationClass
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.plc4x.java.api.PlcDriver
discoveryRequestBuilder
-
-
-
-
Method Detail
-
getProtocolCode
public String getProtocolCode()
-
getProtocolName
public String getProtocolName()
-
getConfigurationClass
protected Class<? extends PlcConnectionConfiguration> getConfigurationClass()
- Specified by:
getConfigurationClassin classGeneratedDriverBase<FirmataMessage>
-
getDefaultTransportCode
protected Optional<String> getDefaultTransportCode()
- Overrides:
getDefaultTransportCodein classGeneratedDriverBase<FirmataMessage>
-
getSupportedTransportCodes
protected List<String> getSupportedTransportCodes()
- Overrides:
getSupportedTransportCodesin classGeneratedDriverBase<FirmataMessage>
-
canWrite
protected boolean canWrite()
- Overrides:
canWritein classGeneratedDriverBase<FirmataMessage>
-
canSubscribe
protected boolean canSubscribe()
- Overrides:
canSubscribein classGeneratedDriverBase<FirmataMessage>
-
getTagHandler
protected PlcTagHandler getTagHandler()
- Specified by:
getTagHandlerin classGeneratedDriverBase<FirmataMessage>
-
getValueHandler
protected PlcValueHandler getValueHandler()
- Specified by:
getValueHandlerin classGeneratedDriverBase<FirmataMessage>
-
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:
awaitDisconnectCompletein classGeneratedDriverBase<FirmataMessage>- Returns:
- false
-
getStackConfigurer
protected ProtocolStackConfigurer<FirmataMessage> getStackConfigurer()
- Specified by:
getStackConfigurerin classGeneratedDriverBase<FirmataMessage>
-
prepareTag
public FirmataTag prepareTag(String tagAddress)
-
-