com.digi.android.spi

Enum SPIClockMode

java.lang.Object

java.lang.Enum<SPIClockMode>

com.digi.android.spi.SPIClockMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SPIClockMode>

public enum SPIClockMode
extends java.lang.Enum<SPIClockMode>

Enumerates the possible clock modes of an SPI interface.

The clock mode represents the combination of the CPOL (SPI Clock Polarity Bit) and CPHA (SPI Clock Phase Bit) signals.

See Also:

SPI, SPIConfig

Enum Constant Summary

Enum Constants

Enum Constant and Description
CPOL_0_CPHA_0 Mode 0: Clock polarity = 0 / Clock phase = 0
CPOL_0_CPHA_1 Mode 1: Clock polarity = 0 / Clock phase = 1
CPOL_1_CPHA_0 Mode 2: Clock polarity = 1 / Clock phase = 0
CPOL_1_CPHA_1 Mode 3: Clock polarity = 1 / Clock phase = 1

Method Summary

Methods

Modifier and Type	Method and Description
static SPIClockMode	getByValue(int value) Returns the SPIMode associated to the provided value.
int	getValue() Returns the SPI mode value.
static SPIClockMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SPIClockMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, getSharedConstants, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CPOL_0_CPHA_0

public static final SPIClockMode CPOL_0_CPHA_0

Mode 0: Clock polarity = 0 / Clock phase = 0

CPOL_0_CPHA_1

public static final SPIClockMode CPOL_0_CPHA_1

Mode 1: Clock polarity = 0 / Clock phase = 1

CPOL_1_CPHA_0

public static final SPIClockMode CPOL_1_CPHA_0

Mode 2: Clock polarity = 1 / Clock phase = 0

CPOL_1_CPHA_1

public static final SPIClockMode CPOL_1_CPHA_1

Mode 3: Clock polarity = 1 / Clock phase = 1

Method Detail

values

public static SPIClockMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SPIClockMode c : SPIClockMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SPIClockMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Returns the SPI mode value.

Returns:

The SPI mode value.

getByValue

public static SPIClockMode getByValue(int value)

Returns the SPIMode associated to the provided value.

Parameters:

value - The value of the SPIMode to retrieve.

Returns:

The SPIMode associated to the provided value or null if not found.