LCD Library 1.2.0
LCD Library - LCD control class hierarchy library. Drop in replacement for the LiquidCrystal Library.
Public Member Functions | Protected Attributes
LCD Class Reference

#include <LCD.h>

Inheritance diagram for LCD:
LiquidCrystal LiquidCrystal_I2C LiquidCrystal_SR LiquidCrystal_SR_LCD3

List of all members.

Public Member Functions

void autoscroll ()
virtual void begin (uint8_t cols, uint8_t rows, uint8_t charsize=LCD_5x8DOTS)
void blink ()
void clear ()
void command (uint8_t value)
void createChar (uint8_t location, uint8_t charmap[])
void cursor ()
void display ()
void home ()
 LCD ()
void leftToRight ()
void moveCursorLeft ()
void moveCursorRight ()
void noAutoscroll ()
void noBlink ()
void noCursor ()
void noDisplay ()
void rightToLeft ()
void scrollDisplayLeft ()
void scrollDisplayRight ()
virtual void send (uint8_t value, uint8_t mode)
virtual void setBacklight (uint8_t mode)
virtual void setBacklightPin (uint8_t pin)
void setCursor (uint8_t col, uint8_t row)
virtual void write (uint8_t value)

Protected Attributes

uint8_t _cols
uint8_t _displaycontrol
uint8_t _displayfunction
uint8_t _displaymode
uint8_t _numlines

Detailed Description

Definition at line 140 of file LCD.h.


Constructor & Destructor Documentation

LCD::LCD ( )

LiquidCrystal abstract constructor. LiquidCrystal class abstract constructor needed to create the base abstract class.

Definition at line 48 of file LCD.cpp.


Member Function Documentation

void LCD::autoscroll ( void  )

Turns on automatic scrolling of the LCD. Turns on automatic scrolling of the LCD. This causes each character output to the display to push previous characters over by one space. If the current text direction is left-to-right (the default), the display scrolls to the left; if the current direction is right-to-left, the display scrolls to the right. This has the effect of outputting each new character to the same location on the LCD.

Parameters:
none

Definition at line 268 of file LCD.cpp.

void LCD::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.

This method is pure abstract, it is dependent on each derived class from this base class to implement the internals of how the LCD is initialized and configured.

Parameters:
cols[in]the number of columns that the display has
rows[in]the number of rows that the display has

Reimplemented in LiquidCrystal_I2C.

Definition at line 75 of file LCD.cpp.

void LCD::blink ( )

Display the cursor of the LCD. Display the blinking LCD cursor. If used in combination with the cursor() function, the result will depend on the particular display.

Parameters:
none

Definition at line 223 of file LCD.cpp.

void LCD::clear ( )

Clears the LCD. Clears the LCD screen and positions the cursor in the upper-left corner.

This operation is time consuming for the LCD.

Parameters:
none

Definition at line 156 of file LCD.cpp.

void LCD::command ( uint8_t  value)

Send a command to the LCD. This method sends a command to the LCD by setting the Register select line of the LCD.

This command shouldn't be used to drive the LCD, only to implement any other feature that is not available on this library.

Parameters:
value[in]Command value to send to the LCD.

Definition at line 298 of file LCD.cpp.

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

Creates a custom character for use on the LCD. Create a custom character (glyph) for use on the LCD. Most chipsets only support up to eight characters of 5x8 pixels. Therefore, this methods has been limited to locations (numbered 0 to 7).

The appearance of each custom character is specified by an array of eight bytes, one for each row. The five least significant bits of each byte determine the pixels in that row. To display a custom character on screen, write()/print() its number, i.e. lcd.print (char(x)); // Where x is 0..7.

Parameters:
location[in]LCD memory location of the character to create (0 to 7)
charmap[in]the bitmap array representing each row of the character.

Definition at line 282 of file LCD.cpp.

void LCD::cursor ( )

Display the LCD cursor. Display the LCD cursor: an underscore (line) at the location where the next character will be written.

Parameters:
none

Definition at line 210 of file LCD.cpp.

void LCD::display ( )

Turns on the LCD display. Turns on the LCD display, after it's been turned off with noDisplay(). This will restore the text (and cursor location) that was on the display prior to calling noDisplay().

Parameters:
none

Definition at line 198 of file LCD.cpp.

void LCD::home ( )

Sets the cursor to the upper-left corner. Positions the cursor in the upper-left of the LCD. That is, use that location in outputting subsequent text to the display. To also clear the display, use the clear() function instead.

This operation is time consuming for the LCD.

Parameters:
none

Definition at line 162 of file LCD.cpp.

void LCD::leftToRight ( void  )

Set the direction for text written to the LCD to left-to-right. Set the direction for text written to the LCD to left-to-right. All subsequent characters written to the display will go from left to right, but does not affect previously-output text.

This is the default configuration.

Parameters:
none

Definition at line 241 of file LCD.cpp.

void LCD::moveCursorLeft ( void  )

Moves the cursor one space to the left.

Parameters:
none

Definition at line 261 of file LCD.cpp.

void LCD::moveCursorRight ( void  )

Moves the cursor one space to the right.

Parameters:
none

Definition at line 255 of file LCD.cpp.

void LCD::noAutoscroll ( void  )

Turns off automatic scrolling of the LCD. Turns off automatic scrolling of the LCD, this is the default configuration of the LCD.

Parameters:
none

Definition at line 275 of file LCD.cpp.

void LCD::noBlink ( )

Turns off the blinking of the LCD cursor.

Parameters:
none

Definition at line 217 of file LCD.cpp.

void LCD::noCursor ( )

Hides the LCD cursor.

Parameters:
none

Definition at line 205 of file LCD.cpp.

void LCD::noDisplay ( )

Turns off the LCD display. Turns off the LCD display, without losing the text currently being displayed on it.

Parameters:
none

Definition at line 192 of file LCD.cpp.

void LCD::rightToLeft ( void  )

Set the direction for text written to the LCD to right-to-left. Set the direction for text written to the LCD to right-to-left. All subsequent characters written to the display will go from right to left, but does not affect previously-output text.

left-to-right is the default configuration.

Parameters:
none

Definition at line 248 of file LCD.cpp.

void LCD::scrollDisplayLeft ( void  )

Scrolls the contents of the display (text and cursor) one space to the left.

Parameters:
none

Definition at line 230 of file LCD.cpp.

void LCD::scrollDisplayRight ( void  )

Scrolls the contents of the display (text and cursor) one space to the right.

Parameters:
none

Definition at line 235 of file LCD.cpp.

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

Send a particular value to the LCD. Sends a particular value to the LCD. This is a pure abstract method, therefore, it is implementation dependent of each derived class how to physically write to the LCD.

Users should never call this method.

Parameters:
value[in]Value to send to the LCD.
Returns:
mode LOW - write to the LCD CGRAM, HIGH - write a command to the LCD.

Reimplemented in LiquidCrystal, LiquidCrystal_I2C, LiquidCrystal_SR, and LiquidCrystal_SR_LCD3.

Definition at line 438 of file LCD.h.

virtual void LCD::setBacklight ( uint8_t  mode) [inline, virtual]

Switch-on/off the LCD backlight. Switch-on/off the LCD backlight. The setBacklightPin has to be called before setting the backlight for this method to work.

See also:
setBacklightPin. This method is device dependent and can be programmed on each subclass. An empty function call is provided that does nothing.
Parameters:
mode,:backlight mode (HIGH|LOW)

Reimplemented in LiquidCrystal, LiquidCrystal_I2C, and LiquidCrystal_SR.

Definition at line 393 of file LCD.h.

virtual void LCD::setBacklightPin ( uint8_t  pin) [inline, virtual]

Sets the pin to control the backlight. Sets the pin in the device to control the backlight. This method is device dependent and can be programmed on each subclass. An empty function call is provided that does nothing.

Parameters:
mode,:backlight mode (HIGH|LOW)

Reimplemented in LiquidCrystal, LiquidCrystal_I2C, and LiquidCrystal_SR.

Definition at line 404 of file LCD.h.

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

Position the LCD cursor. Sets the position of the LCD cursor. Set the location at which subsequent text written to the LCD will be displayed.

Parameters:
col[in]LCD column
row[in]LCD row - line.

Definition at line 168 of file LCD.cpp.

void LCD::write ( uint8_t  value) [virtual]

Writes to the LCD. This method writes character to the LCD in the current cursor position.

This is the virtual write method, implemented in the Print class, therefore all Print class methods will end up calling this method.

Parameters:
value[in]Value to write to the LCD.

Definition at line 304 of file LCD.cpp.


Member Data Documentation

uint8_t LCD::_cols [protected]

Definition at line 458 of file LCD.h.

uint8_t LCD::_displaycontrol [protected]

Definition at line 454 of file LCD.h.

uint8_t LCD::_displayfunction [protected]

Definition at line 452 of file LCD.h.

uint8_t LCD::_displaymode [protected]

Definition at line 456 of file LCD.h.

uint8_t LCD::_numlines [protected]

Definition at line 457 of file LCD.h.


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