Package com.digi.android.serial

Class SerialPortManager

java.lang.Object

com.digi.android.serial.SerialPortManager

public class SerialPortManager
extends java.lang.Object

This class provides access to the serial ports.

Unless noted, all serial API methods require the com.digi.android.permission.SERIAL permission. If your application does not have this permission it will not have access to any serial port service feature.

See Also:

SerialPort

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_INVALID_BAUDRATE
static java.lang.String	ERROR_INVALID_DATABITS
static java.lang.String	ERROR_INVALID_FLOWCONTROL
static java.lang.String	ERROR_INVALID_PARITY
static java.lang.String	ERROR_INVALID_STOPBITS
static java.lang.String	ERROR_INVALID_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
SerialPortManager(android.content.Context context)	Class constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	listSerialPorts()	Lists all the available serial ports.
SerialPort	openSerialPort(java.lang.String port)	Opens and returns a SerialPort object with the given port name and the following default parameters: Baud rate: 9600 Data bits: 8 Stop bits: 1 Parity: none Flow control: none Read timeout: 3000 ms
SerialPort	openSerialPort(java.lang.String port, int baudRate, int dataBits, int stopBits, int parity, int flowControl, int readTimeout)	Opens and returns a SerialPort object with the given port name and serial port parameters.
SerialPort	openSerialPort(java.lang.String port, SerialPortParameters serialPortParameters)	Opens and returns a SerialPort object with the given port name and serial port parameters.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_INVALID_TIMEOUT

public static final java.lang.String ERROR_INVALID_TIMEOUT

See Also:

Constant Field Values

ERROR_INVALID_BAUDRATE

public static final java.lang.String ERROR_INVALID_BAUDRATE

See Also:

Constant Field Values

ERROR_INVALID_DATABITS

public static final java.lang.String ERROR_INVALID_DATABITS

See Also:

Constant Field Values

ERROR_INVALID_STOPBITS

public static final java.lang.String ERROR_INVALID_STOPBITS

See Also:

Constant Field Values

ERROR_INVALID_PARITY

public static final java.lang.String ERROR_INVALID_PARITY

See Also:

Constant Field Values

ERROR_INVALID_FLOWCONTROL

public static final java.lang.String ERROR_INVALID_FLOWCONTROL

See Also:

Constant Field Values

Constructor Detail

SerialPortManager

public SerialPortManager(android.content.Context context)

Class constructor. Instantiates a new SerialPortManager using the given application context.

The SerialPortManager allows you to create and open serial ports using one of the following methods: openSerialPort(String), openSerialPort(String, int, int, int, int, int, int), or openSerialPort(String, SerialPortParameters).

Parameters:

context - Android application context.

Throws:

java.lang.NullPointerException - If context == null.

See Also:

listSerialPorts(), openSerialPort(String), openSerialPort(String, SerialPortParameters), openSerialPort(String, int, int, int, int, int, int)

Method Detail

openSerialPort

public SerialPort openSerialPort(java.lang.String port)
                          throws NoSuchPortException,
                                 PortInUseException,
                                 UnsupportedCommOperationException

Opens and returns a SerialPort object with the given port name and the following default parameters:

• Baud rate: 9600
• Data bits: 8
• Stop bits: 1
• Parity: none
• Flow control: none
• Read timeout: 3000 ms

Parameters:

port - Port name.

Returns:

The serial port object.

Throws:

NoSuchPortException - If the given port does not exist.

java.lang.NullPointerException - If port == null.

PortInUseException - If the given port is in use.

UnsupportedCommOperationException - If an error occurs when setting the default serial port parameters.

See Also:

listSerialPorts(), openSerialPort(String, SerialPortParameters), openSerialPort(String, int, int, int, int, int, int), SerialPort

openSerialPort

public SerialPort openSerialPort(java.lang.String port,
                                 int baudRate,
                                 int dataBits,
                                 int stopBits,
                                 int parity,
                                 int flowControl,
                                 int readTimeout)
                          throws NoSuchPortException,
                                 PortInUseException,
                                 UnsupportedCommOperationException

Opens and returns a SerialPort object with the given port name and serial port parameters.

Parameters:

port - Port name.

baudRate - Baud rate.

dataBits - Data bits, one of SerialPort.DATABITS_5, SerialPort.DATABITS_6, SerialPort.DATABITS_7, and SerialPort.DATABITS_8.

stopBits - Stop bits, one of SerialPort.STOPBITS_1, SerialPort.STOPBITS_2, and SerialPort.STOPBITS_1_5.

parity - Parity, one of SerialPort.PARITY_NONE, SerialPort.PARITY_ODD, SerialPort.PARITY_EVEN, SerialPort.PARITY_MARK, and SerialPort.PARITY_SPACE.

flowControl - 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 - Read timeout.

Returns:

The serial port object.

Throws:

java.lang.IllegalArgumentException - If baudRate < 0 or if dataBits < 0 or if stopBits < 0 or if parity < 0 or if flowControl < 0 or if readTimeout < 0.

NoSuchPortException - If the given port does not exist.

java.lang.NullPointerException - If port == null.

PortInUseException - If the given port is in use.

UnsupportedCommOperationException - If the serial port parameters are invalid.

See Also:

listSerialPorts(), openSerialPort(String), openSerialPort(String, SerialPortParameters), SerialPort, SerialPort.DATABITS_5, SerialPort.DATABITS_6, SerialPort.DATABITS_7, SerialPort.DATABITS_8, SerialPort.FLOWCONTROL_NONE, SerialPort.FLOWCONTROL_RTSCTS_IN, SerialPort.FLOWCONTROL_RTSCTS_OUT, SerialPort.FLOWCONTROL_XONXOFF_IN, SerialPort.FLOWCONTROL_XONXOFF_OUT, SerialPort.PARITY_EVEN, SerialPort.PARITY_MARK, SerialPort.PARITY_NONE, SerialPort.PARITY_ODD, SerialPort.PARITY_SPACE, SerialPort.STOPBITS_1, SerialPort.STOPBITS_1_5, SerialPort.STOPBITS_2

openSerialPort

public SerialPort openSerialPort(java.lang.String port,
                                 SerialPortParameters serialPortParameters)
                          throws NoSuchPortException,
                                 PortInUseException,
                                 UnsupportedCommOperationException

Opens and returns a SerialPort object with the given port name and serial port parameters.

Parameters:

port - Port name.

serialPortParameters - Serial port parameters.

Returns:

The serial port object.

Throws:

NoSuchPortException - If the given port does not exist.

java.lang.NullPointerException - If port == null or if serialPortParameters == null.

PortInUseException - If the given port is in use.

UnsupportedCommOperationException - If the serial port parameters are invalid.

See Also:

listSerialPorts(), openSerialPort(String), openSerialPort(String, int, int, int, int, int, int), SerialPort, SerialPortParameters

listSerialPorts

public java.lang.String[] listSerialPorts()

Lists all the available serial ports.

Returns:

List with the available serial ports.