Serial (Pi4J :: Parent POM 1.0 API)

All Known Implementing Classes:

SerialImpl
```
public interface Serial
```
This interface provides a set of functions for 'Serial' communication.

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 @ http://wiringpi.com/)
Author:

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

See Also:

SerialFactory, SerialDataEvent, SerialDataListener, http://www.pi4j.com/

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_COM_PORT
The default hardware COM port provided via the Raspberry Pi GPIO header.

static int DEFAULT_MONITOR_INTERVAL

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_COM_PORT` The default hardware COM port provided via the Raspberry Pi GPIO header.
`static int`	`DEFAULT_MONITOR_INTERVAL`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addListener(SerialDataListener... listener)` Java consumer code can call this method to register itself as a listener for serial data events.
`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.
`int`	`getMonitorInterval()` This method returns the serial data receive monitor delay interval in milliseconds.
`boolean`	`isClosed()` This method is called to determine if the serial port is already closed.
`boolean`	`isOpen()` This method is called to determine if the serial port is already open.
`boolean`	`isShutdown()` This method returns TRUE if the serial interface has been shutdown.
`void`	`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)` Java consumer code can call this method to unregister itself as a listener for serial data events.
`void`	`setMonitorInterval(int interval)` This method set the serial data receive monitor delay interval in milliseconds.
`void`	`shutdown()` This method can be called to forcefully shutdown all serial data monitoring threads.
`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.

- Field Detail
  - DEFAULT_COM_PORT
```
static final String DEFAULT_COM_PORT
```
    The default hardware COM port provided via the Raspberry Pi GPIO header.
    
    See Also:
    
    open(String, int), Constant Field Values
  - DEFAULT_MONITOR_INTERVAL
```
static final int DEFAULT_MONITOR_INTERVAL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - open
```
void open(String device,
          int baudRate)
   throws SerialPortException
```
    This method is call to open a serial port for communication.
    
    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.
    
    Throws:
    
    SerialPortException - Exception thrown on any error.
    
    See Also:
    
    DEFAULT_COM_PORT
  - close
```
void close()
    throws IllegalStateException
```
    This method is called to close a currently open open serial port.
    
    Throws:
    
    IllegalStateException
  - isOpen
```
boolean isOpen()
```
    This method is called to determine if the serial port is already open.
    
    Returns:
    
    a value of 'true' is returned if the serial port is already open.
    
    See Also:
    
    open(String, int)
  - isClosed
```
boolean isClosed()
```
    This method is called to determine if the serial port is already closed.
    
    Returns:
    
    a value of 'true' is returned if the serial port is already in the closed state.
    
    See Also:
    
    open(String, int)
  - flush
```
void flush()
    throws IllegalStateException
```
    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.
    
    Throws:
    
    IllegalStateException
  - read
```
char read()
   throws IllegalStateException
```
    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.
    
    Returns:
    
    next available character in the serial data buffer
    
    Throws:
    
    IllegalStateException
  - write
```
void write(char data)
    throws IllegalStateException
```
    This method is called to submit a single character of data to the serial port transmit buffer.
    
    Parameters:
    
    data - A single character to be transmitted.
    
    Throws:
    
    IllegalStateException
  - write
```
void write(char[] data)
    throws IllegalStateException
```
    This method is called to submit a character array of data to the serial port transmit buffer.
    
    Parameters:
    
    data - A character array of data to be transmitted.
    
    Throws:
    
    IllegalStateException
  - write
```
void write(byte data)
    throws IllegalStateException
```
    This method is called to submit a single byte of data to the serial port transmit buffer.
    
    Parameters:
    
    data - A single byte to be transmitted.
    
    Throws:
    
    IllegalStateException
  - write
```
void write(byte[] data)
    throws IllegalStateException
```
    This method is called to submit a byte array of data to the serial port transmit buffer.
    
    Parameters:
    
    data - A byte array of data to be transmitted.
    
    Throws:
    
    IllegalStateException
  - write
```
void write(String data)
    throws IllegalStateException
```
    This method is called to submit a string of data to the serial port transmit buffer.
    
    Parameters:
    
    data - A string of data to be transmitted.
    
    Throws:
    
    IllegalStateException
  - writeln
```
void writeln(String data)
      throws IllegalStateException
```
    This method is called to submit a string of data with trailing CR + LF characters to the serial port transmit buffer.
    
    Parameters:
    
    data - A string of data to be transmitted.
    
    Throws:
    
    IllegalStateException
  - write
```
void write(String data,
           String... args)
    throws IllegalStateException
```
    This method is called to submit a string of formatted data to the serial port transmit buffer.
    
    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.
    
    Throws:
    
    IllegalStateException
  - writeln
```
void writeln(String data,
             String... args)
      throws IllegalStateException
```
    This method is called to submit a string of formatted data with trailing CR + LF characters to the serial port transmit buffer.
    
    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.
    
    Throws:
    
    IllegalStateException
  - availableBytes
```
int availableBytes()
            throws IllegalStateException
```
    This method is called to determine if and how many bytes are available on the serial received data buffer.
    
    Returns:
    
    The number of available bytes pending in the serial received buffer is returned.
    
    Throws:
    
    IllegalStateException
  - addListener
```
void addListener(SerialDataListener... listener)
```
    Java consumer code can call this method to register itself as a listener for serial data events.
    
    Parameters:
    
    listener - A class instance that implements the SerialListener interface.
    
    See Also:
    
    SerialDataListener, SerialDataEvent
  - removeListener
```
void removeListener(SerialDataListener... listener)
```
    Java consumer code can call this method to unregister itself as a listener for serial data events.
    
    Parameters:
    
    listener - A class instance that implements the SerialListener interface.
    
    See Also:
    
    SerialDataListener, SerialDataEvent
  - isShutdown
```
boolean isShutdown()
```
    This method returns TRUE if the serial interface has been shutdown.
    
    Returns:
    
    shutdown state
  - shutdown
```
void shutdown()
```
    This method can be called to forcefully shutdown all serial data monitoring threads.
  - getMonitorInterval
```
int getMonitorInterval()
```
    This method returns the serial data receive monitor delay interval in milliseconds.
    
    Returns:
    
    interval milliseconds
  - setMonitorInterval
```
void setMonitorInterval(int interval)
```
    This method set the serial data receive monitor delay interval in milliseconds.
    
    Parameters:
    
    interval - number of milliseconds

Interface Serial

Field Summary

Method Summary

Field Detail

DEFAULT_COM_PORT

DEFAULT_MONITOR_INTERVAL

Method Detail

open

close

isOpen

isClosed

flush

read

write

write

write

write

write

writeln

write

writeln

availableBytes

addListener

removeListener

isShutdown

shutdown

getMonitorInterval

setMonitorInterval