Package jssc

Class SerialNativeInterface

java.lang.Object

jssc.SerialNativeInterface

public class SerialNativeInterface
extends Object

Author:

scream3r

Field Summary

Fields

Modifier and Type	Field	Description
static long	ERR_INCORRECT_SERIAL_PORT	Serial port handle is incorrect
static long	ERR_PERMISSION_DENIED	Insufficient permissions to access port
static long	ERR_PORT_BUSY	Port is busy
static long	ERR_PORT_NOT_FOUND	Port is not found
static int	OS_LINUX	Linux
static int	OS_MAC_OS_X	MacOS
static int	OS_SOLARIS	Solaris
static int	OS_UNKNOWN	Unknown
static int	OS_WINDOWS	Windows
static String	PROPERTY_JSSC_IGNPAR	Ignore bytes with framing error or parity error Usage: System.setProperty("jssc_ignpar", "true");
static String	PROPERTY_JSSC_NO_TIOCEXCL	Disable exclusive lock for serial port Usage: System.setProperty("jssc_no_tiocexcl", "true");
static String	PROPERTY_JSSC_PARMRK	Mark bytes with parity error or framing error Usage: System.setProperty("jssc_iparmrk", "true");

Constructor Summary

Constructors

Constructor	Description
SerialNativeInterface()	Default constructor TODO: This class is effectively static, why instantiate it?

Method Summary

Modifier and Type	Method	Description
boolean	closePort(long handle)	Close port
int[]	getBuffersBytesCount(long handle)	Get bytes count in buffers of port
int	getEventsMask(long handle)	Get events mask
int	getFlowControlMode(long handle)	Get flow control mode
static String	getLibraryVersion()	Get library version
int[]	getLinesStatus(long handle)	Getting lines states
static String	getNativeLibraryVersion()	Get native library version
static int	getOsType()	Get OS type
String[]	getSerialPortNames()	Get serial port names like an array of String
long	openPort(String portName, boolean useTIOCEXCL)	Open port
boolean	purgePort(long handle, int flags)	Purge of input and output buffer
byte[]	readBytes(long handle, int byteCount)	Read data from port
boolean	sendBreak(long handle, int duration)	Send Break signal for set duration
boolean	setDTR(long handle, boolean value)	Change DTR line state
boolean	setEventsMask(long handle, int mask)	Set events mask
boolean	setFlowControlMode(long handle, int mask)	Set flow control mode
boolean	setParams(long handle, int baudRate, int dataBits, int stopBits, int parity, boolean setRTS, boolean setDTR, int flags)	Setting the parameters of opened port
boolean	setRTS(long handle, boolean value)	Change RTS line state
int[][]	waitEvents(long handle)	Wait events
boolean	writeBytes(long handle, byte[] buffer)	Write data to port

Methods inherited from class java.lang.Object

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

Field Detail

OS_LINUX

public static final int OS_LINUX

Linux

See Also:

Constant Field Values

OS_WINDOWS

public static final int OS_WINDOWS

Windows

See Also:

Constant Field Values

OS_SOLARIS

public static final int OS_SOLARIS

Solaris

See Also:

Constant Field Values

OS_MAC_OS_X

public static final int OS_MAC_OS_X

MacOS

See Also:

Constant Field Values

OS_UNKNOWN

public static final int OS_UNKNOWN

Unknown

See Also:

Constant Field Values

ERR_PORT_BUSY

public static final long ERR_PORT_BUSY

Port is busy

Since:

2.3.0

See Also:

Constant Field Values

ERR_PORT_NOT_FOUND

public static final long ERR_PORT_NOT_FOUND

Port is not found

Since:

2.3.0

See Also:

Constant Field Values

ERR_PERMISSION_DENIED

public static final long ERR_PERMISSION_DENIED

Insufficient permissions to access port

Since:

2.3.0

See Also:

Constant Field Values

ERR_INCORRECT_SERIAL_PORT

public static final long ERR_INCORRECT_SERIAL_PORT

Serial port handle is incorrect

Since:

2.3.0

See Also:

Constant Field Values

PROPERTY_JSSC_NO_TIOCEXCL

public static final String PROPERTY_JSSC_NO_TIOCEXCL

Disable exclusive lock for serial port Usage: System.setProperty("jssc_no_tiocexcl", "true");

Since:

2.6.0

See Also:

Constant Field Values

PROPERTY_JSSC_IGNPAR

public static final String PROPERTY_JSSC_IGNPAR

Ignore bytes with framing error or parity error Usage: System.setProperty("jssc_ignpar", "true");

Since:

2.6.0

See Also:

Constant Field Values

PROPERTY_JSSC_PARMRK

public static final String PROPERTY_JSSC_PARMRK

Mark bytes with parity error or framing error Usage: System.setProperty("jssc_iparmrk", "true");

Since:

2.6.0

See Also:

Constant Field Values

Constructor Detail

SerialNativeInterface

public SerialNativeInterface()

Default constructor TODO: This class is effectively static, why instantiate it?

Method Detail

getOsType

public static int getOsType()

Get OS type

Returns:

OS_LINUX, OS_WINDOWS, OS_SOLARIS,OS_MACOS or OS_UNKNOWN if unknown.

Since:

0.8

getLibraryVersion

public static String getLibraryVersion()

Get library version

Returns:

Full library version in "major.minor.patch" format.

Since:

0.8

getNativeLibraryVersion

public static String getNativeLibraryVersion()

Get native library version

Returns:

Full native library version in "major.minor.patch" format.

Since:

2.8.0

openPort

public long openPort(String portName,
                     boolean useTIOCEXCL)

Open port

Parameters:

portName - name of port for opening

useTIOCEXCL - enable/disable using of TIOCEXCL. Take effect only on *nix based systems

Returns:

handle of opened port or -1 if opening of the port was unsuccessful

setParams

public boolean setParams(long handle,
                         int baudRate,
                         int dataBits,
                         int stopBits,
                         int parity,
                         boolean setRTS,
                         boolean setDTR,
                         int flags)

Setting the parameters of opened port

Parameters:

handle - handle of opened port

baudRate - data transfer rate

dataBits - number of data bits

stopBits - number of stop bits

parity - parity

setRTS - initial state of RTS line (ON/OFF)

setDTR - initial state of DTR line (ON/OFF)

flags - additional Native settings. Take effect only on *nix based systems

Returns:

If the operation is successfully completed, the method returns true, otherwise false

purgePort

public boolean purgePort(long handle,
                         int flags)

Purge of input and output buffer

Parameters:

handle - handle of opened port

flags - flags specifying required actions for purgePort method

Returns:

If the operation is successfully completed, the method returns true, otherwise false

closePort

public boolean closePort(long handle)

Close port

Parameters:

handle - handle of opened port

Returns:

If the operation is successfully completed, the method returns true, otherwise false

setEventsMask

public boolean setEventsMask(long handle,
                             int mask)

Set events mask

Parameters:

handle - handle of opened port

mask - events mask

Returns:

If the operation is successfully completed, the method returns true, otherwise false

getEventsMask

public int getEventsMask(long handle)

Get events mask

Parameters:

handle - handle of opened port

Returns:

Method returns event mask as a variable of int type

waitEvents

public int[][] waitEvents(long handle)

Wait events

Parameters:

handle - handle of opened port

Returns:

Method returns two-dimensional array containing event types and their values (events[i][0] - event type, events[i][1] - event value).

setRTS

public boolean setRTS(long handle,
                      boolean value)

Change RTS line state

Parameters:

handle - handle of opened port

value - true - ON, false - OFF

Returns:

If the operation is successfully completed, the method returns true, otherwise false

setDTR

public boolean setDTR(long handle,
                      boolean value)

Change DTR line state

Parameters:

handle - handle of opened port

value - true - ON, false - OFF

Returns:

If the operation is successfully completed, the method returns true, otherwise false

readBytes

public byte[] readBytes(long handle,
                        int byteCount)

Read data from port

Parameters:

handle - handle of opened port

byteCount - count of bytes required to read

Returns:

Method returns the array of read bytes

writeBytes

public boolean writeBytes(long handle,
                          byte[] buffer)

Write data to port

Parameters:

handle - handle of opened port

buffer - array of bytes to write

Returns:

If the operation is successfully completed, the method returns true, otherwise false

getBuffersBytesCount

public int[] getBuffersBytesCount(long handle)

Get bytes count in buffers of port

Parameters:

handle - handle of opened port

Returns:

Method returns the array that contains info about bytes count in buffers:
element 0 - input buffer
element 1 - output buffer

Since:

0.8

setFlowControlMode

public boolean setFlowControlMode(long handle,
                                  int mask)

Set flow control mode

Parameters:

handle - handle of opened port

mask - mask of flow control mode

Returns:

If the operation is successfully completed, the method returns true, otherwise false

Since:

0.8

getFlowControlMode

public int getFlowControlMode(long handle)

Get flow control mode

Parameters:

handle - handle of opened port

Returns:

Mask of set flow control mode

Since:

0.8

getSerialPortNames

public String[] getSerialPortNames()

Get serial port names like an array of String

Returns:

unsorted array of String with port names

getLinesStatus

public int[] getLinesStatus(long handle)

Getting lines states

Parameters:

handle - handle of opened port

Returns:

Method returns the array containing information about lines in following order:
element 0 - CTS line state
element 1 - DSR line state
element 2 - RING line state
element 3 - RLSD line state

sendBreak

public boolean sendBreak(long handle,
                         int duration)

Send Break signal for set duration

Parameters:

handle - handle of opened port

duration - duration of Break signal, in milliseconds

Returns:

If the operation is successfully completed, the method returns true, otherwise false

Since:

0.8