com.diozero

Class I2CLcd

java.lang.Object

com.diozero.I2CLcd

All Implemented Interfaces:

Closeable, AutoCloseable

public class I2CLcd
extends Object
implements Closeable

Generic I2C LCD support, code based on this Raspberry-Pi Spy article, Python code: https://bitbucket.org/MattHawkinsUK/rpispy-misc/raw/master/python/lcd_i2c.py

Another source of information: https://gist.github.com/DenisFromHR/cc863375a6e19dce359d.

Datasheet for HD44780: https://www.sparkfun.com/datasheets/LCD/HD44780.pdf.

Constructor Summary

Constructors

Constructor and Description
I2CLcd(int columns, int rows)
I2CLcd(int controller, int deviceAddress, ByteOrder order, int columns, int rows)

Method Summary

Modifier and Type	Method and Description
void	addText(byte code)
void	addText(char character)
void	addText(String text)
void	clear() Clear the display
void	close()
void	createChar(int location, byte[] charMap)
void	cursorOrDisplayShift(boolean displayShift, boolean shiftRight) Cursor or display shift shifts the cursor position or display to the right or left without writing or reading display data.
void	displayControl(boolean displayOn, boolean cursorEnabled, boolean blinkEnabled)
void	entryModeControl(boolean increment, boolean shiftDisplay) Control text entry mode.
int	getColumnCount()
int	getRowCount()
boolean	isBacklightOn()
boolean	isBlinkEnabled()
boolean	isCursorEnabled()
boolean	isIncrementOn()
boolean	isShiftDisplayOn()
void	moveCursorLeft()
void	moveCursorRight()
void	returnHome() Return the cursor to the home position
void	setBacklightOn(boolean backlight)
void	setCharacter(int column, int row, char character)
void	setCursorPosition(int column, int row)
void	setText(int row, String text) Send string to display
void	shiftDisplayLeft()
void	shiftDisplayRight()

Methods inherited from class java.lang.Object

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

Constructor Detail

I2CLcd

public I2CLcd(int columns,
              int rows)

I2CLcd

public I2CLcd(int controller,
              int deviceAddress,
              ByteOrder order,
              int columns,
              int rows)

Method Detail

getColumnCount

public int getColumnCount()

getRowCount

public int getRowCount()

isBacklightOn

public boolean isBacklightOn()

setBacklightOn

public void setBacklightOn(boolean backlight)

setCursorPosition

public void setCursorPosition(int column,
                              int row)

setCharacter

public void setCharacter(int column,
                         int row,
                         char character)

setText

public void setText(int row,
                    String text)

Send string to display

Parameters:

row - Row number (starts at 0)

text - Text to display

addText

public void addText(String text)

addText

public void addText(char character)

addText

public void addText(byte code)

clear

public void clear()

Clear the display

returnHome

public void returnHome()

Return the cursor to the home position

entryModeControl

public void entryModeControl(boolean increment,
                             boolean shiftDisplay)

Control text entry mode.

Parameters:

increment - The cursor or blinking moves to the right when incremented by 1 and to the left when decremented by 1.

shiftDisplay - Shifts the entire display either to the right (I/D = 0) or to the left (I/D = 1) when true. The display does not shift if false. If true, it will seem as if the cursor does not move but the display does.

isIncrementOn

public boolean isIncrementOn()

isShiftDisplayOn

public boolean isShiftDisplayOn()

displayControl

public void displayControl(boolean displayOn,
                           boolean cursorEnabled,
                           boolean blinkEnabled)

isCursorEnabled

public boolean isCursorEnabled()

isBlinkEnabled

public boolean isBlinkEnabled()

cursorOrDisplayShift

public void cursorOrDisplayShift(boolean displayShift,
                                 boolean shiftRight)

Cursor or display shift shifts the cursor position or display to the right or left without writing or reading display data. This function is used to correct or search the display. In a 2-line display, the cursor moves to the second line when it passes the 40th digit of the first line. Note that the first and second line displays will shift at the same time. When the displayed data is shifted repeatedly each line moves only horizontally. The second line display does not shift into the first line position.

Parameters:

displayShift - Shift the display if true, the cursor if false.

shiftRight - Shift to the right if true, to the left if false.

shiftDisplayRight

public void shiftDisplayRight()

shiftDisplayLeft

public void shiftDisplayLeft()

moveCursorRight

public void moveCursorRight()

moveCursorLeft

public void moveCursorLeft()

createChar

public void createChar(int location,
                       byte[] charMap)

close

public void close()
           throws RuntimeIOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

RuntimeIOException