Module com.pi4j

Package com.pi4j.io.spi

Interface SpiConfigBuilder

All Superinterfaces:

AddressConfigBuilder<SpiConfigBuilder,SpiConfig>, Builder<SpiConfig>, ConfigBuilder<SpiConfigBuilder,SpiConfig>, IOAddressConfigBuilder<SpiConfigBuilder,SpiConfig>, IOConfigBuilder<SpiConfigBuilder,SpiConfig>

public interface SpiConfigBuilder
extends IOAddressConfigBuilder<SpiConfigBuilder,SpiConfig>

SpiConfigBuilder interface.

Version:

$Id: $Id

Author:

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

Method Summary

Modifier and Type	Method	Description
SpiConfigBuilder	baud(Integer rate)	baud.
SpiConfigBuilder	bus(SpiBus bus)	bus.
default SpiConfigBuilder	bus(Integer bus)	bus.
SpiConfigBuilder	channel(Integer channel)	channel.
SpiConfigBuilder	chipSelect(SpiChipSelect chipSelect)	chipSelect.
SpiConfigBuilder	flags(Long flags)	flags.
SpiConfigBuilder	mode(SpiMode mode)	mode.
default SpiConfigBuilder	mode(Integer mode)	mode.
static SpiConfigBuilder	newInstance(Context context)	newInstance.

Methods inherited from interface com.pi4j.config.AddressConfigBuilder

address

Methods inherited from interface com.pi4j.config.Builder

build

Methods inherited from interface com.pi4j.config.ConfigBuilder

allowInheritProperties, description, disallowInheritProperties, id, id, inheritProperties, load, load, load, load, load, load, load, load, load, load, name

Methods inherited from interface com.pi4j.io.IOAddressConfigBuilder

platform, platform, provider, provider

Method Details

newInstance

static SpiConfigBuilder newInstance(Context context)

newInstance.

Parameters:

context - Context

Returns:

a SpiConfigBuilder object.

baud

SpiConfigBuilder baud(Integer rate)

baud.

Parameters:

rate - a Integer object.

Returns:

a SpiConfigBuilder object.

bus

SpiConfigBuilder bus(SpiBus bus)

bus.

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

Parameters:

bus - a SpiBus object.

Returns:

a SpiConfigBuilder object.

bus

default SpiConfigBuilder bus(Integer bus)

bus.

Parameters:

bus - a Integer object.

Returns:

a SpiConfigBuilder object.

mode

SpiConfigBuilder mode(SpiMode mode)

mode.

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

Parameters:

mode - a SpiMode object.

Returns:

a SpiConfigBuilder object.

mode

default SpiConfigBuilder mode(Integer mode)

mode.

Parameters:

mode - a Integer object.

Returns:

a SpiConfigBuilder object.

flags

SpiConfigBuilder flags(Long flags)

flags.

Parameters:

flags - a Long value.

Returns:

a SpiConfigBuilder object.

channel

SpiConfigBuilder channel(Integer channel)

channel. (ALIAS for 'address')

Parameters:

channel - a Integer value.

Returns:

a SpiConfigBuilder object.

chipSelect

SpiConfigBuilder chipSelect(SpiChipSelect chipSelect)

chipSelect. (ALIAS for 'address')

Parameters:

chipSelect - a SpiChipSelect value.

Returns:

a SpiConfigBuilder object.