device.common

Class SerialPort

java.lang.Object

device.common.SerialPort

public class SerialPort
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SerialPort(java.io.File device, int baudrate, int flags) Create a serial port object.
SerialPort(java.io.File device, int baudrate, int flags, boolean hwflow) Create a serial port object.
SerialPort(java.lang.String path, int baudrate, int flags) Create a serial port object.
SerialPort(java.lang.String path, int baudrate, int flags, boolean hwflow) Create a serial port object.

Method Summary

Modifier and Type	Method and Description
void	closePort() Close a serial port
java.io.FileDescriptor	getFileDescriptor() Deprecated. Don't supported since Android 6.0.1.
int	read(byte[] buffer) Reads data from this serial port in the byte array buffer.
void	sendBreak() Sends a stream of zero valued bits for 0.25 to 0.5 seconds
void	write(byte[] buffer) Equivalent to write(buffer, 0, buffer.length).
void	write(byte[] buffer, int offset, int length) Writes length bytes from the byte array buffer starting at position offset to this serial port.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialPort

public SerialPort(java.io.File device,
                  int baudrate,
                  int flags)
           throws java.io.IOException

Create a serial port object.

Parameters:

device - the file object of device.

baudrate - the baudrate of serial port.

flags - the flags of serial port.

Throws:

java.io.IOException

SerialPort

public SerialPort(java.lang.String path,
                  int baudrate,
                  int flags)
           throws java.io.IOException

Create a serial port object.

Parameters:

path - the absolute path of device.

baudrate - the baudrate of serial port.

flags - the flags of serial port.

Throws:

java.io.IOException

SerialPort

public SerialPort(java.io.File device,
                  int baudrate,
                  int flags,
                  boolean hwflow)
           throws java.io.IOException

Create a serial port object.

Parameters:

device - the file object of device.

baudrate - the baudrate of serial port.

flags - the flags of serial port.

hwflow - the hardware flow of serial port.

Throws:

java.io.IOException

SerialPort

public SerialPort(java.lang.String path,
                  int baudrate,
                  int flags,
                  boolean hwflow)
           throws java.io.IOException

Create a serial port object.

Parameters:

path - the absolute path of device.

baudrate - the baudrate of serial port.

flags - the flags of serial port.

hwflow - the hardware flow of serial port.

Throws:

java.io.IOException

Method Detail

closePort

public void closePort()

Close a serial port

getFileDescriptor

public java.io.FileDescriptor getFileDescriptor()

Deprecated. Don't supported since Android 6.0.1.

Return a file descriptor of serial port.

Returns:

a FileDescriptor object.

read

public int read(byte[] buffer)
         throws java.io.IOException

Reads data from this serial port in the byte array buffer.

Parameters:

buffer - to read into

Returns:

number of bytes read

Throws:

java.io.IOException

write

public void write(byte[] buffer)
           throws java.io.IOException

Equivalent to write(buffer, 0, buffer.length).

Throws:

java.io.IOException

write

public void write(byte[] buffer,
                  int offset,
                  int length)
           throws java.io.IOException

Writes length bytes from the byte array buffer starting at position offset to this serial port.

Parameters:

buffer - the buffer to be written.

offset - the start position in buffer from where to get bytes.

length - the number of bytes from buffer to write to this serial port.

Throws:

java.io.IOException

sendBreak

public void sendBreak()

Sends a stream of zero valued bits for 0.25 to 0.5 seconds