com.pi4j.io.spi

Interface SpiDevice

All Known Implementing Classes:

SpiDeviceImpl

public interface SpiDevice

Field Summary

Fields

Modifier and Type	Field and Description
static SpiMode	DEFAULT_SPI_MODE
static int	DEFAULT_SPI_SPEED
static int	MAX_SUPPORTED_BYTES

Method Summary

Modifier and Type	Method and Description
byte[]	write(byte... data) Attempts to read/write data through this SPI device
byte[]	write(byte[] data, int start, int length) Attempts to read/write data through this SPI device
ByteBuffer	write(ByteBuffer data) Attempts to read/write data through this SPI device
byte[]	write(InputStream input) Attempts to read/write data through this SPI device
int	write(InputStream input, OutputStream output) Attempts to read/write data through this SPI device
short[]	write(short... data) Attempts to read/write data through this SPI device
short[]	write(short[] data, int start, int length) Attempts to read/write data through this SPI device
String	write(String data, Charset charset) Attempts to read/write data through this SPI device
String	write(String data, String charset) Attempts to read/write data through this SPI device

Field Detail

DEFAULT_SPI_MODE

static final SpiMode DEFAULT_SPI_MODE

DEFAULT_SPI_SPEED

static final int DEFAULT_SPI_SPEED

See Also:

Constant Field Values

MAX_SUPPORTED_BYTES

static final int MAX_SUPPORTED_BYTES

See Also:

Constant Field Values

Method Detail

write

String write(String data,
             Charset charset)
      throws IOException

Attempts to read/write data through this SPI device

Parameters:

data - bytes (encoded in string) to write to the SPI device

charset - character encoding for bytes in string

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException

write

String write(String data,
             String charset)
      throws IOException

Attempts to read/write data through this SPI device

Parameters:

data - bytes (encoded in string) to write to the SPI device

charset - character encoding for bytes in string

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException

write

ByteBuffer write(ByteBuffer data)
          throws IOException

Attempts to read/write data through this SPI device

Parameters:

data - bytes to write to the SPI device

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException

write

byte[] write(InputStream input)
      throws IOException

Attempts to read/write data through this SPI device

Parameters:

input - input stream to read from to get bytes to write to the SPI device

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException

write

int write(InputStream input,
          OutputStream output)
   throws IOException

Attempts to read/write data through this SPI device

Parameters:

input - input stream to read from to get bytes to write to the SPI device

output - output stream to write bytes read from the SPI device

Returns:

number of resulting bytes read from the SPI device and written to the output stream

Throws:

IOException

write

byte[] write(byte[] data,
             int start,
             int length)
      throws IOException

Attempts to read/write data through this SPI device

Parameters:

data - bytes to write to the SPI device

start - start index position in the data buffer to start writing from

length - length of bytes to write from the data buffer

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException

write

byte[] write(byte... data)
      throws IOException

Attempts to read/write data through this SPI device

Parameters:

data - bytes to write to the SPI device

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException

write

short[] write(short[] data,
              int start,
              int length)
       throws IOException

Attempts to read/write data through this SPI device

Parameters:

data - bytes to write to the SPI device

start - start index position in the data buffer to start writing from

length - length of bytes to write from the data buffer

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException

write

short[] write(short... data)
       throws IOException

Attempts to read/write data through this SPI device

Parameters:

data - bytes to write to the SPI device (Note: short value should not exceed 255.)

Returns:

resulting bytes read from the SPI device after the write operation

Throws:

IOException