Module com.pi4j

Package com.pi4j.io.spi

Interface SpiConfig

All Superinterfaces:

AddressConfig<SpiConfig>, Config<SpiConfig>, IOConfig<SpiConfig>

public interface SpiConfig
extends AddressConfig<SpiConfig>, IOConfig<SpiConfig>

SpiConfig interface.

Version:

$Id: $Id

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BAUD_KEY	Constant BAUD_KEY="baud"
static final String	BUS_KEY	Constant BUS_KEY="bus"
static final String	FLAGS_KEY	Constant FLAGS_KEY="flags"
static final String	MODE_KEY	Constant MODE_KEY="mode"

Fields inherited from interface com.pi4j.config.AddressConfig

ADDRESS_KEY

Fields inherited from interface com.pi4j.config.Config

DESCRIPTION_KEY, ID_KEY, NAME_KEY

Fields inherited from interface com.pi4j.io.IOConfig

PLATFORM_KEY, PROVIDER_KEY

Method Summary

Modifier and Type	Method	Description
Integer	baud()	baud.
SpiBus	bus()	bus.
boolean	busUserProvided()	busUserProvided.
Integer	channel()	channel.
SpiChipSelect	chipSelect()	chipSelect.
Long	flags()	flags.
default Integer	getBaud()	getBaud.
default SpiBus	getBus()	getBus.
default boolean	getBusUserProvided()	getBusUserProvided.
default Integer	getChannel()	getFlags.
default SpiChipSelect	getChipSelect()	getFlags.
default Long	getFlags()	getFlags.
default SpiMode	getMode()	getMode.
default boolean	getModeUserProvided()	bgetModeUserProvided.
SpiMode	mode()	mode.
boolean	modeUserProvided()	modeUserProvided.
static SpiConfigBuilder	newBuilder(Context context)	newBuilder.

Methods inherited from interface com.pi4j.config.AddressConfig

address, getAddress

Methods inherited from interface com.pi4j.config.Config

description, getDescription, getId, getName, id, name, properties, validate

Methods inherited from interface com.pi4j.io.IOConfig

getPlatform, getProvider, platform, provider

Field Details

BAUD_KEY

static final String BAUD_KEY

Constant BAUD_KEY="baud"

See Also:

• Constant Field Values

BUS_KEY

static final String BUS_KEY

Constant BUS_KEY="bus"

See Also:

• Constant Field Values

MODE_KEY

static final String MODE_KEY

Constant MODE_KEY="mode"

See Also:

• Constant Field Values

FLAGS_KEY

static final String FLAGS_KEY

Constant FLAGS_KEY="flags"

See Also:

• Constant Field Values

Method Details

newBuilder

static SpiConfigBuilder newBuilder(Context context)

newBuilder.

Parameters:

context - Context

Returns:

a I2CConfigBuilder object.

baud

Integer baud()

baud.

Returns:

a Integer object.

getBaud

default Integer getBaud()

getBaud.

Returns:

a Integer object.

bus

SpiBus bus()

bus.

If the Bus value is configured, that SpiBus value will be set in the flags flags() bit 'A' 8

Returns:

a SpiBus object.

getBus

default SpiBus getBus()

getBus.

Returns:

a SpiBus object.

busUserProvided

boolean busUserProvided()

busUserProvided.

Returns:

a boolean.

getBusUserProvided

default boolean getBusUserProvided()

getBusUserProvided.

Returns:

a Boolean object.

mode

SpiMode mode()

mode.

If the Mode value is configured, that SpiMode value will be set in the flags mode() bit 'm m' 1:0

Returns:

a SpiMode object.

getMode

default SpiMode getMode()

getMode.

Returns:

a SpiMode object.

modeUserProvided

boolean modeUserProvided()

modeUserProvided.

Returns:

a boolean.

getModeUserProvided

default boolean getModeUserProvided()

bgetModeUserProvided.

Returns:

a Boolean object.

flags

Long flags()

flags.

Returns:

a Long object.

getFlags

default Long getFlags()

getFlags.

Returns:

a Long object.

channel

Integer channel()

channel. (ALIAS for 'address')

Returns:

a Integer object.

getChannel

default Integer getChannel()

getFlags. (ALIAS for 'getAddress')

Returns:

a Long object.

chipSelect

SpiChipSelect chipSelect()

chipSelect. (ALIAS for 'address')

Returns:

a SpiChipSelect object.

getChipSelect

default SpiChipSelect getChipSelect()

getFlags. (ALIAS for 'getAddress')

Returns:

a SpiChipSelect object.