Package com.diozero.firmata

Class FirmataAdapter

java.lang.Object

com.diozero.firmata.FirmataAdapter

All Implemented Interfaces:

FirmataProtocol, AutoCloseable, Runnable

Direct Known Subclasses:

SerialFirmataAdapter, SocketFirmataAdapter

public abstract class FirmataAdapter
extends Object
implements FirmataProtocol, Runnable, AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FirmataAdapter.FirmwareDetails
static class	FirmataAdapter.I2CResponse
static class	FirmataAdapter.StringDataResponse

Nested classes/interfaces inherited from interface com.diozero.firmata.FirmataProtocol

FirmataProtocol.PinCapability, FirmataProtocol.PinMode

Field Summary

Fields inherited from interface com.diozero.firmata.FirmataProtocol

ANALOG_IO_END, ANALOG_IO_START, ANALOG_MAPPING_QUERY, ANALOG_MAPPING_RESPONSE, CAPABILITY_QUERY, CAPABILITY_RESPONSE, DIGITAL_IO_END, DIGITAL_IO_START, END_SYSEX, EXTENDED_ANALOG, EXTENDED_ID, I2C_CONFIG, I2C_REPLY, I2C_REQUEST, PIN_STATE_QUERY, PIN_STATE_RESPONSE, PROTOCOL_VERSION, REPORT_ANALOG_PIN, REPORT_DIGITAL_PORT, REPORT_FIRMWARE, SAMPLING_INTERVAL, SET_DIGITAL_PIN_VALUE, SET_PIN_MODE, START_SYSEX, STRING_DATA, SYSEX_NON_REALTIME, SYSEX_REALTIME, SYSTEM_RESET

Constructor Summary

Constructors

Constructor	Description
FirmataAdapter(FirmataEventListener eventListener)

Method Summary

Modifier and Type	Method	Description
void	close()
void	enableDigitalReporting(int gpio, boolean enabled)
List<List<FirmataProtocol.PinCapability>>	getBoardCapabilities()
boolean	getDigitalValue(int gpio)
FirmataAdapter.FirmwareDetails	getFirmware()
int	getMax(int gpio, FirmataProtocol.PinMode mode)
FirmataProtocol.PinMode	getPinMode(int gpio)
com.diozero.firmata.FirmataAdapter.PinState	getPinState(int gpio)
com.diozero.firmata.FirmataAdapter.ProtocolVersion	getProtocolVersion()
int	getValue(int gpio)
FirmataAdapter.I2CResponse	i2cRead(int slaveAddress, boolean autoRestart, boolean addressSize10Bit, int length)
FirmataAdapter.I2CResponse	i2cReadData(int slaveAddress, boolean autoRestart, boolean addressSize10Bit, int register, int length)
void	i2cWrite(int slaveAddress, boolean autoRestart, boolean addressSize10Bit, byte[] data)
void	i2cWriteData(int slaveAddress, boolean autoRestart, boolean addressSize10Bit, int register, byte[] data)
void	initialiseBoard()
void	run()
void	setDigitalValue(int gpio, boolean value)
void	setDigitalValues(int port, byte values)
void	setPinMode(int gpio, FirmataProtocol.PinMode pinMode)
void	setSamplingInterval(int intervalMs)
void	setValue(int gpio, int value)
void	start()

Methods inherited from class java.lang.Object

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

Constructor Detail

FirmataAdapter

public FirmataAdapter(FirmataEventListener eventListener)

Method Detail

start

public final void start()

close

public void close()

Specified by:

close in interface AutoCloseable

getMax

public int getMax(int gpio,
                  FirmataProtocol.PinMode mode)

initialiseBoard

public void initialiseBoard()

getFirmware

public FirmataAdapter.FirmwareDetails getFirmware()

getProtocolVersion

public com.diozero.firmata.FirmataAdapter.ProtocolVersion getProtocolVersion()

getBoardCapabilities

public List<List<FirmataProtocol.PinCapability>> getBoardCapabilities()

getPinState

public com.diozero.firmata.FirmataAdapter.PinState getPinState(int gpio)

setSamplingInterval

public void setSamplingInterval(int intervalMs)

enableDigitalReporting

public void enableDigitalReporting(int gpio,
                                   boolean enabled)

getPinMode

public FirmataProtocol.PinMode getPinMode(int gpio)

setPinMode

public void setPinMode(int gpio,
                       FirmataProtocol.PinMode pinMode)

setDigitalValues

public void setDigitalValues(int port,
                             byte values)

getDigitalValue

public boolean getDigitalValue(int gpio)

setDigitalValue

public void setDigitalValue(int gpio,
                            boolean value)

getValue

public int getValue(int gpio)

setValue

public void setValue(int gpio,
                     int value)

i2cRead

public FirmataAdapter.I2CResponse i2cRead(int slaveAddress,
                                          boolean autoRestart,
                                          boolean addressSize10Bit,
                                          int length)
                                   throws RuntimeIOException

Throws:

RuntimeIOException

i2cWrite

public void i2cWrite(int slaveAddress,
                     boolean autoRestart,
                     boolean addressSize10Bit,
                     byte[] data)
              throws RuntimeIOException

Throws:

RuntimeIOException

i2cReadData

public FirmataAdapter.I2CResponse i2cReadData(int slaveAddress,
                                              boolean autoRestart,
                                              boolean addressSize10Bit,
                                              int register,
                                              int length)

i2cWriteData

public void i2cWriteData(int slaveAddress,
                         boolean autoRestart,
                         boolean addressSize10Bit,
                         int register,
                         byte[] data)
                  throws RuntimeIOException

Throws:

RuntimeIOException

run

public void run()

Specified by:

run in interface Runnable