Package com.diozero.api

Class SpiDevice

java.lang.Object

com.diozero.api.SpiDevice

All Implemented Interfaces:

DeviceInterface, SpiDeviceInterface, Closeable, AutoCloseable

public class SpiDevice
extends Object
implements SpiDeviceInterface

Serial Peripheral Interface device

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpiDevice.Builder	I2C device builder.

Constructor Summary

Constructors

Constructor	Description
SpiDevice(int chipSelect)
SpiDevice(int controller, int chipSelect)
SpiDevice(int controller, int chipSelect, int frequency, SpiClockMode mode, boolean lsbFirst)

Method Summary

Modifier and Type	Method	Description
static SpiDevice.Builder	builder(int chipSelect)	Construct a new SPI device builder instance using the specified chip select value
void	close()	Close this device
int	getChipSelect()	Get the SPI Chip Select
int	getController()	Get the SPI controller
String	getKey()	Get the unique device identifier for this device
boolean	isOpen()	Check if this device is open or closed
void	write(byte... txBuffer)	Write the entire contents of data to the device
void	write(byte[] txBuffer, int txOffset, int length)	Write length bytes from data starting at offset
byte[]	writeAndRead(byte... out)	Write the data to the device then read data.length bytes from the device

Methods inherited from class java.lang.Object

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

Constructor Details

SpiDevice

public SpiDevice(int chipSelect)
          throws RuntimeIOException

Throws:

RuntimeIOException

SpiDevice

public SpiDevice(int controller,
int chipSelect)
          throws RuntimeIOException

Throws:

RuntimeIOException

SpiDevice

public SpiDevice(int controller,
int chipSelect,
int frequency,
SpiClockMode mode,
boolean lsbFirst)
          throws RuntimeIOException

Throws:

RuntimeIOException

Method Details

builder

public static SpiDevice.Builder builder(int chipSelect)

Construct a new SPI device builder instance using the specified chip select value

Parameters:

chipSelect - SPI chip select

Returns:

SPI device builder

getKey

public String getKey()

Get the unique device identifier for this device

Specified by:

getKey in interface DeviceInterface

Returns:

unique device identifier

isOpen

public boolean isOpen()

Check if this device is open or closed

Specified by:

isOpen in interface DeviceInterface

Returns:

true if this device is open

close

public void close()
           throws RuntimeIOException

Close this device

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface DeviceInterface

Throws:

RuntimeIOException

getController

public int getController()

Get the SPI controller

Specified by:

getController in interface SpiDeviceInterface

Returns:

the SPI controller

getChipSelect

public int getChipSelect()

Get the SPI Chip Select

Specified by:

getChipSelect in interface SpiDeviceInterface

Returns:

the SPI chip select

write

public void write(byte... txBuffer)
           throws RuntimeIOException

Write the entire contents of data to the device

Specified by:

write in interface SpiDeviceInterface

Parameters:

txBuffer - the data to write

Throws:

RuntimeIOException - if an I/O error occurs

write

public void write(byte[] txBuffer,
int txOffset,
int length)
           throws RuntimeIOException

Write length bytes from data starting at offset

Specified by:

write in interface SpiDeviceInterface

Parameters:

txBuffer - the data to write.

txOffset - the start offset in the data.

length - the number of bytes to write.

Throws:

RuntimeIOException - if an I/O error occurs

writeAndRead

public byte[] writeAndRead(byte... out)
                    throws RuntimeIOException

Write the data to the device then read data.length bytes from the device

Specified by:

writeAndRead in interface SpiDeviceInterface

Parameters:

out - the data to write.

Returns:

the data read from the device, same length as the data written.

Throws:

RuntimeIOException - if an I/O error occurs