LCD parent for all classes. More...

#include <NoiascaLiquidCrystal.h>

Inherited by LiquidCrystal_4bit_base, LiquidCrystal_MCP23017_custompin_base, LiquidCrystal_MCP23S08_base, LiquidCrystal_PCF8574_base, LiquidCrystal_PCF8574_fast_base, LiquidCrystal_Serial_Client, and LiquidCrystal_Wire_base.

Public Member Functions
size_t	writeOld (uint8_t)
	unmodified version of write More...

void	command (uint8_t)
	Send a command to the display, for commands not supported by the library (LCD API) More...

void	clear ()
	Clear the display and place cursor at 0,0 (LCD API) More...

void	home ()
	Home the cursor to 0,0 and leave displayed characters (LCD API) More...

void	setCursor (uint8_t, uint8_t)
	Where Row 0-MAXLINEs, and Col 0-MAXCOLUMNS. More...

void	cursor ()
	Turn the block cursor on. More...

void	noCursor ()
	Turn the block cursor off. More...

void	blink ()
	Turn on the blinking underline cursor (LCD API blink_on) More...

void	noBlink ()
	Turn off the blinking underline cursor (LCD blink_off) More...

void	on ()
	Turn the LCD display on (LCD API optional) More...

void	off ()
	Turn the LCD display off (LCD API optional) More...

void	createChar (const uint8_t, const uint8_t[])
	Load up a custom character (LCD API extend) More...

void	createChar_P (const uint8_t, const uint8_t *)
	Load up a custom character from PROGMEM. More...

void	createUml ()
	creates 3 German Umlauts using special characters 5, 6, and 7 More...

void	setFont (uint8_t value=0)
	sets the used font More...

Detailed Description

LCD parent for all classes.

This is the parent class for all LCD hardware implementations.

Member Function Documentation

◆ writeOld()

size_t LiquidCrystal_dummy::writeOld ( uint8_t value )

unmodified version of write

noiasca: behaves like the original write

◆ command()

void LiquidCrystal_dummy::command ( uint8_t value )

Send a command to the display, for commands not supported by the library (LCD API)

noiasca: this is a "transmit to LCD" with "Register select" = 0 Instruction Register (so something like a data command in contrast with 1 Data Register doesn't exist officially)

◆ clear()

void LiquidCrystal_dummy::clear ( )

Clear the display and place cursor at 0,0 (LCD API)

Clears the display and sets the cursor to 0,0.

◆ home()

void LiquidCrystal_dummy::home ( )

Home the cursor to 0,0 and leave displayed characters (LCD API)

Sets the cursor to 0,0.

◆ setCursor()

void LiquidCrystal_dummy::setCursor	(	uint8_t	newCol,
		uint8_t	newRow
	)

Where Row 0-MAXLINEs, and Col 0-MAXCOLUMNS.

noiasca: every common LCD implementation is column - row, therefore also in this library.

Parameters

newCol	column the new column (0..39)
newRow	the new row (0..3)

◆ cursor()

void LiquidCrystal_dummy::cursor ( )

Turn the block cursor on.

noiasca: LCD API defines this as cursor_on()

◆ noCursor()

void LiquidCrystal_dummy::noCursor ( )

Turn the block cursor off.

noiasca: LCD API definies this as cursor_off()

◆ blink()

void LiquidCrystal_dummy::blink ( )

Turn on the blinking underline cursor (LCD API blink_on)

noiasca: LCD API definies this as cursor_on()

◆ noBlink()

void LiquidCrystal_dummy::noBlink ( )

Turn off the blinking underline cursor (LCD blink_off)

noiasca: LCD API definies this as noBlink()

◆ on()

void LiquidCrystal_dummy::on ( )

Turn the LCD display on (LCD API optional)

If the display does not have an option to turn on/off just turn backlight on/off. In this library it is used to control the display control flag.

◆ off()

void LiquidCrystal_dummy::off ( )

Turn the LCD display off (LCD API optional)

In this library it is used to control the display control flag.

◆ createChar()

void LiquidCrystal_dummy::createChar	(	const uint8_t	address,
		const uint8_t	charmap[]
	)

Load up a custom character (LCD API extend)

original description is: Load up a custom character [0-7] Rows is an array of 7 bytes that contain bitmap To send custom character to display use lcd.write(0-7); See sample sketch on how to implement this.

noiasca: Most libraries use "createChar" instead. So the LCD API name load_custom_character is used as alias only. this library expects a 5x8(!) character - not 7 bytes like the LCD API description.

◆ createChar_P()

void LiquidCrystal_dummy::createChar_P	(	const uint8_t	address,
		const uint8_t *	charmap
	)

Load up a custom character from PROGMEM.

noiasca: this function loads a special character from PROGMEM) this library expects a 5x8(!) character - not 7 bytes like the LCD API description

◆ createUml()

void LiquidCrystal_dummy::createUml ( )

creates 3 German Umlauts using special characters 5, 6, and 7

noiasca: this helper function creates the 3 German Umlauts Ä Ö Ü using special characters. It occupies the characters 5, 6, 7.

◆ setFont()

void LiquidCrystal_dummy::setFont ( uint8_t value = 0 )

sets the used font

some OLED displays support extended commands which is used for this command