processing.io

Class SPI

Object

SPI

public class SPI
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	LSBFIRST least significant bit first
static int	MODE0 CPOL=0, CPHA=0, most common
static int	MODE1 CPOL=0, CPHA=1
static int	MODE2 CPOL=1, CPHA=0
static int	MODE3 CPOL=1, CPHA=1
static int	MSBFIRST most significant bit first, most common

Constructor Summary

Constructors

Constructor and Description
SPI(String dev) Opens an SPI interface as master

Method Summary

Modifier and Type	Method and Description
void	close() Closes the SPI interface
static String[]	list() Lists all available SPI interfaces
void	settings(int maxSpeed, int dataOrder, int mode) Configures the SPI interface
byte[]	transfer(byte out) Transfers data over the SPI bus
byte[]	transfer(byte[] out) Transfers data over the SPI bus
byte[]	transfer(int out) Transfers data over the SPI bus
byte[]	transfer(String out) Transfers data over the SPI bus

Methods inherited from class Object

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

Field Detail

MODE0

public static final int MODE0

CPOL=0, CPHA=0, most common

See Also:

Constant Field Values

MODE1

public static final int MODE1

CPOL=0, CPHA=1

See Also:

Constant Field Values

MODE2

public static final int MODE2

CPOL=1, CPHA=0

See Also:

Constant Field Values

MODE3

public static final int MODE3

CPOL=1, CPHA=1

See Also:

Constant Field Values

MSBFIRST

public static final int MSBFIRST

most significant bit first, most common

See Also:

Constant Field Values

LSBFIRST

public static final int LSBFIRST

least significant bit first

See Also:

Constant Field Values

Constructor Detail

SPI

public SPI(String dev)

Opens an SPI interface as master

Parameters:

dev - device name

See Also:

list

Method Detail

close

public void close()

Closes the SPI interface

list

public static String[] list()

Lists all available SPI interfaces

Returns:

String array

settings

public void settings(int maxSpeed,
                     int dataOrder,
                     int mode)

Configures the SPI interface

Parameters:

maxSpeed - maximum transmission rate in Hz, 500000 (500 kHz) is a resonable default

dataOrder - whether data is send with the first- or least-significant bit first (SPI.MSBFIRST or SPI.LSBFIRST, the former is more common)

mode - SPI.MODE0 to SPI.MODE3

transfer

public byte[] transfer(byte[] out)

Transfers data over the SPI bus

Parameters:

out - bytes to send

Returns:

bytes read in (array is the same length as out)

transfer

public byte[] transfer(String out)

Transfers data over the SPI bus

Parameters:

out - string to send

Returns:

bytes read in (array is the same length as out)

transfer

public byte[] transfer(int out)

Transfers data over the SPI bus

Parameters:

out - single byte to send, e.g. numeric literal (0 to 255, or -128 to 127)

Returns:

bytes read in (array is the same length as out)

transfer

public byte[] transfer(byte out)

Transfers data over the SPI bus

Parameters:

out - single byte to send

Returns:

bytes read in (array is the same length as out)