Package com.embeddedunveiled.serial

Encapsulates behavior and environment centered around serial port communication.

See: Description

Interface Summary

Interface	Description
ISerialComDataListener	The interface ISerialComDataListener should be implemented by class who wish to receive data from serial port.
ISerialComEventListener	The interface ISerialComEventListener should be implemented by class who wish to receive modem/line events on serial port.
ISerialComUSBHotPlugListener	The interface ISerialComUSBHotPlugListener need to be implemented by class who wish to get notified whenever a specified USB device is added to the system or removed from the system.
ISerialComXmodemProgress	The interface ISerialComXmodemProgress should be implemented by class who wish to know how many blocks have been sent or received using xmodem protocol.

Class Summary

Class	Description
SerialComCRCUtil	Utility class to calculate and generate CRC values for a given message.
SerialComInByteStream	Represents an input stream of bytes which is received from serial port.
SerialComIOCTLExecutor	It provide access to UART registers in the chip for example for reading the value at a particular port latch.
SerialComLineEvent	Encapsulate events that happens on serial port control lines.
SerialComManager	Root of this library.
SerialComOutByteStream	Represents an output stream of bytes that gets sent over to serial port for transmission.
SerialComUtil	Provides common utility functions for serial port communication related projects.
SerialComXModem	Implements state machine for XMODEM-128 file transfer protocol in Java.
SerialComXModem1K	Implements state machine for XMODEM-1k file transfer protocol in Java.
SerialComXModemAbort	Acts as a messenger between application and SCM library to specify whether sending/receiving file should continue or be aborted.
SerialComXModemCRC	Implements state machine for XMODEM-CRC file transfer protocol in Java.

Enum Summary

Enum	Description
SerialComManager.BAUDRATE	Pre-defined enum constants for baud rate values.
SerialComManager.DATABITS	Pre-defined enum constants for number of data bits in a serial frame.
SerialComManager.ENDIAN	Pre-defined enum constants for defining endianness of data to be sent over serial port.
SerialComManager.FLOWCONTROL	Pre-defined enum constants for controlling data flow between DTE and DCE.
SerialComManager.FTPPROTO	Pre-defined enum constants for defining file transfer protocol to use.
SerialComManager.FTPVAR	Pre-defined enum constants for defining variant of file transfer protocol to use.
SerialComManager.NUMOFBYTES	Pre-defined enum constants for defining number of bytes given data can be represented in.
SerialComManager.PARITY	Pre-defined enum constants for enabling type of parity in a serial frame.
SerialComManager.SMODE	Pre-defined enum constants for defining behavior of byte stream.
SerialComManager.STOPBITS	Pre-defined enum constants for number of stop bits in a serial frame.

Exception Summary

Exception	Description
SerialComException	Limit the scope of exceptions in context of serial port communication only.
SerialComLoadException	This exception is thrown if native shared library extraction sub-system encounter any error.
SerialComTimeOutException	Exception thrown when a blocking operation times out.
SerialComUnexpectedException	Exception thrown in situation which was not supposed to happen.

Package com.embeddedunveiled.serial Description

Encapsulates behavior and environment centered around serial port communication. This is the core of this library.

Author:

Rishi Gupta