LCD Library 1.1.7
LCD Library - LCD control class hierarchy library. Drop in replacement for the LiquidCrystal Library.
Public Member Functions
LiquidCrystal_I2C Class Reference

#include <LiquidCrystal_I2C.h>

Inheritance diagram for LiquidCrystal_I2C:
LCD

List of all members.

Public Member Functions

void backlight ()
virtual void begin (uint8_t cols, uint8_t rows, uint8_t charsize=LCD_5x8DOTS)
 LiquidCrystal_I2C (uint8_t lcd_Addr)
 LiquidCrystal_I2C (uint8_t lcd_Addr, uint8_t En, uint8_t Rw, uint8_t Rs)
 LiquidCrystal_I2C (uint8_t lcd_Addr, uint8_t En, uint8_t Rw, uint8_t Rs, uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3)
void noBacklight ()
virtual void send (uint8_t value, uint8_t mode)

Detailed Description

Definition at line 70 of file LiquidCrystal_I2C.h.


Constructor & Destructor Documentation

LiquidCrystal_I2C::LiquidCrystal_I2C ( uint8_t  lcd_Addr)

Class constructor. Initializes class variables and defines the I2C address of the LCD. The constructor does not initialize the LCD.

Parameters:
lcd_Addr[in]I2C address of the IO expansion module. For I2CLCDextraIO, the address can be configured using the on board jumpers.

Definition at line 65 of file LiquidCrystal_I2C.cpp.

LiquidCrystal_I2C::LiquidCrystal_I2C ( uint8_t  lcd_Addr,
uint8_t  En,
uint8_t  Rw,
uint8_t  Rs 
)

Class constructor. Initializes class variables and defines the I2C address of the LCD. The constructor does not initialize the LCD.

Parameters:
lcd_Addr[in]I2C address of the IO expansion module. For I2CLCDextraIO, the address can be configured using the on board jumpers.
En[in]LCD En (Enable) pin connected to the IO extender module
Rw[in]LCD Rw (Read/write) pin connected to the IO extender module
Rs[in]LCD Rs (Reset) pin connected to the IO extender module

Definition at line 81 of file LiquidCrystal_I2C.cpp.

LiquidCrystal_I2C::LiquidCrystal_I2C ( uint8_t  lcd_Addr,
uint8_t  En,
uint8_t  Rw,
uint8_t  Rs,
uint8_t  d0,
uint8_t  d1,
uint8_t  d2,
uint8_t  d3 
)

Class constructor. Initializes class variables and defines the I2C address of the LCD. The constructor does not initialize the LCD.

Parameters:
lcd_Addr[in]I2C address of the IO expansion module. For I2CLCDextraIO, the address can be configured using the on board jumpers.
En[in]LCD En (Enable) pin connected to the IO extender module
Rw[in]LCD Rw (Read/write) pin connected to the IO extender module
Rs[in]LCD Rs (Reset) pin connected to the IO extender module
d0[in]LCD data 0 pin map on IO extender module
d1[in]LCD data 1 pin map on IO extender module
d2[in]LCD data 2 pin map on IO extender module
d3[in]LCD data 3 pin map on IO extender module

Definition at line 98 of file LiquidCrystal_I2C.cpp.


Member Function Documentation

void LiquidCrystal_I2C::backlight ( void  )

Switch-on the LCD backlight. Switch-on the LCD backlight, this method is not supported by the I2CLCDextraIO, it needs an extra IO pin to drive the LCD backlight

Parameters:
none

Definition at line 220 of file LiquidCrystal_I2C.cpp.

void LiquidCrystal_I2C::begin ( uint8_t  cols,
uint8_t  rows,
uint8_t  charsize = LCD_5x8DOTS 
) [virtual]

LCD initialization. Initializes the LCD to a given size (col, row). This methods initializes the LCD, therefore, it MUST be called prior to using any other method from this class or parent class.

Parameters:
cols[in]the number of columns that the display has
rows[in]the number of rows that the display has
charsize[in]size of the characters of the LCD: LCD_5x8DOTS or LCD_5x10DOTS.

Reimplemented from LCD.

Definition at line 143 of file LiquidCrystal_I2C.cpp.

void LiquidCrystal_I2C::noBacklight ( void  )

Switch-off the LCD backlight. Switch-off the LCD backlight, this method is not supported by the I2CLCDextraIO, it needs an extra IO pin to drive the LCD backlight

Parameters:
none

Definition at line 214 of file LiquidCrystal_I2C.cpp.

void LiquidCrystal_I2C::send ( uint8_t  value,
uint8_t  mode 
) [virtual]

Send a particular value to the LCD. Sends a particular value to the LCD for writing to the LCD or as an LCD command.

Users should never call this method.

Parameters:
value[in]Value to send to the LCD.
mode[in]DATA - write to the LCD CGRAM, COMMAND - write a command to the LCD.

Reimplemented from LCD.

Definition at line 234 of file LiquidCrystal_I2C.cpp.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines