LCD_I2C-C.cpp File Reference

C wrappers for the Fast LCD I2C driver. More...

Macros
#define	Default_Addr   0x27
#define	MAX_CHARS   20
#define	MAX_LINES   4

Functions
void	nullCheck () noexcept
void	lcd_init (byte address, byte columns, byte rows, i2c_inst *I2C) noexcept
void	lcd_clear (void) noexcept
	Clear the display. More...
void	lcd_home (void) noexcept
	"Home" the display. More...
void	lcd_setCursor (byte line, byte position) noexcept
	Move the input cursor to a location on the screen. More...
void	lcd_writeString (const char s[]) noexcept
	Output a string to the screen. Naming is more in the style of the Pico SDK, and the Enable_Buffering parameter can be utilized. More...
void	lcd_writeChar (byte c) noexcept
	Output a character to the screen. More...
void	lcd_writeBuffer (const uint8_t buffer[], size_t size) noexcept
void	lcd_backlight (void) noexcept
	Turn on the display backlight. More...
void	lcd_noBacklight () noexcept
	Turn off the display backlight More...
void	lcd_cursor (void) noexcept
	Display the underline cursor at the current cursor location. More...
void	lcd_noCursor (void) noexcept
	Hides the underline cursor at the current cursor location. More...
void	lcd_blink (void) noexcept
	Display the blinking inverted cursor at the current cursor location. More...
void	lcd_noBlink (void) noexcept
	Disable the blinking inverted cursor at the current cursor location. More...
void	lcd_display (void) noexcept
	Turns the display on without modifying data on it. More...
void	lcd_noDisplay (void) noexcept
	Turns the display off without modifying data on it. More...
void	lcd_scrollDisplayLeft (void) noexcept
	Scrolls the display and cursor one position to the left. home() will restore it to its original position. More...
void	lcd_scrollDisplayRight (void) noexcept
	Scrolls the display and cursor one position to the right. home() will restore it to its original position. More...
void	lcd_autoscroll (void) noexcept
	Turns on automatic scrolling of the display. More...
void	lcd_noAutoscroll (void) noexcept
	Turns off automatic scrolling of the display. More...
void	lcd_rightToLeft (void) noexcept
	Sets the text direction to right to left. Each character output advances the cursor one position to the left. More...
void	lcd_leftToRight (void) noexcept
	Sets the text direction to left to right. Each character output advances the cursor one position to the right. This is the default condition. More...
void	lcd_createChar (byte charnum, const byte char_map[]) noexcept
	Create a custom character. More...

Variables
LCD_I2C *	lcd = NULL

Detailed Description

C wrappers for the Fast LCD I2C driver.

Author

Keith Standiford

Version

1.0

Date

2022-04-10

Copyright

Copyright (c) 2022 Keith Standiford. All rights reserved.

These are the wrappers to allow the Fast LCD I2C driver (which is written in C++) to be used from a C program. The interface is simplified, and the buffering commands are not available since C does not allow optional arguments. None the less, this allows users who have not made the transition to C++ to still enjoy substantial speed improvements over most other drivers.

Use of the C++ version is encouraged.

Macro Definition Documentation

Default_Addr

#define Default_Addr   0x27

MAX_CHARS

#define MAX_CHARS   20

MAX_LINES

#define MAX_LINES   4

Function Documentation

lcd_init()

void lcd_init ( byte  address, byte  columns, byte  rows, i2c_inst *  I2C  )

noexcept

lcd_writeBuffer()

void lcd_writeBuffer ( const uint8_t  buffer[], size_t  size  )

noexcept

nullCheck()

void nullCheck ( )

noexcept

Variable Documentation

lcd

LCD_I2C* lcd = NULL