Serial (Processing serial library 3.0.2 API)

java.lang.Object
- processing.serial.Serial

All Implemented Interfaces:

jssc.SerialPortEventListener
```
public class Serial
extends Object
implements jssc.SerialPortEventListener
```
( begin auto-generated from Serial.xml ) Class for sending and receiving data using the serial communication protocol. ( end auto-generated )

Field Summary

Fields
Modifier and Type Field and Description

jssc.SerialPort port

Fields
Modifier and Type	Field and Description
`jssc.SerialPort`	`port`

Constructor Summary

Constructors
Constructor and Description
`Serial(PApplet parent)`
`Serial(PApplet parent, int baudRate)`
`Serial(PApplet parent, String portName)`
`Serial(PApplet parent, String portName, int baudRate)`
`Serial(PApplet parent, String portName, int baudRate, char parity, int dataBits, float stopBits)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`active()` Return true if this port is still active and hasn't run into any trouble.
`int`	`available()`
`void`	`buffer(int size)`
`void`	`bufferUntil(int inByte)`
`void`	`clear()`
`void`	`dispose()` Used by PApplet to shut things down.
`boolean`	`getCTS()`
`boolean`	`getDSR()`
`static Map<String,String>`	`getProperties(String portName)`
`int`	`last()`
`char`	`lastChar()`
`static String[]`	`list()`
`void`	`pre()`
`int`	`read()`
`byte[]`	`readBytes()`
`int`	`readBytes(byte[] dest)` Advanced
`byte[]`	`readBytesUntil(int inByte)`
`int`	`readBytesUntil(int inByte, byte[] dest)` Advanced
`char`	`readChar()`
`String`	`readString()`
`String`	`readStringUntil(int inByte)`
`void`	`serialEvent(jssc.SerialPortEvent event)`
`void`	`setDTR(boolean state)` Set the DTR line
`void`	`setRTS(boolean state)` Set the RTS line
`void`	`stop()`
`void`	`write(byte[] src)`
`void`	`write(int src)` Advanced
`void`	`write(String src)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - port
```
public jssc.SerialPort port
```
- Constructor Detail
  - Serial
```
public Serial(PApplet parent)
```
    Parameters:
    
    parent - typically use "this"
  - Serial
```
public Serial(PApplet parent,
              int baudRate)
```
    Parameters:
    
    baudRate - 9600 is the default
  - Serial
```
public Serial(PApplet parent,
              String portName)
```
    Parameters:
    
    portName - name of the port (COM1 is the default)
  - Serial
```
public Serial(PApplet parent,
              String portName,
              int baudRate)
```
  - Serial
```
public Serial(PApplet parent,
              String portName,
              int baudRate,
              char parity,
              int dataBits,
              float stopBits)
```
    Parameters:
    
    parity - 'N' for none, 'E' for even, 'O' for odd, 'M' for mark, 'S' for space ('N' is the default)
    
    dataBits - 8 is the default
    
    stopBits - 1.0, 1.5, or 2.0 (1.0 is the default)
- Method Detail
  - dispose
```
public void dispose()
```
    Used by PApplet to shut things down.
  - active
```
public boolean active()
```
    Return true if this port is still active and hasn't run into any trouble.
  - pre
```
public void pre()
```
  - available
```
public int available()
```
  - buffer
```
public void buffer(int size)
```
    Parameters:
    
    size - number of bytes to buffer
  - bufferUntil
```
public void bufferUntil(int inByte)
```
    Parameters:
    
    inByte - the value to buffer until
  - clear
```
public void clear()
```
  - getCTS
```
public boolean getCTS()
```
  - getDSR
```
public boolean getDSR()
```
  - getProperties
```
public static Map<String,String> getProperties(String portName)
```
  - last
```
public int last()
```
  - lastChar
```
public char lastChar()
```
  - list
```
public static String[] list()
```
  - read
```
public int read()
```
  - readBytes
```
public byte[] readBytes()
```
  - readBytes
```
public int readBytes(byte[] dest)
```
    Advanced
    Grab whatever is in the serial buffer, and stuff it into a byte buffer passed in by the user. This is more memory/time efficient than readBytes() returning a byte[] array. Returns an int for how many bytes were read. If more bytes are available than can fit into the byte array, only those that will fit are read.
  - readBytesUntil
```
public byte[] readBytesUntil(int inByte)
```
    Parameters:
    
    inByte - character designated to mark the end of the data
  - readBytesUntil
```
public int readBytesUntil(int inByte,
                          byte[] dest)
```
    Advanced
    If dest[] is not big enough, then -1 is returned, and an error message is printed on the console. If nothing is in the buffer, zero is returned. If 'interesting' byte is not in the buffer, then 0 is returned.
    
    Parameters:
    
    dest - passed in byte array to be altered
  - readChar
```
public char readChar()
```
  - readString
```
public String readString()
```
  - readStringUntil
```
public String readStringUntil(int inByte)
```
    Parameters:
    
    inByte - character designated to mark the end of the data
  - serialEvent
```
public void serialEvent(jssc.SerialPortEvent event)
```
    Specified by:
    
    serialEvent in interface jssc.SerialPortEventListener
    
    Parameters:
    
    serialPorttEvent - the port where new data is available
  - setDTR
```
public void setDTR(boolean state)
```
    Set the DTR line
  - setRTS
```
public void setRTS(boolean state)
```
    Set the RTS line
  - stop
```
public void stop()
```
  - write
```
public void write(byte[] src)
```
    Parameters:
    
    src - data to write
  - write
```
public void write(int src)
```
    Advanced
    This will handle both ints, bytes and chars transparently.
    
    Parameters:
    
    src - data to write
  - write
```
public void write(String src)
```
    Parameters:
    
    src - data to write

Class Serial

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

port

Constructor Detail

Serial

Serial

Serial

Serial

Serial

Method Detail

dispose

active

pre

available

buffer

bufferUntil

clear

getCTS

getDSR

getProperties

last

lastChar

list

read

readBytes

readBytes

Advanced

readBytesUntil

readBytesUntil

Advanced

readChar

readString

readStringUntil

serialEvent

setDTR

setRTS

stop

write

write

Advanced

write