LiquidCrystal_I2C Class Reference

HD44780-compatible character display through an I2C backpack. Inherits Print for formatted text. The I2C bus must outlive the display. More...

#include <LiquidCrystal_I2C.hpp>

Inheritance diagram for LiquidCrystal_I2C:

Public Member Functions
	LiquidCrystal_I2C (TwoWire &, uint8_t lcd_Addr, uint8_t lcd_cols, uint8_t lcd_rows)
	Bind the I2C bus, 7-bit backpack address, column count, and row count. Call init() (or oled_init() for OLED mode) before using the display.
void	begin (uint8_t cols, uint8_t rows, uint8_t charsize=LCD_5x8DOTS)
	Configure the display geometry and character cell size; use LCD_5x8DOTS by default.
void	clear ()
	Clear the display and return the hardware cursor home; waits for command completion.
void	home ()
	Return the cursor and display shift to the home position.
void	noDisplay ()
	Turn off visible output while preserving display memory.
void	display ()
	Turn on visible output.
void	noBlink ()
	Disable cursor blinking.
void	blink ()
	Enable cursor blinking.
void	noCursor ()
	Hide the underline cursor.
void	cursor ()
	Show the underline cursor.
void	scrollDisplayLeft ()
	Shift the displayed contents one position left.
void	scrollDisplayRight ()
	Shift the displayed contents one position right.
void	printLeft ()
	Legacy declaration without an implementation in this port; do not call.
void	printRight ()
	Legacy declaration without an implementation in this port; do not call.
void	leftToRight ()
	Advance the cursor left-to-right after each character.
void	rightToLeft ()
	Advance the cursor right-to-left after each character.
void	shiftIncrement ()
	Legacy declaration without an implementation in this port; do not call.
void	shiftDecrement ()
	Legacy declaration without an implementation in this port; do not call.
void	noBacklight ()
	Switch the backpack backlight off.
void	backlight ()
	Switch the backpack backlight on.
void	autoscroll ()
	Enable automatic display shifting as characters are written.
void	noAutoscroll ()
	Disable automatic display shifting as characters are written.
void	createChar (uint8_t, uint8_t[])
	Upload an eight-row custom glyph to slot 0 through 7. The array overload reads RAM; the const char pointer overload reads program memory.
void	createChar (uint8_t location, const char *charmap)
	Upload an eight-row custom glyph to slot 0 through 7. The array overload reads RAM; the const char pointer overload reads program memory.
void	setCursor (uint8_t, uint8_t)
	Set the zero-based column and row using the two arguments, respectively.
virtual size_t	write (uint8_t)
	Send one character byte through Print and return 1.
void	command (uint8_t)
	Send one raw HD44780 command byte.
void	init ()
	Initialize the I2C bus and the configured LCD geometry.
void	oled_init ()
	Select OLED timing, initialize the bus, and configure display geometry.
void	blink_on ()
	Compatibility alias for blink().
void	blink_off ()
	Compatibility alias for noBlink().
void	cursor_on ()
	Compatibility alias for cursor().
void	cursor_off ()
	Compatibility alias for noCursor().
void	setBacklight (uint8_t new_val)
	Enable backlight for nonzero new_val; disable it for zero.
void	load_custom_character (uint8_t char_num, uint8_t *rows)
	Upload eight glyph rows to custom-character slot char_num (0 through 7).
void	printstr (const char[])
	Print a NUL-terminated character string.
uint8_t	status ()
	Unsupported compatibility stub; always returns zero.
void	setContrast (uint8_t new_val)
	Unsupported compatibility stub; does nothing.
uint8_t	keypad ()
	Unsupported compatibility stub; always returns zero.
void	setDelay (int, int)
	Unsupported compatibility stub; does nothing.
void	on ()
	Unsupported compatibility stub; does nothing.
void	off ()
	Unsupported compatibility stub; does nothing.
uint8_t	init_bargraph (uint8_t graphtype)
	Unsupported compatibility stub; always returns zero.
void	draw_horizontal_graph (uint8_t row, uint8_t column, uint8_t len, uint8_t pixel_col_end)
	Unsupported compatibility stub; does nothing.
void	draw_vertical_graph (uint8_t row, uint8_t column, uint8_t len, uint8_t pixel_col_end)
	Unsupported compatibility stub; does nothing.
Public Member Functions inherited from Print
int	getWriteError ()
void	clearWriteError ()
size_t	write (const char *str)
	문자열을 출력합니다.
virtual size_t	write (const uint8_t *buffer, size_t size)
	데이터 배열을 출력합니다.
size_t	write (const char *buffer, size_t size)
	데이터 배열을 출력합니다.
virtual int	availableForWrite ()
size_t	print (const __FlashStringHelper *)
	프로그램 메모리(읽기 전용 플래시) 영역에 저장된 문자열을 출력합니다.
size_t	print (const std::string &)
	문자열을 출력합니다.
size_t	print (const char[])
	NULL로 종료되는 문자열을 출력합니다.
size_t	print (char)
	문자 하나를 출력합니다.
size_t	print (unsigned char, int=DEC)
	부호가 없는(unsigned) 8-byte 정수를 지정한 진수 형태로 출력합니다.
size_t	print (int, int=DEC)
	int 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (unsigned int, int=DEC)
	unsigned int 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (long, int=DEC)
	long 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (unsigned long, int=DEC)
	unsigned long 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (double, int=2)
	double 형 실수를 지정한 소수점 이하 출력 개수로 출력합니다.
size_t	print (const Printable &)
	Printable을 구현한 클래스를 출력합니다.
size_t	println (const __FlashStringHelper *)
	프로그램 메모리(읽기 전용 플래시) 영역에 저장된 문자열과 개행문자(CR+LF)를 출력합니다.
size_t	println (const std::string &s)
	문자열과 개행문자(CR+LF)를 출력합니다.
size_t	println (const char[])
	NULL로 종료되는 문자열과 개행문자(CR+LF)를 출력합니다.
size_t	println (char)
	문자 하나와 개행문자(CR+LF)를 출력합니다.
size_t	println (unsigned char, int=DEC)
	부호가 없는(unsigned) 8-byte 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (int, int=DEC)
	int 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (unsigned int, int=DEC)
	unsigned int 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (long, int=DEC)
	long 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (unsigned long, int=DEC)
	unsigned long 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (double, int=2)
	double 형 실수를 지정한 소수점 이하 출력 개수로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (const Printable &)
	Printable을 구현한 클래스를, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (void)
	개행문자(CR+LF)를 출력합니다.
virtual int	printf (const char *,...)
	printf 출력을 내보냅니다.
virtual void	flush ()

Additional Inherited Members
Protected Member Functions inherited from Print
void	setWriteError (int err=1)

Detailed Description

HD44780-compatible character display through an I2C backpack. Inherits Print for formatted text. The I2C bus must outlive the display.

Member Function Documentation

write()

virtual size_t LiquidCrystal_I2C::write ( uint8_t )

virtual

Send one character byte through Print and return 1.

Implements Print.

---

The documentation for this class was generated from the following file:

• include/dev/LiquidCrystal_I2C.hpp