public final class

SerialPortParameters

extends Object
java.lang.Object
   ↳ com.digi.android.serial.SerialPortParameters

Class Overview

Helper class used to store serial connection parameters information.

Parameters are stored as public variables so that they can be accessed and read from any class.

Summary

Fields
public final int baudRate
public final int dataBits
public final int flowControl
public final int parity
public final int readTimeout
public final int stopBits
Public Constructors
SerialPortParameters(int baudRate, int dataBits, int stopBits, int parity, int flowControl, int readTimeout)
Class constructor.
Public Methods
boolean equals(Object obj)
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public final int baudRate

public final int dataBits

public final int flowControl

public final int parity

public final int readTimeout

public final int stopBits

Public Constructors

public SerialPortParameters (int baudRate, int dataBits, int stopBits, int parity, int flowControl, int readTimeout)

Class constructor. Instantiates a new SerialPortParameters object with the given parameters.

Parameters
baudRate int: Baud rate.
dataBits int: Data bits, one of SerialPort.DATABITS_5, SerialPort.DATABITS_6, SerialPort.DATABITS_7, and SerialPort.DATABITS_8.
stopBits int: Stop bits, one of SerialPort.STOPBITS_1, SerialPort.STOPBITS_2, and SerialPort.STOPBITS_1_5.
parity int: Parity, one of SerialPort.PARITY_NONE, SerialPort.PARITY_ODD, SerialPort.PARITY_EVEN, SerialPort.PARITY_MARK, and SerialPort.PARITY_SPACE.
flowControl int: Flow control, one of SerialPort.FLOWCONTROL_NONE, SerialPort.FLOWCONTROL_RTSCTS_IN, SerialPort.FLOWCONTROL_RTSCTS_OUT, SerialPort.FLOWCONTROL_XONXOFF_IN, and SerialPort.FLOWCONTROL_XONXOFF_OUT.
readTimeout int: Serial connection read timeout.
Throws
IllegalArgumentException If baudRate < 0 or if dataBits < 0 or if stopBits < 0 or if parity < 0 or if flowControl < 0 or if readTimeout < 0.

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public String toString ()

Returns
String