com.raspoid

Enum I2CPin

java.lang.Object

java.lang.Enum<I2CPin>

com.raspoid.I2CPin

All Implemented Interfaces:

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

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

This enum is used to restrict access to the correct i2c pins.

The I2C bus was designed by Philips in the early ’80s to allow easy communication between components which reside on the same circuit board. Only two bus lines are required:

• SDA (Serial Data Line): bidirectional data line.
• SCL (Serial Clock Line): clock for bidirectional synchronization.

Those bus lines can easily be accessed through this enumeration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SCL1 Serial Clock Line pin.
SDA1 Serial Data Line pin.

Method Summary

Modifier and Type	Method and Description
Pin	getPin() Get the Raspoid pin abstraction for this I2CPin.
static I2CPin	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static I2CPin[]	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, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SDA1

public static final I2CPin SDA1

Serial Data Line pin.

SCL1

public static final I2CPin SCL1

Serial Clock Line pin.

Method Detail

values

public static I2CPin[] 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 (I2CPin c : I2CPin.values())
    System.out.println(c);

Returns:

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

valueOf

public static I2CPin 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

getPin

public Pin getPin()

Get the Raspoid pin abstraction for this I2CPin.

Returns:

the Raspoid Pin object corresponding to this I2CPin.

See Also:

Pin