#include <LiquidCrystal_I2C_bm.h>

Inheritance diagram for LiquidCrystal_I2C:

Collaboration diagram for LiquidCrystal_I2C:

Public Member Functions
	LiquidCrystal_I2C (uint8_t i2c_Addr, uint8_t lcd_cols, uint8_t lcd_rows)
	Constructior. More...

void	begin (uint8_t cols, uint8_t rows, uint8_t charsize=LCD_5x8DOTS)

void	clear ()

void	home ()

void	noDisplay ()
	Turn the display on/off (quickly) More...

void	display ()

void	noBlink ()
	Turn on and off the blinking cursor. More...

void	blink ()

void	noCursor ()
	Turns the underline cursor on/off. More...

void	cursor ()

void	scrollDisplayLeft ()

void	scrollDisplayRight ()

void	printLeft ()

void	printRight ()

void	leftToRight ()
	This is for text that flows Left to Right. More...

void	rightToLeft ()
	This is for text that flows Right to Left. More...

void	shiftIncrement ()

void	shiftDecrement ()

void	noBacklight ()
	Turn the (optional) backlight off/on. More...

void	backlight ()

void	autoscroll ()
	This will 'right justify' text from the cursor. More...

void	noAutoscroll ()
	This will 'left justify' text from the cursor. More...

void	createChar (uint8_t, uint8_t[])
	Allows us to fill the first 8 CGRAM locations with custom characters. More...

void	setCursor (uint8_t, uint8_t)

void	init ()

size_t	write (uint8_t)

Static Public Attributes
static constexpr uint8_t	LCD_5x10DOTS = 0x04U

static constexpr uint8_t	LCD_5x8DOTS = 0x00

Detailed Description

Definition at line 15 of file LiquidCrystal_I2C_bm.h.

Constructor & Destructor Documentation

◆ LiquidCrystal_I2C()

LiquidCrystal_I2C::LiquidCrystal_I2C	(	uint8_t	i2c_Addr,
		uint8_t	lcd_cols,
		uint8_t	lcd_rows
	)

Constructior.

Parameters

i2c_Addr	I2C address
lcd_cols	# of columns
lcd_rows	# of rows

When the display powers up, it is configured as follows:

Display clear
Function set: DL = 1; 8-bit interface data N = 0; 1-line display F = 0; 5x8 dot character font
Display on/off control: D = 0; Display off C = 0; Cursor off B = 0; Blinking off
Entry mode set: I/D = 1; Increment by 1 S = 0; No shift

Note, however, that resetting the Arduino doesn't reset the LCD, so we can't assume that its in that state when a sketch starts (and the LiquidCrystal constructor is called).

Definition at line 79 of file LiquidCrystal_I2C_bm.cpp.

Member Function Documentation

◆ autoscroll()

void LiquidCrystal_I2C::autoscroll ( void )

This will 'right justify' text from the cursor.

Definition at line 240 of file LiquidCrystal_I2C_bm.cpp.

◆ backlight()

void LiquidCrystal_I2C::backlight ( void )

Definition at line 273 of file LiquidCrystal_I2C_bm.cpp.

◆ begin()

void LiquidCrystal_I2C::begin	(	uint8_t	cols,
		uint8_t	rows,
		uint8_t	charsize = `LCD_5x8DOTS`
	)

Definition at line 96 of file LiquidCrystal_I2C_bm.cpp.

◆ blink()

void LiquidCrystal_I2C::blink ( )

Definition at line 207 of file LiquidCrystal_I2C_bm.cpp.

◆ clear()

void LiquidCrystal_I2C::clear ( )

Definition at line 155 of file LiquidCrystal_I2C_bm.cpp.

◆ createChar()

void LiquidCrystal_I2C::createChar	(	uint8_t	location,
		uint8_t	charmap[]
	)

Allows us to fill the first 8 CGRAM locations with custom characters.

Definition at line 257 of file LiquidCrystal_I2C_bm.cpp.

◆ cursor()

void LiquidCrystal_I2C::cursor ( )

Definition at line 194 of file LiquidCrystal_I2C_bm.cpp.

◆ display()

void LiquidCrystal_I2C::display ( )

Definition at line 181 of file LiquidCrystal_I2C_bm.cpp.

◆ home()

void LiquidCrystal_I2C::home ( )

Definition at line 160 of file LiquidCrystal_I2C_bm.cpp.

◆ init()

void LiquidCrystal_I2C::init ( )

Definition at line 86 of file LiquidCrystal_I2C_bm.cpp.

◆ leftToRight()

void LiquidCrystal_I2C::leftToRight ( void )

This is for text that flows Left to Right.

Definition at line 224 of file LiquidCrystal_I2C_bm.cpp.

◆ noAutoscroll()

void LiquidCrystal_I2C::noAutoscroll ( void )

This will 'left justify' text from the cursor.

Definition at line 248 of file LiquidCrystal_I2C_bm.cpp.

◆ noBacklight()

void LiquidCrystal_I2C::noBacklight ( void )

Turn the (optional) backlight off/on.

Definition at line 268 of file LiquidCrystal_I2C_bm.cpp.

◆ noBlink()

void LiquidCrystal_I2C::noBlink ( )

Turn on and off the blinking cursor.

Definition at line 202 of file LiquidCrystal_I2C_bm.cpp.

◆ noCursor()

void LiquidCrystal_I2C::noCursor ( )

Turns the underline cursor on/off.

Definition at line 189 of file LiquidCrystal_I2C_bm.cpp.

◆ noDisplay()

void LiquidCrystal_I2C::noDisplay ( )

Turn the display on/off (quickly)

Definition at line 176 of file LiquidCrystal_I2C_bm.cpp.

◆ printLeft()

void LiquidCrystal_I2C::printLeft ( )

◆ printRight()

void LiquidCrystal_I2C::printRight ( )

◆ rightToLeft()

void LiquidCrystal_I2C::rightToLeft ( void )

This is for text that flows Right to Left.

Definition at line 232 of file LiquidCrystal_I2C_bm.cpp.

◆ scrollDisplayLeft()

void LiquidCrystal_I2C::scrollDisplayLeft ( void )

Definition at line 213 of file LiquidCrystal_I2C_bm.cpp.

◆ scrollDisplayRight()

void LiquidCrystal_I2C::scrollDisplayRight ( void )

Definition at line 217 of file LiquidCrystal_I2C_bm.cpp.

◆ setCursor()

void LiquidCrystal_I2C::setCursor	(	uint8_t	col,
		uint8_t	row
	)

Definition at line 165 of file LiquidCrystal_I2C_bm.cpp.

◆ shiftDecrement()

void LiquidCrystal_I2C::shiftDecrement ( )

◆ shiftIncrement()

void LiquidCrystal_I2C::shiftIncrement ( )

◆ write()

size_t LiquidCrystal_I2C::write ( uint8_t value )

Definition at line 49 of file LiquidCrystal_I2C_bm.cpp.

Member Data Documentation

◆ LCD_5x10DOTS

constexpr uint8_t LiquidCrystal_I2C::LCD_5x10DOTS = 0x04U

staticconstexpr

Definition at line 18 of file LiquidCrystal_I2C_bm.h.

◆ LCD_5x8DOTS

constexpr uint8_t LiquidCrystal_I2C::LCD_5x8DOTS = 0x00