se.westpay.libserial

Class SerialCommunication

java.lang.Object

se.westpay.libserial.SerialCommunication

All Implemented Interfaces:

Com

public class SerialCommunication
extends java.lang.Object
implements Com

Wrapper layer for the native serial port communication functions.
For information on how to use SerialCommunication see Com.

Nested Class Summary

Nested classes/interfaces inherited from interface se.westpay.libserial.Com

Com.BaudRates, Com.DataBits, Com.EventTypes, Com.Parity, Com.StopBits

Constructor Summary

Constructors

Constructor and Description
SerialCommunication()

Method Summary

Modifier and Type	Method and Description
boolean	connect(Com.BaudRates baudRate) Open and connect to the serial port.
boolean	connect(Com.BaudRates baudRate, Com.StopBits stopBits, Com.DataBits dataBits, Com.Parity parity) Open and connect to the serial port.
void	disconnect() Disconnect the connected port.
boolean	isOpened() Check if serial communication port is open.
int	read(byte[] data, int length) Read data from the serial communication port.
int	read(byte[] data, int length, int timeout) Read data from the serial communication port.
void	setDataAvailableCallback(DataAvailable dataAvailable) Set data available callback for the application layer.
int	write(byte[] data, int length) Write data to the serial communication port.
int	write(byte[] data, int length, int timeout) Write data to the serial communication port.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialCommunication

public SerialCommunication()

Method Detail

connect

public boolean connect(Com.BaudRates baudRate)

Open and connect to the serial port.

Specified by:

connect in interface Com

Parameters:

baudRate - Baud rate to use.

Returns:

boolean true success, false otherwise.

connect

public boolean connect(Com.BaudRates baudRate,
                       Com.StopBits stopBits,
                       Com.DataBits dataBits,
                       Com.Parity parity)

Open and connect to the serial port.

Specified by:

connect in interface Com

Parameters:

baudRate - Baud rate to use.

stopBits - Number of stop bits.

dataBits - Number of data bits per byte.

parity - Enable parity generation and detection.

Returns:

boolean - true success, false otherwise.

disconnect

public void disconnect()

Disconnect the connected port.

Specified by:

disconnect in interface Com

read

public int read(byte[] data,
                int length)

Read data from the serial communication port. Timeout default 3 seconds.

Specified by:

read in interface Com

Parameters:

data - Read buffer.

length - Length to read.

Returns:

int - Number of bytes read.

read

public int read(byte[] data,
                int length,
                int timeout)

Read data from the serial communication port.

Specified by:

read in interface Com

Parameters:

data - Read buffer.

length - Length to read.

timeout - Timeout for the read operation.

Returns:

int - Number of bytes read.

write

public int write(byte[] data,
                 int length)

Write data to the serial communication port. Timeout default 3 seconds.

Specified by:

write in interface Com

Parameters:

data - Write buffer.

length - Length to read.

Returns:

int - Number of bytes written.

write

public int write(byte[] data,
                 int length,
                 int timeout)

Write data to the serial communication port.

Specified by:

write in interface Com

Parameters:

data - Write buffer.

length - Length to read.

timeout - Timeout for the write operation. Default 3 seconds.

Returns:

int - Number of bytes written.

isOpened

public boolean isOpened()

Check if serial communication port is open.

Specified by:

isOpened in interface Com

Returns:

boolean - true if the serial port is open, false otherwise.

setDataAvailableCallback

public void setDataAvailableCallback(DataAvailable dataAvailable)

Set data available callback for the application layer.

Specified by:

setDataAvailableCallback in interface Com

Parameters:

dataAvailable - Callback object that is called when data is available.