Package com.digi.android.spi

Class SPIConfig

java.lang.Object

com.digi.android.spi.SPIConfig

public class SPIConfig
extends java.lang.Object

The SPIConfig class encapsulates the configuration parameters of an SPI device.

See Also:

SPI, SPIBitOrder, SPIChipSelect, SPIClockMode

Constructor Summary

Constructors

Constructor	Description
SPIConfig(SPIClockMode clockMode, int clockFrequency, int wordLength)	Creates a new SPIConfig with the specified configuration.
SPIConfig(SPIClockMode clockMode, SPIChipSelect chipSelect, SPIBitOrder bitOrder, int clockFrequency, int wordLength)	Creates a new SPIConfig with the specified configuration.

Method Summary

Modifier and Type	Method	Description
SPIBitOrder	getBitOrder()	Gets the configured bit ordering.
SPIChipSelect	getChipSelect()	Gets the configured chip select active level.
int	getClockFrequency()	Gets the clock frequency in Hz.
SPIClockMode	getClockMode()	Gets the configured clock mode.
int	getWordLength()	Gets the word length.

Methods inherited from class java.lang.Object

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

Constructor Detail

SPIConfig

public SPIConfig(SPIClockMode clockMode,
                 int clockFrequency,
                 int wordLength)

Creates a new SPIConfig with the specified configuration.

Parameters:

clockMode - The clock mode, one of SPIClockMode.CPOL_0_CPHA_0, SPIClockMode.CPOL_0_CPHA_1, SPIClockMode.CPOL_1_CPHA_0, or SPIClockMode.CPOL_1_CPHA_1.

clockFrequency - The clock frequency in Hz.

wordLength - The word length.

Throws:

java.lang.IllegalArgumentException - If clockFrequency < 1 or if wordLength < 1.

java.lang.NullPointerException - If clockMode == null.

See Also:

SPIClockMode

SPIConfig

public SPIConfig(SPIClockMode clockMode,
                 SPIChipSelect chipSelect,
                 SPIBitOrder bitOrder,
                 int clockFrequency,
                 int wordLength)

Creates a new SPIConfig with the specified configuration.

Parameters:

clockMode - The clock mode, one of SPIClockMode.CPOL_0_CPHA_0, SPIClockMode.CPOL_0_CPHA_1, SPIClockMode.CPOL_1_CPHA_0, or SPIClockMode.CPOL_1_CPHA_1.

chipSelect - The chip select active level, one of SPIChipSelect.ACTIVE_HIGH, SPIChipSelect.ACTIVE_LOW, or SPIChipSelect.NOT_CONTROLLED.

bitOrder - The bit ordering, one of SPIBitOrder.MSB_FIRST or SPIBitOrder.LSB_FIRST.

clockFrequency - The clock frequency in Hz.

wordLength - The word length.

Throws:

java.lang.IllegalArgumentException - If clockFrequency < 1 or if wordLength < 1.

java.lang.NullPointerException - If clockMode == null or if chipSelect == null or if bitOrder == null.

See Also:

SPIClockMode, SPIChipSelect, SPIBitOrder

Method Detail

getClockMode

public SPIClockMode getClockMode()

Gets the configured clock mode.

Returns:

The clock mode, one of SPIClockMode.CPOL_0_CPHA_0, SPIClockMode.CPOL_0_CPHA_1, SPIClockMode.CPOL_1_CPHA_0, or SPIClockMode.CPOL_1_CPHA_1.

See Also:

SPIClockMode

getChipSelect

public SPIChipSelect getChipSelect()

Gets the configured chip select active level.

Returns:

The chip select active level, one of SPIChipSelect.ACTIVE_HIGH, SPIChipSelect.ACTIVE_LOW, or SPIChipSelect.NOT_CONTROLLED.

See Also:

SPIChipSelect

getBitOrder

public SPIBitOrder getBitOrder()

Gets the configured bit ordering.

Returns:

The bit ordering, one of SPIBitOrder.MSB_FIRST or SPIBitOrder.LSB_FIRST.

See Also:

SPIBitOrder

getClockFrequency

public int getClockFrequency()

Gets the clock frequency in Hz.

Returns:

The clock frequency in Hz.

getWordLength

public int getWordLength()

Gets the word length.

Returns:

The word length.