Package com.ibasco.ucgdisplay.drivers.clcd.enums

Enum LcdPin

java.lang.Object

java.lang.Enum<LcdPin>

com.ibasco.ucgdisplay.drivers.clcd.enums.LcdPin

All Implemented Interfaces:

Serializable, Comparable<LcdPin>, java.lang.constant.Constable

public enum LcdPin
extends Enum<LcdPin>

Enumeration for LCD Pins. Note: Order is important, DO NOT CHANGE!

Author:

Rafael Ibasco

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACKLIGHT	LCD Backlight Pin
DATA_0	Data Pin 0.
DATA_1	Data Pin 1.
DATA_2	Data Pin 2.
DATA_3	Data Pin 3.
DATA_4	Data Pin 4
DATA_5	Data Pin 5
DATA_6	Data Pin 6
DATA_7	Data Pin 7
EN	Enable Pin
RS	Register Select Pin
RW	Read/Write Pin.

Method Summary

Modifier and Type	Method	Description
static LcdPin[]	getAllDataPins()	Get all Data Pins
static LcdPin[]	getAllPins()	Get all LcdPin
static LcdPin[]	getFourBitDataPins()	Get Data Pins used in 4-Bit Operation
String	getName()	Get the Name of the LcdPin
boolean	isRequired()
static LcdPin	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LcdPin[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DATA_0

public static final LcdPin DATA_0

Data Pin 0. Note: Only Used in 8-bit mode.

DATA_1

public static final LcdPin DATA_1

Data Pin 1. Note: Only Used in 8-bit mode.

DATA_2

public static final LcdPin DATA_2

Data Pin 2. Note: Only Used in 8-bit mode.

DATA_3

public static final LcdPin DATA_3

Data Pin 3. Note: Only used in 8-bit mode.

DATA_4

public static final LcdPin DATA_4

Data Pin 4

DATA_5

public static final LcdPin DATA_5

Data Pin 5

DATA_6

public static final LcdPin DATA_6

Data Pin 6

DATA_7

public static final LcdPin DATA_7

Data Pin 7

RS

public static final LcdPin RS

Register Select Pin

EN

public static final LcdPin EN

Enable Pin

RW

public static final LcdPin RW

Read/Write Pin. Note: This pin is rarely used and preferably should be tied to ground and be excluded from the pin map.

BACKLIGHT

public static final LcdPin BACKLIGHT

LCD Backlight Pin

Method Details

values

public static LcdPin[] values()

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

Returns:

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

valueOf

public static LcdPin valueOf(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:

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

NullPointerException - if the argument is null

isRequired

public boolean isRequired()

Returns:

Returns true if the LcdPin is required

getFourBitDataPins

public static LcdPin[] getFourBitDataPins()

Get Data Pins used in 4-Bit Operation

Returns:

Returns all data pins from DATA 4 to DATA 7

getAllDataPins

public static LcdPin[] getAllDataPins()

Get all Data Pins

Returns:

Returns all data pins from DATA 0 to DATA 7

getAllPins

public static LcdPin[] getAllPins()

Get all LcdPin

Returns:

Returns all pins

getName

public String getName()

Get the Name of the LcdPin

Returns:

The name associated with the LcdPin