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

Class FirmataProtocolLogic

java.lang.Object

org.apache.plc4x.java.spi.Plc4xProtocolBase<FirmataMessage>

org.apache.plc4x.java.firmata.readwrite.protocol.FirmataProtocolLogic

All Implemented Interfaces:

PlcSubscriber

public class FirmataProtocolLogic
extends Plc4xProtocolBase<FirmataMessage>
implements PlcSubscriber

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	REQUEST_TIMEOUT

Fields inherited from class org.apache.plc4x.java.spi.Plc4xProtocolBase

context, driverContext

Constructor Summary

Constructors

Constructor	Description
FirmataProtocolLogic()

Method Summary

Modifier and Type	Method	Description
void	close(ConversationContext<FirmataMessage> context)
protected int	convertToSingleByteRepresentation(List<Byte> data)
protected void	decode(ConversationContext<FirmataMessage> context, FirmataMessage msg)
protected int	getAnalogValue(List<Byte> data)
protected BitSet	getDigitalValues(int byteBlock, List<Byte> data)
void	onConnect(ConversationContext<FirmataMessage> context)
protected void	publishAnalogEvents(int pin, int value)
protected void	publishDigitalEvents(BitSet changedBits, BitSet bitValues)
PlcConsumerRegistration	register(Consumer<PlcSubscriptionEvent> consumer, Collection<PlcSubscriptionHandle> collection)
protected void	sendUpdateEvents(Consumer<PlcSubscriptionEvent> consumer, String fieldName, List<PlcValue> values)
CompletableFuture<PlcSubscriptionResponse>	subscribe(PlcSubscriptionRequest subscriptionRequest)
void	unregister(PlcConsumerRegistration plcConsumerRegistration)
CompletableFuture<PlcUnsubscriptionResponse>	unsubscribe(PlcUnsubscriptionRequest unsubscriptionRequest)
CompletableFuture<PlcWriteResponse>	write(PlcWriteRequest writeRequest)

Methods inherited from class org.apache.plc4x.java.spi.Plc4xProtocolBase

browse, getDriverContext, onDisconnect, onDiscover, read, setContext, setDriverContext

Methods inherited from class java.lang.Object

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

Field Details

REQUEST_TIMEOUT

public static final Duration REQUEST_TIMEOUT

Constructor Details

FirmataProtocolLogic

public FirmataProtocolLogic()

Method Details

onConnect

public void onConnect(ConversationContext<FirmataMessage> context)

Overrides:

onConnect in class Plc4xProtocolBase<FirmataMessage>

write

public CompletableFuture<PlcWriteResponse> write(PlcWriteRequest writeRequest)

Overrides:

write in class Plc4xProtocolBase<FirmataMessage>

subscribe

public CompletableFuture<PlcSubscriptionResponse> subscribe(PlcSubscriptionRequest subscriptionRequest)

Specified by:

subscribe in interface PlcSubscriber

Overrides:

subscribe in class Plc4xProtocolBase<FirmataMessage>

unsubscribe

public CompletableFuture<PlcUnsubscriptionResponse> unsubscribe(PlcUnsubscriptionRequest unsubscriptionRequest)

Specified by:

unsubscribe in interface PlcSubscriber

Overrides:

unsubscribe in class Plc4xProtocolBase<FirmataMessage>

decode

protected void decode(ConversationContext<FirmataMessage> context,
 FirmataMessage msg)

Overrides:

decode in class Plc4xProtocolBase<FirmataMessage>

close

public void close(ConversationContext<FirmataMessage> context)

Specified by:

close in class Plc4xProtocolBase<FirmataMessage>

register

public PlcConsumerRegistration register(Consumer<PlcSubscriptionEvent> consumer,
 Collection<PlcSubscriptionHandle> collection)

Specified by:

register in interface PlcSubscriber

unregister

public void unregister(PlcConsumerRegistration plcConsumerRegistration)

Specified by:

unregister in interface PlcSubscriber

publishAnalogEvents

protected void publishAnalogEvents(int pin,
 int value)

publishDigitalEvents

protected void publishDigitalEvents(BitSet changedBits,
 BitSet bitValues)

sendUpdateEvents

protected void sendUpdateEvents(Consumer<PlcSubscriptionEvent> consumer,
 String fieldName,
 List<PlcValue> values)

getAnalogValue

protected int getAnalogValue(List<Byte> data)

convertToSingleByteRepresentation

protected int convertToSingleByteRepresentation(List<Byte> data)

getDigitalValues

protected BitSet getDigitalValues(int byteBlock,
 List<Byte> data)