Skip navigation links
A B C D E F G H I J L M N O P R S T U V W 

A

AbstractState - Class in org.firmata4j.fsm
This state stores FSM it belongs to.
AbstractState(FiniteStateMachine) - Constructor for class org.firmata4j.fsm.AbstractState
 
ACTIVATE_SCROLL - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
addEventListener(IODeviceEventListener) - Method in class org.firmata4j.firmata.FirmataDevice
 
addEventListener(PinEventListener) - Method in class org.firmata4j.firmata.FirmataPin
 
addEventListener(IODeviceEventListener) - Method in interface org.firmata4j.IODevice
Adds the specified listener to receive events from this device.
addEventListener(PinEventListener) - Method in interface org.firmata4j.Pin
Adds the specified listener to receive events from this pin.
ANALOG_MAPPING - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
ANALOG_MAPPING_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
ANALOG_MAPPING_QUERY - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
ANALOG_MAPPING_REQUEST - Static variable in class org.firmata4j.firmata.FirmataMessageFactory
The analog mapping query provides the information about which pins (as used with Firmata's pin mode message) correspond to the analog channels.
ANALOG_MAPPING_RESPONSE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
ANALOG_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
send data for an analog pin (or PWM)
ANALOG_MESSAGE_RESPONSE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
analogReport(boolean) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Builds message to enable or disable reporting from Firmata device on change of analog input.
ask(byte, I2CListener) - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
ask(int, byte, I2CListener) - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
ask(byte, I2CListener) - Method in interface org.firmata4j.I2CDevice
Requests data from I2C device and receives it only once.
ask(int, byte, I2CListener) - Method in interface org.firmata4j.I2CDevice
Requests data from I2C device and receives it only once.

B

bufferize(byte) - Method in class org.firmata4j.fsm.AbstractState
Stores the byte to the internal buffer to have a chance of getting the data by a chunk latter.

C

CAPABILITY_QUERY - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
CAPABILITY_RESPONSE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
clear() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
clear() - Method in class org.firmata4j.ssd1306.SSD1306
 
COM_SCAN_DEC - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
COM_SCAN_INC - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
COMMAND_CONTROL_BYTE - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 

D

DATA_CONTROL_BYTE - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
DEACTIVATE_SCROLL - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
DIGITAL_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
send data for a digital pin
DIGITAL_MESSAGE_RESPONSE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
digitalReport(boolean) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Builds message to enable or disable reporting from Firmata device on change of digital input.
dim(boolean) - Method in class org.firmata4j.ssd1306.SSD1306
Dims the display
DISABLE_SCROLLING - Static variable in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
display() - Method in class org.firmata4j.ssd1306.SSD1306
 
DISPLAY_ON_RESET - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
DISPLAY_ON_RESUME - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
DISPLAY_RESET - Static variable in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
DISPLAY_RESUME - Static variable in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
drawBitmap(int, int, byte[][], boolean) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
Draws a bitmap.
drawChar(int, int, char, MonochromeCanvas.Color, MonochromeCanvas.Color, int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawCircle(int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawCircle(int, int, int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawCircleHelper(int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawHorizontalLine(int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawImage(int, int, BufferedImage, boolean, boolean) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
Draws an image.
drawLine(int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawLine(int, int, int, int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawRect(int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawRect(int, int, int, int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawRoundRect(int, int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawString(int, int, String) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawTriangle(int, int, int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
drawVerticalLine(int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 

E

ENABLE_SCROLLING - Static variable in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
ENCODER_DATA - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
END_SYSEX - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
end a MIDI Sysex message
ensureInitializationIsDone() - Method in class org.firmata4j.firmata.FirmataDevice
 
ensureInitializationIsDone() - Method in interface org.firmata4j.IODevice
Waits for initialization is done.
ERROR_CAUSE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
ERROR_DESCRIPTION - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
ERROR_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
Event - Class in org.firmata4j.fsm
The event of very loose structure.
Event() - Constructor for class org.firmata4j.fsm.Event
Constructs the event of unspecified type and without a name.
Event(String, String) - Constructor for class org.firmata4j.fsm.Event
Constructs the event of specified type with specified name.
Event(String, String, long) - Constructor for class org.firmata4j.fsm.Event
Constructs the event of specified type with specified name.
Event(String, String, Map<String, Object>) - Constructor for class org.firmata4j.fsm.Event
Constructs the event of specified type with specified name.
Example - Class in org.firmata4j
Example of usage JPinboard.
Example() - Constructor for class org.firmata4j.Example
 
EXTENDED_ANALOG - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 

F

fillCircle(int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
fillCircleHelper(int, int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
fillRect(int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
fillRect(int, int, int, int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
fillRoundRect(int, int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
fillScreen(MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
fillTriangle(int, int, int, int, int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
FiniteStateMachine - Class in org.firmata4j.fsm
Finite State Machine base implementation.
FiniteStateMachine() - Constructor for class org.firmata4j.fsm.FiniteStateMachine
Constructs the finite state machine in the terminal state, i.e. without any particular current state.
FiniteStateMachine(State) - Constructor for class org.firmata4j.fsm.FiniteStateMachine
Constructs the finite state machine in the specified state.
FiniteStateMachine(Class<? extends State>) - Constructor for class org.firmata4j.fsm.FiniteStateMachine
Constructs the finite state machine in the state of the specified class.
FIRMATA_BUGFIX_VERSION - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
FIRMATA_MAJOR_VERSION - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
Version numbers for the protocol.
FIRMATA_MESSAGE_EVENT_TYPE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
FIRMATA_MINOR_VERSION - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
FirmataDevice - Class in org.firmata4j.firmata
Implements IODevice that is using Firmata protocol.
FirmataDevice(String) - Constructor for class org.firmata4j.firmata.FirmataDevice
Constructs FirmataDevice instance on specified port.
FirmataI2CDevice - Class in org.firmata4j.firmata
Represents an I2C device and encapsulates communication logic using Firmata protocol.
FirmataMessageFactory - Class in org.firmata4j.firmata
This class contains methods that help to build command messages for Firmata device.
FirmataMessageFactory() - Constructor for class org.firmata4j.firmata.FirmataMessageFactory
 
FirmataPin - Class in org.firmata4j.firmata
This class contains implementation of Firmata pin.
FirmataPin(FirmataDevice, byte) - Constructor for class org.firmata4j.firmata.FirmataPin
Constructs Firmata pin for the specified device.
FirmataToken - Interface in org.firmata4j.firmata.parser
This class contains set of constants that represent tokens of Firmata protocol.
FIRMWARE_MAJOR - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
FIRMWARE_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
FIRMWARE_MINOR - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
FIRMWARE_NAME - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
FSM_EVENT_TYPE - Static variable in class org.firmata4j.fsm.FiniteStateMachine
 
FSM_IS_IN_TERMINAL_STATE - Static variable in class org.firmata4j.fsm.FiniteStateMachine
 

G

getAddress() - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
getAddress() - Method in interface org.firmata4j.I2CDevice
Returns address of I2C device.
getBackgroundColor() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getBody() - Method in class org.firmata4j.fsm.Event
Returns the body of the event.
getBodyItem(String) - Method in class org.firmata4j.fsm.Event
Returns the item of the event's body.
getBuffer() - Method in class org.firmata4j.fsm.AbstractState
Returns the data collected so far.
getBuffer() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getCanvas() - Method in class org.firmata4j.ssd1306.SSD1306
 
getColor() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getCurrentState() - Method in class org.firmata4j.fsm.FiniteStateMachine
Returns current state of the FSM.
getCursorX() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getCursorY() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getData() - Method in class org.firmata4j.I2CEvent
Returns data received from I2CDevice.
getDevice() - Method in class org.firmata4j.firmata.FirmataPin
 
getDevice() - Method in class org.firmata4j.I2CEvent
Returns I2CDevice which sent a piece of data.
getDevice() - Method in class org.firmata4j.IOEvent
Returns the device that relates to the event.
getDevice() - Method in interface org.firmata4j.Pin
Return an IODevice the pin belongs to.
getFiniteStateMashine() - Method in class org.firmata4j.fsm.AbstractState
 
getFiniteStateMashine() - Method in interface org.firmata4j.fsm.State
Returns the FiniteStateMachine instance the state belongs to.
getHeight() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getI2CDevice(byte) - Method in class org.firmata4j.firmata.FirmataDevice
 
getI2CDevice(byte) - Method in interface org.firmata4j.IODevice
Returns I2C device by its address.
getIndex() - Method in class org.firmata4j.firmata.FirmataPin
 
getIndex() - Method in interface org.firmata4j.Pin
Returns the index of the pin on its device.
getMode() - Method in class org.firmata4j.firmata.FirmataPin
 
getMode() - Method in interface org.firmata4j.Pin
Returns current mode of the pin.
getName() - Method in class org.firmata4j.fsm.Event
Returns the name of the event.
getPin(int) - Method in class org.firmata4j.firmata.FirmataDevice
 
getPin(int) - Method in interface org.firmata4j.IODevice
Returns a pin by its index on device.
getPin() - Method in class org.firmata4j.IOEvent
Returns the pin that relates to the event.
getPins() - Method in class org.firmata4j.firmata.FirmataDevice
 
getPins() - Method in interface org.firmata4j.IODevice
Returns a set of pins of the device.
getPinsCount() - Method in class org.firmata4j.firmata.FirmataDevice
 
getPinsCount() - Method in interface org.firmata4j.IODevice
Returns count of pins of the device.
getProtocol() - Method in class org.firmata4j.firmata.FirmataDevice
 
getProtocol() - Method in interface org.firmata4j.IODevice
Returns the name of a protocol that the device uses.
getRegister() - Method in class org.firmata4j.I2CEvent
Returns register address received from I2CDevice.
getRotation() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getSize() - Method in class org.firmata4j.ssd1306.SSD1306
 
getSupportedModes() - Method in class org.firmata4j.firmata.FirmataPin
 
getSupportedModes() - Method in interface org.firmata4j.Pin
Returns a set of modes supported by the pin.
getTextBounds(String, int, int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getTextsize() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
getTimestamp() - Method in class org.firmata4j.fsm.Event
Returns the timestamp of the event.
getTimestamp() - Method in class org.firmata4j.IOEvent
Returns the timestamp of the event.
getType() - Method in class org.firmata4j.fsm.Event
Returns the type of the event.
getValue() - Method in class org.firmata4j.firmata.FirmataPin
 
getValue() - Method in class org.firmata4j.IOEvent
Returns the value the pin received.
getValue() - Method in interface org.firmata4j.Pin
Returns current value of the pin.
getWidth() - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 

H

height - Variable in enum org.firmata4j.ssd1306.SSD1306.Size
 

I

I2C_ADDRESS - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_CONFIG - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_READ - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_READ_CONTINUOUS - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_REGISTER - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_REPLY - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_REQUEST - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_STOP_READ_CONTINUOUS - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
I2C_WRITE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
i2cConfigRequest(int) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Creates SysEx message that configures I2C setup.
I2CDevice - Interface in org.firmata4j
Represents an I2C device and encapsulates logic to communicate to it.
I2CEvent - Class in org.firmata4j
This event occurs when I2C device transmits some data.
I2CEvent(I2CDevice, int, byte[]) - Constructor for class org.firmata4j.I2CEvent
 
I2CExample - Class in org.firmata4j
Example of usage of an i2c device.
I2CExample() - Constructor for class org.firmata4j.I2CExample
 
I2CListener - Interface in org.firmata4j
Describes processing of data received from I2CDevice.
i2cReadRequest(byte, int, int, boolean) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Builds a message that asks a Firmata device to read data from an I2C device.
i2cStopContinuousRequest(byte) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Builds a message that terminates receiving continuous updates from specified I2C device.
i2cWriteRequest(byte, byte...) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Builds a message that asks a Firmata device to send specified data to specified I2C device.
init() - Method in class org.firmata4j.ssd1306.SSD1306
Prepares the device to operation.
INVERSE_DISPLAY - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
invertDisplay(boolean) - Method in class org.firmata4j.ssd1306.SSD1306
 
IODevice - Interface in org.firmata4j
This interface describes a device which is able to receive and transmit signals.
IODeviceEventListener - Interface in org.firmata4j
This interface describes an object that can receive and handle events from an IODevice.
IOEvent - Class in org.firmata4j
An event which indicates that the state of an IODevice changed.
IOEvent(IODevice) - Constructor for class org.firmata4j.IOEvent
Constructs the event is relevant to IODevice as a whole.
IOEvent(IODevice, long) - Constructor for class org.firmata4j.IOEvent
Constructs the event is relevant to IODevice as a whole.
IOEvent(Pin) - Constructor for class org.firmata4j.IOEvent
Constructs the event is relevant to a particular Pin.
IOEvent(Pin, long) - Constructor for class org.firmata4j.IOEvent
Constructs the event is relevant to a particular Pin.
isReady() - Method in class org.firmata4j.firmata.FirmataDevice
 
isReady() - Method in interface org.firmata4j.IODevice
Checks whether the device is fully initialized and ready to use.

J

JPin - Class in org.firmata4j.ui
Displays representation of a Pin.
JPin(Pin) - Constructor for class org.firmata4j.ui.JPin
 
JPinboard - Class in org.firmata4j.ui
Displays pins states of IODevice.
JPinboard(IODevice) - Constructor for class org.firmata4j.ui.JPinboard
 

L

LED_OFF - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
LED_ON - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 

M

main(String[]) - Static method in class org.firmata4j.Example
 
main(String[]) - Static method in class org.firmata4j.I2CExample
 
MAX_SAMPLING_INTERVAL - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
MIN_SAMPLING_INTERVAL - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
MonochromeCanvas - Class in org.firmata4j.ssd1306
This is monochrome 1-bit-per-pixel canvas that allows to draw basic graphical shapes, characters, strings and bitmaps.
MonochromeCanvas(int, int) - Constructor for class org.firmata4j.ssd1306.MonochromeCanvas
 
MonochromeCanvas.Color - Enum in org.firmata4j.ssd1306
 

N

NOP - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
NORMAL_DISPLAY - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 

O

onEvent(Event) - Method in class org.firmata4j.fsm.FiniteStateMachine
Reacts to an event that occurs during processing of input.
ONEWIRE_DATA - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
onMessageReceive(IOEvent, String) - Method in interface org.firmata4j.IODeviceEventListener
Invoked when a string message has been received from the device.
onModeChange(IOEvent) - Method in interface org.firmata4j.PinEventListener
Invoked when pin's mode changes.
onModeChange(IOEvent) - Method in class org.firmata4j.ui.JPin
 
onPinChange(IOEvent) - Method in interface org.firmata4j.IODeviceEventListener
Invoked when the state of one of device's pins has been changed.
onReceive(I2CEvent) - Method in interface org.firmata4j.I2CListener
 
onStart(IOEvent) - Method in interface org.firmata4j.IODeviceEventListener
Invoked when an IODevice has been successfully started and initialized.
onStop(IOEvent) - Method in interface org.firmata4j.IODeviceEventListener
Invoked when communication with IODevice has been successfully terminated.
onValueChange(IOEvent) - Method in interface org.firmata4j.PinEventListener
Invoked when pin's value changes.
onValueChange(IOEvent) - Method in class org.firmata4j.ui.JPin
 
org.firmata4j - package org.firmata4j
 
org.firmata4j.firmata - package org.firmata4j.firmata
 
org.firmata4j.firmata.parser - package org.firmata4j.firmata.parser
 
org.firmata4j.fsm - package org.firmata4j.fsm
 
org.firmata4j.ssd1306 - package org.firmata4j.ssd1306
 
org.firmata4j.ui - package org.firmata4j.ui
 

P

PAGE_ADDR_SET_HIGH_COLUMN - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
PAGE_ADDR_SET_LOW_COLUMN - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
ParsingAnalogMappingState - Class in org.firmata4j.firmata.parser
This state parses analog mapping message and fires an event that contains information about how the analog ports match to the pin indexes.
ParsingAnalogMappingState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingAnalogMappingState
 
ParsingAnalogMessageState - Class in org.firmata4j.firmata.parser
This state parses the analog message that points an analog input has changed.
ParsingAnalogMessageState(FiniteStateMachine, int) - Constructor for class org.firmata4j.firmata.parser.ParsingAnalogMessageState
 
ParsingCapabilityResponseState - Class in org.firmata4j.firmata.parser
This state parses capability response and fires an event that contains information about pins and their supported modes.
ParsingCapabilityResponseState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingCapabilityResponseState
 
ParsingDigitalMessageState - Class in org.firmata4j.firmata.parser
This state parses digital message and fires an event that contains information about the state of each pin of the port where state of at least one pin has changed.
ParsingDigitalMessageState(FiniteStateMachine, int) - Constructor for class org.firmata4j.firmata.parser.ParsingDigitalMessageState
 
ParsingExtendedAnalogMessageState - Class in org.firmata4j.firmata.parser
This state parses extended analog state message and fires an event that contains information about the state of an analog input where the state has changed.
ParsingExtendedAnalogMessageState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingExtendedAnalogMessageState
 
ParsingFirmwareMessageState - Class in org.firmata4j.firmata.parser
This state parses firmware message and fires an event that contains the name and version of firmware.
ParsingFirmwareMessageState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingFirmwareMessageState
 
ParsingI2CMessageState - Class in org.firmata4j.firmata.parser
This class parses inbound I2C messages and publishes them when they are complete.
ParsingI2CMessageState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingI2CMessageState
 
ParsingStringMessageState - Class in org.firmata4j.firmata.parser
 
ParsingStringMessageState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingStringMessageState
 
ParsingSysexMessageState - Class in org.firmata4j.firmata.parser
This state parses type of sysex message and transfers FSM to the state which is able to handle the message.
ParsingSysexMessageState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingSysexMessageState
 
ParsingVersionMessageState - Class in org.firmata4j.firmata.parser
This state parses version report message that contains the version of the protocol the hardware supports.
ParsingVersionMessageState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.ParsingVersionMessageState
 
Pin - Interface in org.firmata4j
A pin is a connector of an IODevice to external signal receiver or transmitter.
Pin.Mode - Enum in org.firmata4j
Mode represents particular duty of a pin.
PIN_CAPABILITIES_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_ID - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_ANALOG - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_ENCODER - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_I2C - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_IGNORE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_INPUT - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_ONEWIRE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_OUTPUT - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_PULLUP - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_PWM - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_SERIAL - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_SERVO - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_SHIFT - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_MODE_STEPPER - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_STATE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_STATE_QUERY - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_STATE_RESPONSE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_SUPPORTED_MODES - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PIN_VALUE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PinEventListener - Interface in org.firmata4j
The listener interface for receiving events from Pin.
PinStateParsingState - Class in org.firmata4j.firmata.parser
This state parses the pin state message.
PinStateParsingState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.PinStateParsingState
 
pinStateRequest(byte) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Builds a message that requests a state of specified pin.
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingAnalogMappingState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingAnalogMessageState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingCapabilityResponseState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingDigitalMessageState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingExtendedAnalogMessageState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingFirmwareMessageState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingI2CMessageState
Collects I2C message from individual bytes.
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingStringMessageState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingSysexMessageState
 
process(byte) - Method in class org.firmata4j.firmata.parser.ParsingVersionMessageState
 
process(byte) - Method in class org.firmata4j.firmata.parser.PinStateParsingState
 
process(byte) - Method in class org.firmata4j.firmata.parser.WaitingForMessageState
 
process(byte) - Method in class org.firmata4j.fsm.FiniteStateMachine
Hands the byte to be processed with the current state.
process(byte[]) - Method in class org.firmata4j.fsm.FiniteStateMachine
Hands bytes from the buffer to be processed by the current state sequentially.
process(byte[], int, int) - Method in class org.firmata4j.fsm.FiniteStateMachine
Hands bytes from the buffer to be processed by the current state sequentially.
process(byte) - Method in interface org.firmata4j.fsm.State
Performs processing of the input byte.
PROTOCOL_MAJOR - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PROTOCOL_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
PROTOCOL_MINOR - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
publish(Event) - Method in class org.firmata4j.fsm.AbstractState
Publishes the event to the FSM.

R

RAM_PAGE_START_ADDRESS - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
REGISTER_NOT_SET - Static variable in class org.firmata4j.firmata.FirmataI2CDevice
 
removeAllEventListeners() - Method in class org.firmata4j.firmata.FirmataPin
 
removeAllEventListeners() - Method in interface org.firmata4j.Pin
Remove all listeners from this pin.
removeEventListener(IODeviceEventListener) - Method in class org.firmata4j.firmata.FirmataDevice
 
removeEventListener(PinEventListener) - Method in class org.firmata4j.firmata.FirmataPin
 
removeEventListener(IODeviceEventListener) - Method in interface org.firmata4j.IODevice
Removes the specified listener so that it no longer receives events from this device.
removeEventListener(PinEventListener) - Method in interface org.firmata4j.Pin
Removes the specified listener so that it no longer receives events from this pin.
REPORT_ANALOG - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
enable analog input by pin #
REPORT_DIGITAL - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
enable digital input by port pair
REPORT_FIRMWARE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
REPORT_VERSION - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
report protocol version
REQUEST_CAPABILITY - Static variable in class org.firmata4j.firmata.FirmataMessageFactory
This message requests capability repot of a Firmata device.
REQUEST_FIRMWARE - Static variable in class org.firmata4j.firmata.FirmataMessageFactory
This message requests firmware version of a Firmata device.
RESERVED_COMMAND - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
resolve(byte) - Static method in enum org.firmata4j.Pin.Mode
Resolves a mode-token from firmata message to enum value.

S

SAMPLING_INTERVAL - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
SCHEDULER_DATA - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
scrollLeft() - Method in class org.firmata4j.ssd1306.SSD1306
 
scrollRight() - Method in class org.firmata4j.ssd1306.SSD1306
 
SEG_REMAP - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
sendMessage(String) - Method in class org.firmata4j.firmata.FirmataDevice
 
sendMessage(String) - Method in interface org.firmata4j.IODevice
Sends arbitrary message to device.
SERIAL_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
serialEvent(SerialPortEvent) - Method in class org.firmata4j.firmata.FirmataDevice
 
SERVO_CONFIG - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
servoConfig(byte, int, int) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Builds servo configuration message.
SET_CHARGE_PUMP - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_COLUMN_ADDR - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_COM_PINS - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_CONTRAST - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_DIGITAL_PIN_VALUE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
set value of an individual digital pin
SET_DISPLAY_CLOCK - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_DISPLAY_OFFSET - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_HORIZONTAL_SCROLL - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_MEMORY_ADDR_MODE - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_MULTIPLEX - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_PAGE_ADDR - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_PIN_MODE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
set a pin to INPUT/OUTPUT/PWM/etc
SET_PRECHARGE_PERIOD - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_START_LINE - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_VCOMH_DESELECT - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
SET_VERTICAL_SCROLL_AREA - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
setAnalogPinValue(byte, long) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Creates Firmata message to set value of an output pin in PWM mode.
setBackgroundColor(MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
setBodyItem(String, Object) - Method in class org.firmata4j.fsm.Event
Sets the item of the event's body.
setChargePump(boolean) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setColor(MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
setColumnAddress(byte, byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
Setup column start and end address.
setCOMPinsConfig(boolean, boolean) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setContrast(byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setCursor(int, int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
setDelay(int) - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
setDelay(int) - Method in interface org.firmata4j.I2CDevice
Sets delay between writing and reading data to/from I2C device.
setDigitalPinValue(byte, byte) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Creates Firmata message to set digital values of port's pins.
setDisplayClock(byte, byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setDisplayInverse(boolean) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setDisplayOffset(int) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setDisplayStartLine(int) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setHigherColumnStartAddress(byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
Set the higher nibble of the column start address register for Page Addressing Mode.
setHorizontalFlip(boolean) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setHorizontalScroll(SSD1306MessageFactory.ScrollDirection, byte, byte, byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setLowerColumnStartAddress(byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
Set the lower nibble of the column start address register for Page Addressing Mode.
setMemoryAddressingMode(SSD1306MessageFactory.MemoryAddressingMode) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setMode(byte, Pin.Mode) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Creates the message that assigns particular mode to specified pin.
setMode(Pin.Mode) - Method in class org.firmata4j.firmata.FirmataPin
 
setMode(Pin.Mode) - Method in interface org.firmata4j.Pin
Assigns new mode to the pin.
setModel(Pin) - Method in class org.firmata4j.ui.JPin
 
setMultiplexRatio(int) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setPageAddress(byte, byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
Setup page start and end address.
setPinId(byte) - Method in class org.firmata4j.firmata.parser.ParsingCapabilityResponseState
 
setPixel(int, int, MonochromeCanvas.Color) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
setPrechargePeriod(byte, byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setRAMPageStartAddress(byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
Set GDDRAM Page Start Address (PAGE0~PAGE7) for Page Addressing Mode.
setRotation(int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
setSamplingInterval(int) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Creates a message to set sampling interval.
setTextsize(int) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
setValue(long) - Method in class org.firmata4j.firmata.FirmataPin
 
setValue(long) - Method in interface org.firmata4j.Pin
Sets the value to the pin.
setVcomhDeselectLevel(byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setVerticalAndHorizontalScroll(SSD1306MessageFactory.ScrollDirection, byte, byte, byte, byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setVerticalFlip(boolean) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
setVerticalScrollArea(byte, byte) - Static method in class org.firmata4j.ssd1306.SSD1306MessageFactory
Sets vertical scroll area.
setWordWrap(boolean) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
SHIFT_DATA - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
SSD1306 - Class in org.firmata4j.ssd1306
This class provides facilities to control a monochrome OLED display on SSD1306 driver.
SSD1306(I2CDevice, SSD1306.Size) - Constructor for class org.firmata4j.ssd1306.SSD1306
 
SSD1306(I2CDevice, SSD1306.Size, SSD1306.VCC) - Constructor for class org.firmata4j.ssd1306.SSD1306
 
SSD1306.Size - Enum in org.firmata4j.ssd1306
 
SSD1306.VCC - Enum in org.firmata4j.ssd1306
 
SSD1306MessageFactory - Class in org.firmata4j.ssd1306
This class contains methods that help to build command messages for SSD1306 device.
SSD1306MessageFactory() - Constructor for class org.firmata4j.ssd1306.SSD1306MessageFactory
 
SSD1306MessageFactory.MemoryAddressingMode - Enum in org.firmata4j.ssd1306
 
SSD1306MessageFactory.ScrollDirection - Enum in org.firmata4j.ssd1306
 
SSD1306Token - Interface in org.firmata4j.ssd1306
This class contains set of constants that represent tokens of SSD1306 device protocol (commands and control bytes).
start() - Method in class org.firmata4j.firmata.FirmataDevice
 
start() - Method in interface org.firmata4j.IODevice
Initiates communication with hardware.
START_SYSEX - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
start a MIDI Sysex message
startReceivingUpdates(byte) - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
startReceivingUpdates(byte) - Method in interface org.firmata4j.I2CDevice
Tells I2C device to send data continuously as it available.
State - Interface in org.firmata4j.fsm
The interface of the state of the FiniteStateMachine.
STEPPER_DATA - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
stop() - Method in class org.firmata4j.firmata.FirmataDevice
 
stop() - Method in interface org.firmata4j.IODevice
Terminates communication with hardware.
stopReceivingUpdates() - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
stopReceivingUpdates() - Method in interface org.firmata4j.I2CDevice
Tells I2C device to stop sending data continuously.
stopScrolling() - Method in class org.firmata4j.ssd1306.SSD1306
 
STRING_DATA - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
STRING_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
stringMessage(String) - Static method in class org.firmata4j.firmata.FirmataMessageFactory
Encodes the string as a SysEx message.
subscribe(I2CListener) - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
subscribe(I2CListener) - Method in interface org.firmata4j.I2CDevice
Registers a listener as a receiver of regular updates from I2C device.
supports(Pin.Mode) - Method in class org.firmata4j.firmata.FirmataPin
 
supports(Pin.Mode) - Method in interface org.firmata4j.Pin
Checks if the pin supports the mode
SYSEX_NON_REALTIME - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
SYSEX_REALTIME - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
SYSTEM_RESET - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
reset from MIDI
SYSTEM_RESET_MESSAGE - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 

T

tell(byte...) - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
tell(byte...) - Method in interface org.firmata4j.I2CDevice
Sends data to the I2C device.
toString() - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
toString() - Method in class org.firmata4j.I2CEvent
 
TOTAL_PIN_MODES - Static variable in interface org.firmata4j.firmata.parser.FirmataToken
 
transitTo(Class<? extends State>) - Method in class org.firmata4j.fsm.AbstractState
Transfers the FSM to the state of specified class.
transitTo(State) - Method in class org.firmata4j.fsm.AbstractState
Transfers the FSM to the specified state.
transitTo(State) - Method in class org.firmata4j.fsm.FiniteStateMachine
Transfers the FSM to the new state.
transitTo(Class<? extends State>) - Method in class org.firmata4j.fsm.FiniteStateMachine
Transfers the FSM to the new state of the specified class.
TURN_OFF - Static variable in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
TURN_ON - Static variable in class org.firmata4j.ssd1306.SSD1306MessageFactory
 
turnOff() - Method in class org.firmata4j.ssd1306.SSD1306
 
turnOn() - Method in class org.firmata4j.ssd1306.SSD1306
 

U

unsubscribe(I2CListener) - Method in class org.firmata4j.firmata.FirmataI2CDevice
 
unsubscribe(I2CListener) - Method in interface org.firmata4j.I2CDevice
Unregisters a listener from receiving of regular updates from I2C device.

V

valueOf(String) - Static method in enum org.firmata4j.Pin.Mode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.firmata4j.ssd1306.MonochromeCanvas.Color
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.firmata4j.ssd1306.SSD1306.Size
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.firmata4j.ssd1306.SSD1306.VCC
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.firmata4j.ssd1306.SSD1306MessageFactory.MemoryAddressingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.firmata4j.ssd1306.SSD1306MessageFactory.ScrollDirection
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.firmata4j.Pin.Mode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.firmata4j.ssd1306.MonochromeCanvas.Color
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.firmata4j.ssd1306.SSD1306.Size
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.firmata4j.ssd1306.SSD1306.VCC
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.firmata4j.ssd1306.SSD1306MessageFactory.MemoryAddressingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.firmata4j.ssd1306.SSD1306MessageFactory.ScrollDirection
Returns an array containing the constants of this enum type, in the order they are declared.
VERTICAL_AND_LEFT_HORIZONTAL_SCROLL - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 
VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL - Static variable in interface org.firmata4j.ssd1306.SSD1306Token
 

W

WaitingForMessageState - Class in org.firmata4j.firmata.parser
This is initial default state of FirmataDevice.
WaitingForMessageState(FiniteStateMachine) - Constructor for class org.firmata4j.firmata.parser.WaitingForMessageState
 
width - Variable in enum org.firmata4j.ssd1306.SSD1306.Size
 
write(char) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
write(String) - Method in class org.firmata4j.ssd1306.MonochromeCanvas
 
A B C D E F G H I J L M N O P R S T U V W 
Skip navigation links

Copyright © 2017. All rights reserved.