Package org.apache.plc4x.java.firmata.readwrite

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 class	FirmataDriver.ByteLengthEstimator	Estimate the Length of a Packet
static class	FirmataDriver.CorruptPackageCleaner	Consumes 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

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	canSubscribe()
protected boolean	canWrite()
protected Class<? extends PlcConnectionConfiguration>	getConfigurationClass()
protected Optional<String>	getDefaultTransportCode()
String	getProtocolCode()
String	getProtocolName()
protected ProtocolStackConfigurer<FirmataMessage>	getStackConfigurer()
protected List<String>	getSupportedTransportCodes()
protected PlcTagHandler	getTagHandler()
protected PlcValueHandler	getValueHandler()
FirmataTag	prepareTag(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

Constructor Detail

FirmataDriver

public FirmataDriver()

Method Detail

getProtocolCode

public String getProtocolCode()

getProtocolName

public String getProtocolName()

getConfigurationClass

protected Class<? extends PlcConnectionConfiguration> getConfigurationClass()

Specified by:

getConfigurationClass in class GeneratedDriverBase<FirmataMessage>

getDefaultTransportCode

protected Optional<String> getDefaultTransportCode()

Overrides:

getDefaultTransportCode in class GeneratedDriverBase<FirmataMessage>

getSupportedTransportCodes

protected List<String> getSupportedTransportCodes()

Overrides:

getSupportedTransportCodes in class GeneratedDriverBase<FirmataMessage>

canWrite

protected boolean canWrite()

Overrides:

canWrite in class GeneratedDriverBase<FirmataMessage>

canSubscribe

protected boolean canSubscribe()

Overrides:

canSubscribe in class GeneratedDriverBase<FirmataMessage>

getTagHandler

protected PlcTagHandler getTagHandler()

Specified by:

getTagHandler in class GeneratedDriverBase<FirmataMessage>

getValueHandler

protected PlcValueHandler getValueHandler()

Specified by:

getValueHandler in class GeneratedDriverBase<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:

awaitDisconnectComplete in class GeneratedDriverBase<FirmataMessage>

Returns:

false

getStackConfigurer

protected ProtocolStackConfigurer<FirmataMessage> getStackConfigurer()

Specified by:

getStackConfigurer in class GeneratedDriverBase<FirmataMessage>

prepareTag

public FirmataTag prepareTag(String tagAddress)