Module com.pi4j.plugin.pigpio

Package com.pi4j.plugin.pigpio.provider.serial

Class PiGpioSerial

java.lang.Object

com.pi4j.common.IdentityBase

com.pi4j.io.IOBase<Serial,SerialConfig,SerialProvider>

com.pi4j.io.serial.SerialBase

com.pi4j.plugin.pigpio.provider.serial.PiGpioSerial

All Implemented Interfaces:

Describable, Identity, Lifecycle, Extension, IO<Serial,SerialConfig,SerialProvider>, IODataReader, IODataWriter, Serial, AutoCloseable, Readable

public class PiGpioSerial
extends SerialBase
implements Serial

PiGpioSerial class.

Version:

$Id: $Id

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	handle
protected final PiGpio	piGpio

Fields inherited from class com.pi4j.io.serial.SerialBase

isOpen

Fields inherited from class com.pi4j.io.IOBase

config, provider

Fields inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

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

DEFAULT_BAUD, DEFAULT_DATA_BITS, DEFAULT_FLOW_CONTROL, DEFAULT_PARITY, DEFAULT_STOP_BITS

Constructor Summary

Constructors

Constructor	Description
PiGpioSerial(PiGpio piGpio, SerialProvider provider, SerialConfig config)	Constructor for PiGpioSerial.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
int	drain()
Serial	initialize(Context context)
int	read()
int	read(byte[] buffer, int offset, int length)
int	write(byte b)
int	write(byte[] data, int offset, int length)

Methods inherited from class com.pi4j.io.serial.SerialBase

isOpen, open

Methods inherited from class com.pi4j.io.IOBase

config, context, describe, description, name, provider, shutdown

Methods inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.common.Identity

description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.io.IO

config, description, name, provider, type

Methods inherited from interface com.pi4j.io.IODataReader

getInputStream, in, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, readByte, readByteBuffer, readByteBuffer, readCharArray, readCharArray, readCharArray, readCharArray, readCharBuffer, readCharBuffer, readCharBuffer, readCharBuffer, readNBytes, readNBytes, readString, readString, readString, readString

Methods inherited from interface com.pi4j.io.IODataWriter

getOutputStream, out, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write

Methods inherited from interface com.pi4j.common.Lifecycle

shutdown

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

isOpen, open

Field Details

piGpio

protected final PiGpio piGpio

handle

protected final int handle

Constructor Details

PiGpioSerial

public PiGpioSerial(PiGpio piGpio,
 SerialProvider provider,
 SerialConfig config)

Constructor for PiGpioSerial.

Parameters:

piGpio - a PiGpio object.

provider - a SerialProvider object.

config - a SerialConfig object.

Method Details

initialize

public Serial initialize(Context context)
                  throws InitializeException

Specified by:

initialize in interface Lifecycle

Overrides:

initialize in class IOBase<Serial,SerialConfig,SerialProvider>

Throws:

InitializeException

available

public int available()

Specified by:

available in interface Serial

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Serial

Overrides:

close in class SerialBase

write

public int write(byte b)

Specified by:

write in interface IODataWriter

write

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

Specified by:

write in interface IODataWriter

read

public int read()

Specified by:

read in interface IODataReader

read

public int read(byte[] buffer,
 int offset,
 int length)

Specified by:

read in interface IODataReader

drain

public int drain()

Specified by:

drain in interface Serial