com.pi4j.io.serial.impl

Class SerialImpl

java.lang.Object

com.pi4j.io.serial.impl.SerialImpl

All Implemented Interfaces:

Serial

public class SerialImpl
extends Object
implements Serial

This implementation class implements the 'Serial' interface using the WiringPi Serial library.

Before using the Pi4J library, you need to ensure that the Java VM in configured with access to the following system libraries:

• pi4j
• wiringPi

This library depends on the wiringPi native system library.
(developed by Gordon Henderson @ https://projects.drogon.net/)

Author:

Robert Savage (http://www.savagehomeautomation.com)

See Also:

#com.pi4j.io.serial.Serial, #com.pi4j.io.serial.SerialDataEvent, #com.pi4j.io.serial.SerialDataListener, #com.pi4j.io.serial.SerialFactory, http://www.pi4j.com/

Field Summary

Fields inherited from interface com.pi4j.io.serial.Serial

DEFAULT_COM_PORT

Constructor Summary

Constructors

Constructor and Description
SerialImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(SerialDataListener... listener) Add Serial Event Listener
int	availableBytes() This method is called to determine if and how many bytes are available on the serial received data buffer.
void	close() This method is called to close a currently open open serial port.
void	flush() This method is called to immediately flush the serial data transmit buffer and force any pending data to be sent to the serial port immediately.
boolean	isOpen() This method is called to determine if the serial port is already open.
int	open(String device, int baudRate) This method is call to open a serial port for communication.
char	read() This method will read the next character available from the serial port receive buffer.
void	removeListener(SerialDataListener... listener) Remove Serial Event Listener
void	write(byte data) This method is called to submit a single byte of data to the serial port transmit buffer.
void	write(byte[] data) This method is called to submit a byte array of data to the serial port transmit buffer.
void	write(char data) This method is called to submit a single character of data to the serial port transmit buffer.
void	write(char[] data) This method is called to submit a character array of data to the serial port transmit buffer.
void	write(String data) This method is called to submit a string of data to the serial port transmit buffer.
void	write(String data, String... args) This method is called to submit a string of formatted data to the serial port transmit buffer.
void	writeln(String data) This method is called to submit a string of data with trailing CR + LF characters to the serial port transmit buffer.
void	writeln(String data, String... args) This method is called to submit a string of formatted data with trailing CR + LF characters to the serial port transmit buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialImpl

public SerialImpl()

Method Detail

open

public int open(String device,
       int baudRate)

This method is call to open a serial port for communication.

Specified by:

open in interface Serial

Parameters:

device - The device address of the serial port to access. You can use constant 'DEFAULT_COM_PORT' if you wish to access the default serial port provided via the GPIO header.

baudRate - The baud rate to use with the serial port.

Returns:

The return value is the file descriptor or -1 for any error.

See Also:

Serial.DEFAULT_COM_PORT

isOpen

public boolean isOpen()

This method is called to determine if the serial port is already open.

Specified by:

isOpen in interface Serial

Returns:

a value of 'true' is returned if the serial port is already open.

See Also:

open(String, int)

close

public void close()

This method is called to close a currently open open serial port.

Specified by:

close in interface Serial

flush

public void flush()

This method is called to immediately flush the serial data transmit buffer and force any pending data to be sent to the serial port immediately.

Specified by:

flush in interface Serial

read

public char read()

This method will read the next character available from the serial port receive buffer.

NOTE: If a serial data listener has been implemented and registered with this class, then this method should not be called directly. A background thread will be running to collect received data from the serial port receive buffer and the received data will be available on via the event.

Specified by:

read in interface Serial

Returns:

next available character in the serial data buffer

write

public void write(char data)

This method is called to submit a single character of data to the serial port transmit buffer.

Specified by:

write in interface Serial

Parameters:

data - A single character to be transmitted.

write

public void write(char[] data)

This method is called to submit a character array of data to the serial port transmit buffer.

Specified by:

write in interface Serial

Parameters:

data - A character array of data to be transmitted.

write

public void write(byte data)

This method is called to submit a single byte of data to the serial port transmit buffer.

Specified by:

write in interface Serial

Parameters:

data - A single byte to be transmitted.

write

public void write(byte[] data)

This method is called to submit a byte array of data to the serial port transmit buffer.

Specified by:

write in interface Serial

Parameters:

data - A byte array of data to be transmitted.

write

public void write(String data)

This method is called to submit a string of data to the serial port transmit buffer.

Specified by:

write in interface Serial

Parameters:

data - A string of data to be transmitted.

writeln

public void writeln(String data)

This method is called to submit a string of data with trailing CR + LF characters to the serial port transmit buffer.

Specified by:

writeln in interface Serial

Parameters:

data - A string of data to be transmitted.

write

public void write(String data,
         String... args)

This method is called to submit a string of formatted data to the serial port transmit buffer.

Specified by:

write in interface Serial

Parameters:

data - A string of formatted data to be transmitted.

args - A series of arguments that can be included for the format string variable replacements.

writeln

public void writeln(String data,
           String... args)

This method is called to submit a string of formatted data with trailing CR + LF characters to the serial port transmit buffer.

Specified by:

writeln in interface Serial

Parameters:

data - A string of formatted data to be transmitted.

args - A series of arguments that can be included for the format string variable replacements.

availableBytes

public int availableBytes()

This method is called to determine if and how many bytes are available on the serial received data buffer.

Specified by:

availableBytes in interface Serial

Returns:

The number of available bytes pending in the serial received buffer is returned.

addListener

public void addListener(SerialDataListener... listener)

Add Serial Event Listener

Java consumer code can call this method to register itself as a listener for serial data events.

Specified by:

addListener in interface Serial

Parameters:

listener - A class instance that implements the SerialListener interface.

See Also:

#com.pi4j.io.serial.SerialDataListener, #com.pi4j.io.serial.SerialDataEvent

removeListener

public void removeListener(SerialDataListener... listener)

Remove Serial Event Listener

Java consumer code can call this method to unregister itself as a listener for serial data events.

Specified by:

removeListener in interface Serial

Parameters:

listener - A class instance that implements the SerialListener interface.

See Also:

#com.pi4j.io.serial.SerialDataListener, #com.pi4j.io.serial.SerialDataEvent