![]() |
LCD Library 1.1.7
LCD Library - LCD control class hierarchy library. Drop in replacement for the LiquidCrystal Library.
|
00001 // --------------------------------------------------------------------------- 00002 // Created by Francisco Malpartida on 20/08/11. 00003 // Copyright 2011 - Under creative commons license 3.0: 00004 // Attribution-ShareAlike CC BY-SA 00005 // 00006 // This software is furnished "as is", without technical support, and with no 00007 // warranty, express or implied, as to its usefulness for any purpose. 00008 // 00009 // Thread Safe: No 00010 // Extendable: Yes 00011 // 00012 // @file LiquidCrystal.h 00013 // This file implements a basic liquid crystal library that comes as standard 00014 // in the Arduino SDK. 00015 // 00016 // @brief 00017 // This is a basic implementation of the LiquidCrystal library of the 00018 // Arduino SDK. This library is a refactored version of the one supplied 00019 // in the Arduino SDK in such a way that it simplifies its extension 00020 // to support other mechanism to communicate to LCDs such as I2C, Serial. 00021 // The original library has been reworked in such a way that this will be 00022 // the base class implementing all generic methods to command an LCD based 00023 // on the Hitachi HD44780 and compatible chipsets. 00024 // 00025 // This base class is a pure abstract class and needs to be extended. As reference, 00026 // it has been extended to drive 4 and 8 bit mode control, LCDs and I2C extension 00027 // backpacks such as the I2CLCDextraIO using the PCF8574* I2C IO Expander ASIC. 00028 // 00029 // 00030 // This library is only compatible with Arduino's SDK version 1.0 00031 // 00032 // @version API 1.0.0 00033 // 00034 // 00035 // @author F. Malpartida - fmalpartida@gmail.com 00036 // --------------------------------------------------------------------------- 00037 #ifndef _LCD_H_ 00038 #define _LCD_H_ 00039 #include <inttypes.h> 00040 #include <Print.h> 00041 00050 //#define FAST_MODE 00051 00061 inline static void waitUsec ( uint16_t uSec ) 00062 { 00063 #ifndef FAST_MODE 00064 delayMicroseconds ( uSec ); 00065 #endif // FAST_MODE 00066 } 00067 00068 00076 // LCD Commands 00077 // --------------------------------------------------------------------------- 00078 #define LCD_CLEARDISPLAY 0x01 00079 #define LCD_RETURNHOME 0x02 00080 #define LCD_ENTRYMODESET 0x04 00081 #define LCD_DISPLAYCONTROL 0x08 00082 #define LCD_CURSORSHIFT 0x10 00083 #define LCD_FUNCTIONSET 0x20 00084 #define LCD_SETCGRAMADDR 0x40 00085 #define LCD_SETDDRAMADDR 0x80 00086 00087 // flags for display entry mode 00088 // --------------------------------------------------------------------------- 00089 #define LCD_ENTRYRIGHT 0x00 00090 #define LCD_ENTRYLEFT 0x02 00091 #define LCD_ENTRYSHIFTINCREMENT 0x01 00092 #define LCD_ENTRYSHIFTDECREMENT 0x00 00093 00094 // flags for display on/off and cursor control 00095 // --------------------------------------------------------------------------- 00096 #define LCD_DISPLAYON 0x04 00097 #define LCD_DISPLAYOFF 0x00 00098 #define LCD_CURSORON 0x02 00099 #define LCD_CURSOROFF 0x00 00100 #define LCD_BLINKON 0x01 00101 #define LCD_BLINKOFF 0x00 00102 00103 // flags for display/cursor shift 00104 // --------------------------------------------------------------------------- 00105 #define LCD_DISPLAYMOVE 0x08 00106 #define LCD_CURSORMOVE 0x00 00107 #define LCD_MOVERIGHT 0x04 00108 #define LCD_MOVELEFT 0x00 00109 00110 // flags for function set 00111 // --------------------------------------------------------------------------- 00112 #define LCD_8BITMODE 0x10 00113 #define LCD_4BITMODE 0x00 00114 #define LCD_2LINE 0x08 00115 #define LCD_1LINE 0x00 00116 #define LCD_5x10DOTS 0x04 00117 #define LCD_5x8DOTS 0x00 00118 00119 #define LCD_4BIT 1 00120 #define LCD_8BIT 0 00121 00122 // Define COMMAND and DATA LCD Rs 00123 // --------------------------------------------------------------------------- 00124 #define COMMAND 0 00125 #define DATA 1 00126 00133 #define HOME_CLEAR_EXEC 2000 00134 00135 class LCD : public Print 00136 { 00137 public: 00138 00145 LCD ( ); 00146 00161 #if (ARDUINO < 100) 00162 virtual void begin(uint8_t cols, uint8_t rows, uint8_t charsize = LCD_5x8DOTS) { }; 00163 #else 00164 virtual void begin(uint8_t cols, uint8_t rows, uint8_t charsize = LCD_5x8DOTS) = 0; 00165 #endif 00166 00177 void clear(); 00178 00190 void home(); 00191 00200 void noDisplay(); 00201 00211 void display(); 00212 00219 void noBlink(); 00220 00229 void blink(); 00230 00237 void noCursor(); 00238 00247 void cursor(); 00248 00256 void scrollDisplayLeft(); 00257 00265 void scrollDisplayRight(); 00266 00278 void leftToRight(); 00279 00291 void rightToLeft(); 00292 00306 void autoscroll(); 00307 00316 void noAutoscroll(); 00317 00334 void createChar(uint8_t location, uint8_t charmap[]); 00335 00345 void setCursor(uint8_t col, uint8_t row); 00346 00347 00359 void command(uint8_t value); 00360 00372 #if (ARDUINO < 100) 00373 virtual void write(uint8_t value); 00374 #else 00375 virtual size_t write(uint8_t value); 00376 #endif 00377 00378 00392 #if (ARDUINO < 100) 00393 virtual void send(uint8_t value, uint8_t mode) { }; 00394 #else 00395 virtual void send(uint8_t value, uint8_t mode) = 0; 00396 #endif 00397 00398 #if (ARDUINO < 100) 00399 using Print::write; 00400 #else 00401 using Print::write; 00402 #endif 00403 00404 protected: 00405 // Internal LCD variables to control the LCD shared between all derived 00406 // classes. 00407 uint8_t _displayfunction; // LCD_5x10DOTS or LCD_5x8DOTS, LCD_4BITMODE or 00408 // LCD_8BITMODE, LCD_1LINE or LCD_2LINE 00409 uint8_t _displaycontrol; // LCD base control command LCD on/off, blink, cursor 00410 // all commands are "ored" to its contents. 00411 uint8_t _displaymode; // Text entry mode to the LCD 00412 uint8_t _numlines; // Number of lines of the LCD, initialized with begin() 00413 uint8_t _cols; // Number of columns in the LCD 00414 00415 private: 00416 00417 }; 00418 00419 #endif