LCD2004 (RoboLibJ - Javadocs)

java.lang.Object
- io.github.robolib.module.iface.Interface
- - io.github.robolib.module.iface.I2C
  - - io.github.robolib.module.LCD2004

```
public class LCD2004
extends I2C
```
LCD CLass for LCM2004

Author:

noriah

See Also:

http://www.wvshare.com/datasheet/LCD_en_PDF/HD44780.pdf

Nested Class Summary
- Nested classes/interfaces inherited from class io.github.robolib.module.iface.I2C
  I2C.Port
- Nested classes/interfaces inherited from class io.github.robolib.module.iface.Interface
  Interface.InterfaceType

Field Summary

Fields
Modifier and Type	Field and Description
`private static byte`	`BACKLIGHT_MASK`
`private byte`	`backlightStsMask`
`private static byte`	`COMMAND`
`private static byte`	`DATA`
`private static byte`	`DATA_PIN_4_MASK`
`private static byte`	`DATA_PIN_5_MASK`
`private static byte`	`DATA_PIN_6_MASK`
`private static byte`	`DATA_PIN_7_MASK`
`private static java.util.Map<java.lang.Byte,java.lang.Byte>`	`DATA_PIN_MASK_MAP`
`private byte`	`displayControl`
`private byte`	`displayMode`
`private static byte`	`ENABLE_MASK`
`private static byte`	`FOUR_BITS`
`private static double`	`HOME_CLEAR_EXEC`
`private static byte`	`I2C_ADDR`
`private static byte`	`LCD_1LINE`
`private static byte`	`LCD_2LINE`
`private static byte`	`LCD_4BITMODE`
`private static byte`	`LCD_5x10DOTS`
`private static byte`	`LCD_5x8DOTS`
`private static byte`	`LCD_8BITMODE`
`private static byte`	`LCD_BLINK_OFF`
`private static byte`	`LCD_BLINK_ON`
`private static byte`	`LCD_CLEARDISPLAY`
`private static byte`	`LCD_CURSOR_OFF`
`private static byte`	`LCD_CURSOR_ON`
`private static byte`	`LCD_CURSORMOVE`
`private static byte`	`LCD_CURSORSHIFT`
`private static byte`	`LCD_DISPLAY_OFF`
`private static byte`	`LCD_DISPLAY_ON`
`private static byte`	`LCD_DISPLAYCONTROL`
`private static byte`	`LCD_DISPLAYMOVE`
`private static byte`	`LCD_ENTRY_LEFT`
`private static byte`	`LCD_ENTRY_RIGHT`
`private static byte`	`LCD_ENTRY_SHIFT_DECREMENT`
`private static byte`	`LCD_ENTRY_SHIFT_INCREMENT`
`private static byte`	`LCD_ENTRYMODESET`
`private static byte`	`LCD_FUNCTIONSET`
`private static byte`	`LCD_MOVE_LEFT`
`private static byte`	`LCD_MOVE_RIGHT`
`private static byte`	`LCD_RETURNHOME`
`private static byte`	`LCD_SET_CGRAM_ADDR`
`private static byte`	`LCD_SET_DDRAM_ADDR`
`private static byte`	`READ_WRITE_MASK`
`private static byte`	`REGISTER_SELECT_MASK`
`private static byte[]`	`ROW_ADDR`

Fields inherited from class io.github.robolib.module.iface.I2C
m_address, m_port

Fields inherited from class io.github.robolib.module.iface.Interface
m_ifaceType, MAX_ANALOG_IN_CHANNELS, MAX_ANALOG_OUT_CHANNELS, MAX_DIGITAL_CHANNELS, MAX_PWM_CHANNELS, MAX_RELAY_CHANNELS

Constructor Summary

Constructors
Constructor and Description

LCD2004(I2C.Port port)

Constructors
Constructor and Description
`LCD2004(I2C.Port port)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`autoscroll()`
`void`	`backlight()`
`void`	`blink()`
`void`	`clear()`
`private void`	`command(int data)`
`void`	`cursor()`
`void`	`display()`
`private byte`	`get4bits(byte value, byte mode)`
`void`	`home()`
`void`	`leftToRight()`
`void`	`moveCursorLeft()`
`void`	`moveCursorRight()`
`void`	`noAutoscroll()`
`void`	`noBacklight()`
`void`	`noBlink()`
`void`	`noCursor()`
`void`	`noDisplay()`
`void`	`rightToLeft()`
`void`	`scrollDisplayLeft()`
`void`	`scrollDisplayRight()`
`private void`	`send(int data, byte mode)`
`void`	`setCursor(int line, int pos)`
`private void`	`write(int data)`
`void`	`writeString(java.lang.String str)`

Methods inherited from class io.github.robolib.module.iface.I2C
broadcast, checkAddress, free, read, readBit, readBit, readBits, readByte, readBytes, readOnly, readWord, readWords, transaction, verifySensor, write, writeBit, writeBit, writeBits, writeBulk, writeByte, writeBytes, writeWord, writeWords

Methods inherited from class io.github.robolib.module.iface.Interface
allocateMXPPin, checkAnalogInputChannel, checkAnalogOutputChannel, checkDigitalChannel, checkPWMChannel, checkRelayChannel, freeMXPPin, getInterfaceType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

I2C_ADDR
```
private static final byte I2C_ADDR
```
See Also:

Constant Field Values

LCD_CLEARDISPLAY
```
private static final byte LCD_CLEARDISPLAY
```
See Also:

Constant Field Values

LCD_RETURNHOME
```
private static final byte LCD_RETURNHOME
```
See Also:

Constant Field Values

LCD_ENTRYMODESET
```
private static final byte LCD_ENTRYMODESET
```
See Also:

Constant Field Values

LCD_DISPLAYCONTROL
```
private static final byte LCD_DISPLAYCONTROL
```
See Also:

Constant Field Values

LCD_CURSORSHIFT
```
private static final byte LCD_CURSORSHIFT
```
See Also:

Constant Field Values

LCD_FUNCTIONSET
```
private static final byte LCD_FUNCTIONSET
```
See Also:

Constant Field Values

LCD_SET_CGRAM_ADDR
```
private static final byte LCD_SET_CGRAM_ADDR
```
See Also:

Constant Field Values

LCD_SET_DDRAM_ADDR
```
private static final byte LCD_SET_DDRAM_ADDR
```
See Also:

Constant Field Values

LCD_ENTRY_RIGHT
```
private static final byte LCD_ENTRY_RIGHT
```
See Also:

Constant Field Values

LCD_ENTRY_LEFT
```
private static final byte LCD_ENTRY_LEFT
```
See Also:

Constant Field Values

LCD_ENTRY_SHIFT_INCREMENT
```
private static final byte LCD_ENTRY_SHIFT_INCREMENT
```
See Also:

Constant Field Values

LCD_ENTRY_SHIFT_DECREMENT
```
private static final byte LCD_ENTRY_SHIFT_DECREMENT
```
See Also:

Constant Field Values

LCD_DISPLAY_ON
```
private static final byte LCD_DISPLAY_ON
```
See Also:

Constant Field Values

LCD_DISPLAY_OFF
```
private static final byte LCD_DISPLAY_OFF
```
See Also:

Constant Field Values

LCD_CURSOR_ON
```
private static final byte LCD_CURSOR_ON
```
See Also:

Constant Field Values

LCD_CURSOR_OFF
```
private static final byte LCD_CURSOR_OFF
```
See Also:

Constant Field Values

LCD_BLINK_ON
```
private static final byte LCD_BLINK_ON
```
See Also:

Constant Field Values

LCD_BLINK_OFF
```
private static final byte LCD_BLINK_OFF
```
See Also:

Constant Field Values

LCD_DISPLAYMOVE
```
private static final byte LCD_DISPLAYMOVE
```
See Also:

Constant Field Values

LCD_CURSORMOVE
```
private static final byte LCD_CURSORMOVE
```
See Also:

Constant Field Values

LCD_MOVE_RIGHT
```
private static final byte LCD_MOVE_RIGHT
```
See Also:

Constant Field Values

LCD_MOVE_LEFT
```
private static final byte LCD_MOVE_LEFT
```
See Also:

Constant Field Values

LCD_8BITMODE
```
private static final byte LCD_8BITMODE
```
See Also:

Constant Field Values

LCD_4BITMODE
```
private static final byte LCD_4BITMODE
```
See Also:

Constant Field Values

LCD_2LINE
```
private static final byte LCD_2LINE
```
See Also:

Constant Field Values

LCD_1LINE
```
private static final byte LCD_1LINE
```
See Also:

Constant Field Values

LCD_5x10DOTS
```
private static final byte LCD_5x10DOTS
```
See Also:

Constant Field Values

LCD_5x8DOTS
```
private static final byte LCD_5x8DOTS
```
See Also:

Constant Field Values

FOUR_BITS
```
private static final byte FOUR_BITS
```
See Also:

Constant Field Values

HOME_CLEAR_EXEC
```
private static final double HOME_CLEAR_EXEC
```
See Also:

Constant Field Values

REGISTER_SELECT_MASK
```
private static final byte REGISTER_SELECT_MASK
```
See Also:

Constant Field Values

READ_WRITE_MASK
```
private static final byte READ_WRITE_MASK
```
See Also:

Constant Field Values

ENABLE_MASK
```
private static final byte ENABLE_MASK
```
See Also:

Constant Field Values

BACKLIGHT_MASK
```
private static final byte BACKLIGHT_MASK
```
See Also:

Constant Field Values

DATA_PIN_4_MASK
```
private static final byte DATA_PIN_4_MASK
```
See Also:

Constant Field Values

DATA_PIN_5_MASK
```
private static final byte DATA_PIN_5_MASK
```
See Also:

Constant Field Values

DATA_PIN_6_MASK
```
private static final byte DATA_PIN_6_MASK
```
See Also:

Constant Field Values

DATA_PIN_7_MASK
```
private static final byte DATA_PIN_7_MASK
```
See Also:

Constant Field Values

COMMAND
```
private static final byte COMMAND
```
See Also:

Constant Field Values

DATA
```
private static final byte DATA
```
See Also:

Constant Field Values

DATA_PIN_MASK_MAP

private static final java.util.Map<java.lang.Byte,java.lang.Byte> DATA_PIN_MASK_MAP

ROW_ADDR
```
private static final byte[] ROW_ADDR
```

displayControl
```
private byte displayControl
```

displayMode
```
private byte displayMode
```

backlightStsMask
```
private byte backlightStsMask
```

Constructor Detail
- LCD2004
```
public LCD2004(I2C.Port port)
```

Method Detail

writeString

public void writeString(java.lang.String str)

clear
```
public void clear()
```

home
```
public void home()
```

setCursor

public void setCursor(int line,
                      int pos)

noDisplay
```
public void noDisplay()
```

display
```
public void display()
```

noCursor
```
public void noCursor()
```

cursor
```
public void cursor()
```

noBlink
```
public void noBlink()
```

blink
```
public void blink()
```

scrollDisplayLeft
```
public void scrollDisplayLeft()
```

scrollDisplayRight
```
public void scrollDisplayRight()
```

leftToRight
```
public void leftToRight()
```

rightToLeft
```
public void rightToLeft()
```

moveCursorRight
```
public void moveCursorRight()
```

moveCursorLeft
```
public void moveCursorLeft()
```

autoscroll
```
public void autoscroll()
```

noAutoscroll
```
public void noAutoscroll()
```

backlight
```
public void backlight()
```

noBacklight
```
public void noBacklight()
```

write
```
private void write(int data)
```

command
```
private void command(int data)
```

send

private void send(int data,
                  byte mode)

get4bits

private byte get4bits(byte value,
                      byte mode)

Class LCD2004

Nested Class Summary

Nested classes/interfaces inherited from class io.github.robolib.module.iface.I2C

Nested classes/interfaces inherited from class io.github.robolib.module.iface.Interface

Field Summary

Fields inherited from class io.github.robolib.module.iface.I2C

Fields inherited from class io.github.robolib.module.iface.Interface

Constructor Summary

Method Summary

Methods inherited from class io.github.robolib.module.iface.I2C

Methods inherited from class io.github.robolib.module.iface.Interface

Methods inherited from class java.lang.Object

Field Detail

I2C_ADDR

LCD_CLEARDISPLAY

LCD_RETURNHOME

LCD_ENTRYMODESET

LCD_DISPLAYCONTROL

LCD_CURSORSHIFT

LCD_FUNCTIONSET

LCD_SET_CGRAM_ADDR

LCD_SET_DDRAM_ADDR

LCD_ENTRY_RIGHT

LCD_ENTRY_LEFT

LCD_ENTRY_SHIFT_INCREMENT

LCD_ENTRY_SHIFT_DECREMENT

LCD_DISPLAY_ON

LCD_DISPLAY_OFF

LCD_CURSOR_ON

LCD_CURSOR_OFF

LCD_BLINK_ON

LCD_BLINK_OFF

LCD_DISPLAYMOVE

LCD_CURSORMOVE

LCD_MOVE_RIGHT

LCD_MOVE_LEFT

LCD_8BITMODE

LCD_4BITMODE

LCD_2LINE

LCD_1LINE

LCD_5x10DOTS

LCD_5x8DOTS

FOUR_BITS

HOME_CLEAR_EXEC

REGISTER_SELECT_MASK

READ_WRITE_MASK

ENABLE_MASK

BACKLIGHT_MASK

DATA_PIN_4_MASK

DATA_PIN_5_MASK

DATA_PIN_6_MASK

DATA_PIN_7_MASK

COMMAND

DATA

DATA_PIN_MASK_MAP

ROW_ADDR

displayControl

displayMode

backlightStsMask

Constructor Detail

LCD2004

Method Detail

writeString

clear

home

setCursor

noDisplay

display

noCursor

cursor

noBlink

blink

scrollDisplayLeft

scrollDisplayRight

leftToRight

rightToLeft

moveCursorRight

moveCursorLeft

autoscroll

noAutoscroll