16*2Lcd Display
TextLCD.h
- Committer:
- wim
- Date:
- 2014-09-27
- Revision:
- 34:e5a0dcb43ecc
- Parent:
- 33:900a94bc7585
- Child:
- 35:311be6444a39
File content as of revision 34:e5a0dcb43ecc:
/* mbed TextLCD Library, for a 4-bit LCD based on HD44780 * Copyright (c) 2007-2010, sford, http://mbed.org * 2013, v01: WH, Added LCD types, fixed LCD address issues, added Cursor and UDCs * 2013, v02: WH, Added I2C and SPI bus interfaces * 2013, v03: WH, Added support for LCD40x4 which uses 2 controllers * 2013, v04: WH, Added support for Display On/Off, improved 4bit bootprocess * 2013, v05: WH, Added support for 8x2B, added some UDCs * 2013, v06: WH, Added support for devices that use internal DC/DC converters * 2013, v07: WH, Added support for backlight and include portdefinitions for LCD2004 Module from DFROBOT * 2014, v08: WH, Refactored in Base and Derived Classes to deal with mbed lib change regarding 'NC' defined DigitalOut pins * 2014, v09: WH/EO, Added Class for Native SPI controllers such as ST7032 * 2014, v10: WH, Added Class for Native I2C controllers such as ST7032i, Added support for MCP23008 I2C portexpander, Added support for Adafruit module * 2014, v11: WH, Added support for native I2C controllers such as PCF21XX, Improved the _initCtrl() method to deal with differences between all supported controllers * 2014, v12: WH, Added support for native I2C controller PCF2119 and native I2C/SPI controllers SSD1803, ST7036, added setContrast method (by JH1PJL) for supported devices (eg ST7032i) * 2014, v13: WH, Added support for controllers US2066/SSD1311 (OLED), added setUDCBlink() method for supported devices (eg SSD1803), fixed issue in setPower() * 2014, v14: WH, Added support for PT6314 (VFD), added setOrient() method for supported devices (eg SSD1803, US2066), added Double Height lines for supported devices, * added 16 UDCs for supported devices (eg PCF2103), moved UDC defines to TextLCD_UDC file, added TextLCD_Config.h for feature and footprint settings. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ #ifndef MBED_TEXTLCD_H #define MBED_TEXTLCD_H #include "mbed.h" #include "TextLCD_Config.h" #include "TextLCD_UDC.h" /** A TextLCD interface for driving 4-bit HD44780-based LCDs * * Currently supports 8x1, 8x2, 12x3, 12x4, 16x1, 16x2, 16x3, 16x4, 20x2, 20x4, 24x1, 24x2, 24x4, 40x2 and 40x4 panels. * Interface options include direct mbed pins, I2C portexpander (PCF8474/PCF8574A or MCP23008) or SPI bus shiftregister (74595). * Supports some controllers with native I2C or SPI interface. Supports some controllers that provide internal DC/DC converters for VLCD or VLED. * Supports some controllers that feature programmable contrast control, powerdown, blinking UDCs and/or top/down orientation modes. * * @code * #include "mbed.h" * #include "TextLCD.h" * * // I2C Communication * I2C i2c_lcd(p28,p27); // SDA, SCL * * // SPI Communication * SPI spi_lcd(p5, NC, p7); // MOSI, MISO, SCLK * * //TextLCD lcd(p15, p16, p17, p18, p19, p20); // RS, E, D4-D7, LCDType=LCD16x2, BL=NC, E2=NC, LCDTCtrl=HD44780 * //TextLCD_SPI lcd(&spi_lcd, p8, TextLCD::LCD40x4); // SPI bus, 74595 expander, CS pin, LCD Type * TextLCD_I2C lcd(&i2c_lcd, 0x42, TextLCD::LCD20x4); // I2C bus, PCF8574 Slaveaddress, LCD Type * //TextLCD_I2C lcd(&i2c_lcd, 0x42, TextLCD::LCD16x2, TextLCD::WS0010); // I2C bus, PCF8574 Slaveaddress, LCD Type, Device Type (OLED) * //TextLCD_SPI_N lcd(&spi_lcd, p8, p9); // SPI bus, CS pin, RS pin, LCDType=LCD16x2, BL=NC, LCDTCtrl=ST7032_3V3 * //TextLCD_I2C_N lcd(&i2c_lcd, ST7032_SA, TextLCD::LCD16x2, NC, TextLCD::ST7032_3V3); // I2C bus, Slaveaddress, LCD Type, BL=NC, LCDTCtrl=ST7032_3V3 * //TextLCD_SPI_N_3_24 lcd(&spi_lcd, p8, TextLCD::LCD20x4D, NC, TextLCD::SSD1803_3V3); // SPI bus, CS pin, LCDType=LCD20x4D, BL=NC, LCDTCtrl=SSD1803 * //TextLCD_SPI_N_3_24 lcd(&spi_lcd, p8, TextLCD::LCD20x2, NC, TextLCD::US2066_3V3); // SPI bus, CS pin, LCDType=LCD20x2, BL=NC, LCDTCtrl=US2066 (OLED) * * int main() { * lcd.printf("Hello World!\n"); * } * @endcode */ //The TextLCD_Config.h file selects hardware interface options to reduce memory footprint //and provides Pin Defines for I2C PCF8574/PCF8574A or MCP23008 and SPI 74595 bus expander interfaces. //The LCD and serial portexpanders should be wired accordingly. /* LCD Type information on Rows, Columns and Variant. This information is encoded in * an int and used for the LCDType enumerators in order to simplify code maintenance */ // Columns encoded in b7..b0 #define LCD_T_COL_MSK 0x000000FF #define LCD_T_C6 0x00000006 #define LCD_T_C8 0x00000008 #define LCD_T_C10 0x0000000A #define LCD_T_C12 0x0000000C #define LCD_T_C16 0x00000010 #define LCD_T_C20 0x00000014 #define LCD_T_C24 0x00000018 #define LCD_T_C32 0x00000020 #define LCD_T_C40 0x00000028 // Rows encoded in b15..b8 #define LCD_T_ROW_MSK 0x0000FF00 #define LCD_T_R1 0x00000100 #define LCD_T_R2 0x00000200 #define LCD_T_R3 0x00000300 #define LCD_T_R4 0x00000400 // Addressing mode encoded in b19..b16 #define LCD_T_ADR_MSK 0x000F0000 #define LCD_T_A 0x00000000 /*Mode A Default 1, 2 or 4 line display */ #define LCD_T_B 0x00010000 /*Mode B, Alternate 8x2 (actually 16x1 display) */ #define LCD_T_C 0x00020000 /*Mode C, Alternate 16x1 (actually 8x2 display) */ #define LCD_T_D 0x00030000 /*Mode D, Alternate 3 or 4 line display (12x4, 20x4, 24x4) */ #define LCD_T_D1 0x00040000 /*Mode D1, Alternate 3 out of 4 line display (12x3, 20x3, 24x3) */ #define LCD_T_E 0x00050000 /*Mode E, 40x4 display (actually two 40x2) */ #define LCD_T_F 0x00060000 /*Mode F, 16x3 display (actually 24x2) */ #define LCD_T_G 0x00070000 /*Mode G, 16x3 display */ /* LCD Ctrl information on interface support and features. This information is encoded in * an int and used for the LCDCtrl enumerators in order to simplify code maintenance */ // Interface encoded in b31..b24 #define LCD_C_BUS_MSK 0xFF000000 #define LCD_C_PAR 0x01000000 /*Parallel 4 or 8 bit data, E pin, RS pin, RW=GND */ #define LCD_C_SPI3_9 0x02000000 /*SPI 3 line (MOSI, SCL, CS pins), 9 bits (RS + 8 Data) */ #define LCD_C_SPI3_10 0x04000000 /*SPI 3 line (MOSI, SCL, CS pins), 10 bits (RS, RW + 8 Data) */ #define LCD_C_SPI3_16 0x08000000 /*SPI 3 line (MOSI, SCL, CS pins), 16 bits (RS, RW + 8 Data) */ #define LCD_C_SPI3_24 0x10000000 /*SPI 3 line (MOSI, SCL, CS pins), 24 bits (RS, RW + 8 Data) */ #define LCD_C_SPI4 0x20000000 /*SPI 4 line (MOSI, SCL, CS, RS pin), RS pin + 8 Data */ #define LCD_C_I2C 0x40000000 /*I2C (SDA, SCL pin), 8 control bits (Co, RS, RW) + 8 Data */ // Features encoded in b23..b16 #define LCD_C_FTR_MSK 0x00FF0000 #define LCD_C_BST 0x00010000 /*Booster */ #define LCD_C_CTR 0x00020000 /*Contrast Control */ #define LCD_C_ICN 0x00040000 /*Icons */ #define LCD_C_PDN 0x00080000 /*Power Down */ /** A TextLCD interface for driving 4-bit HD44780-based LCDs * * @brief Currently supports 8x1, 8x2, 12x2, 12x3, 12x4, 16x1, 16x2, 16x3, 16x4, 20x2, 20x4, 24x2, 24x4, 40x2 and 40x4 panels * Interface options include direct mbed pins, I2C portexpander (PCF8474/PCF8574A or MCP23008) or SPI bus shiftregister (74595) and some native I2C or SPI devices * */ #if(LCD_PRINTF == 1) class TextLCD_Base : public Stream { #else class TextLCD_Base{ #endif public: /** LCD panel format */ // The commented out types exist but have not yet been tested with the library enum LCDType { // LCD6x1 = (LCD_T_A | LCD_T_C6 | LCD_T_R1), /**< 6x1 LCD panel */ // LCD6x2 = (LCD_T_A | LCD_T_C6 | LCD_T_R2), /**< 6x2 LCD panel */ LCD8x1 = (LCD_T_A | LCD_T_C8 | LCD_T_R1), /**< 8x1 LCD panel */ LCD8x2 = (LCD_T_A | LCD_T_C8 | LCD_T_R2), /**< 8x2 LCD panel */ LCD8x2B = (LCD_T_D | LCD_T_C8 | LCD_T_R2), /**< 8x2 LCD panel (actually 16x1) */ LCD12x1 = (LCD_T_A | LCD_T_C12 | LCD_T_R1), /**< 12x1 LCD panel */ LCD12x2 = (LCD_T_A | LCD_T_C12 | LCD_T_R2), /**< 12x2 LCD panel */ LCD12x3D = (LCD_T_D | LCD_T_C12 | LCD_T_R3), /**< 12x3 LCD panel, special mode PCF21XX */ LCD12x3D1 = (LCD_T_D1 | LCD_T_C12 | LCD_T_R3), /**< 12x3 LCD panel, special mode PCF21XX */ // LCD12x3G = (LCD_T_G | LCD_T_C12 | LCD_T_R3), /**< 12x3 LCD panel, special mode ST7036 */ LCD12x4 = (LCD_T_A | LCD_T_C12 | LCD_T_R4), /**< 12x4 LCD panel */ LCD12x4D = (LCD_T_B | LCD_T_C12 | LCD_T_R4), /**< 12x4 LCD panel, special mode PCF21XX */ LCD16x1 = (LCD_T_A | LCD_T_C16 | LCD_T_R1), /**< 16x1 LCD panel */ LCD16x1C = (LCD_T_C | LCD_T_C16 | LCD_T_R1), /**< 16x1 LCD panel (actually 8x2) */ LCD16x2 = (LCD_T_A | LCD_T_C16 | LCD_T_R2), /**< 16x2 LCD panel (default) */ // LCD16x2B = (LCD_T_B | LCD_T_C16 | LCD_T_R2), /**< 16x2 LCD panel, alternate addressing, wrong.. */ LCD16x3D = (LCD_T_D | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel, special mode SSD1803 */ // LCD16x3D1 = (LCD_T_D1 | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel, special mode SSD1803 */ LCD16x3F = (LCD_T_F | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel (actually 24x2) */ LCD16x3G = (LCD_T_G | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel, special mode ST7036 */ LCD16x4 = (LCD_T_A | LCD_T_C16 | LCD_T_R4), /**< 16x4 LCD panel */ // LCD16x4D = (LCD_T_D | LCD_T_C16 | LCD_T_R4), /**< 16x4 LCD panel, special mode SSD1803 */ LCD20x1 = (LCD_T_A | LCD_T_C20 | LCD_T_R1), /**< 20x1 LCD panel */ LCD20x2 = (LCD_T_A | LCD_T_C20 | LCD_T_R2), /**< 20x2 LCD panel */ // LCD20x3 = (LCD_T_A | LCD_T_C20 | LCD_T_R3), /**< 20x3 LCD panel */ // LCD20x3D = (LCD_T_D | LCD_T_C20 | LCD_T_R3), /**< 20x3 LCD panel, special mode SSD1803 */ // LCD20x3D1 = (LCD_T_D1 | LCD_T_C20 | LCD_T_R3), /**< 20x3 LCD panel, special mode SSD1803 */ LCD20x4 = (LCD_T_A | LCD_T_C20 | LCD_T_R4), /**< 20x4 LCD panel */ LCD20x4D = (LCD_T_D | LCD_T_C20 | LCD_T_R4), /**< 20x4 LCD panel, special mode SSD1803 */ LCD24x1 = (LCD_T_A | LCD_T_C24 | LCD_T_R1), /**< 24x1 LCD panel */ LCD24x2 = (LCD_T_A | LCD_T_C24 | LCD_T_R2), /**< 24x2 LCD panel */ // LCD24x3D = (LCD_T_D | LCD_T_C24 | LCD_T_R3), /**< 24x3 LCD panel */ // LCD24x3D1 = (LCD_T_D | LCD_T_C24 | LCD_T_R3), /**< 24x3 LCD panel */ LCD24x4D = (LCD_T_D | LCD_T_C24 | LCD_T_R4), /**< 24x4 LCD panel, special mode KS0078 */ // LCD32x1 = (LCD_T_A | LCD_T_C32 | LCD_T_R1), /**< 32x1 LCD panel */ // LCD32x1C = (LCD_T_C | LCD_T_C32 | LCD_T_R1), /**< 32x1 LCD panel (actually 16x2) */ // LCD32x2 = (LCD_T_A | LCD_T_C32 | LCD_T_R2), /**< 32x2 LCD panel */ // LCD32x4 = (LCD_T_A | LCD_T_C32 | LCD_T_R4), /**< 32x4 LCD panel */ // LCD40x1 = (LCD_T_A | LCD_T_C40 | LCD_T_R1), /**< 40x1 LCD panel */ // LCD40x1C = (LCD_T_C | LCD_T_C40 | LCD_T_R1), /**< 40x1 LCD panel (actually 20x2) */ LCD40x2 = (LCD_T_A | LCD_T_C40 | LCD_T_R2), /**< 40x2 LCD panel */ LCD40x4 = (LCD_T_E | LCD_T_C40 | LCD_T_R4) /**< 40x4 LCD panel, Two controller version */ }; /** LCD Controller Device */ enum LCDCtrl { HD44780 = 0 | LCD_C_PAR, /**< HD44780 or full equivalent (default) */ WS0010 = 1 | (LCD_C_PAR | LCD_C_SPI3_10 | LCD_C_PDN), /**< WS0010/RS0010 OLED Controller, 4/8 bit, SPI3 */ ST7036_3V3 = 2 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< ST7036 3V3 with Booster, 4/8 bit, SPI4, I2C */ ST7036_5V = 3 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< ST7036 5V no Booster, 4/8 bit, SPI4, I2C */ ST7032_3V3 = 4 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< ST7032 3V3 with Booster, 4/8 bit, SPI4, I2C */ ST7032_5V = 5 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_CTR), /**< ST7032 5V no Booster, 4/8 bit, SPI4, I2C */ KS0078 = 6 | (LCD_C_PAR | LCD_C_SPI3_24), /**< KS0078 24x4 support, 4/8 bit, SPI3 */ PCF2103_3V3 = 7 | (LCD_C_PAR | LCD_C_I2C), /**< PCF2103 3V3 no Booster, 4/8 bit, I2C */ PCF2113_3V3 = 8 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< PCF2113 3V3 with Booster, 4/8 bit, I2C */ PCF2116_3V3 = 9 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST), /**< PCF2116 3V3 with Booster, 4/8 bit, I2C */ PCF2116_5V = 10 | (LCD_C_PAR | LCD_C_I2C), /**< PCF2116 5V no Booster, 4/8 bit, I2C */ PCF2119_3V3 = 11 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< PCF2119 3V3 with Booster, 4/8 bit, I2C */ // PCF2119_5V = 12 | (LCD_C_PAR | LCD_C_I2C), /**< PCF2119 5V no Booster, 4/8 bit, I2C */ AIP31068 = 13 | (LCD_C_SPI3_9 | LCD_C_I2C | LCD_C_BST), /**< AIP31068 I2C, SPI3 */ SSD1803_3V3 = 14 | (LCD_C_PAR | LCD_C_SPI3_24 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR | LCD_C_PDN), /**< SSD1803 3V3 with Booster, 4/8 bit, I2C, SPI3 */ // SSD1803_5V = 15 | (LCD_C_PAR | LCD_C_SPI3_24 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR | LCD_C_PDN), /**< SSD1803 3V3 with Booster, 4/8 bit, I2C, SPI3 */ US2066_3V3 = 16 | (LCD_C_PAR | LCD_C_SPI3_24 | LCD_C_I2C | LCD_C_CTR | LCD_C_PDN), /**< US2066/SSD1311 3V3, 4/8 bit, I2C, SPI3 */ PT6314 = 17 | (LCD_C_PAR | LCD_C_SPI3_16 | LCD_C_CTR), /**< PT6314 VFD, 4/8 bit, SPI3 */ // AC780 = 18 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_PDN) /**< AC780/KS0066i 4/8 bit, SPI, I2C */ // WS0012 = 19 | (LCD_C_PAR | LCD_C_SPI3_10 | LCD_C_I2C | LCD_C_PDN) /**< WS0012 4/8 bit, SPI, I2C */ }; /** LCD Cursor control */ enum LCDCursor { CurOff_BlkOff = 0x00, /**< Cursor Off, Blinking Char Off */ CurOn_BlkOff = 0x02, /**< Cursor On, Blinking Char Off */ CurOff_BlkOn = 0x01, /**< Cursor Off, Blinking Char On */ CurOn_BlkOn = 0x03 /**< Cursor On, Blinking Char On */ }; /** LCD Display control */ enum LCDMode { DispOff = 0x00, /**< Display Off */ DispOn = 0x04 /**< Display On */ }; /** LCD Backlight control */ enum LCDBacklight { LightOff, /**< Backlight Off */ LightOn /**< Backlight On */ }; /** LCD Blink control (UDC), supported for some Controllers */ enum LCDBlink { BlinkOff, /**< Blink Off */ BlinkOn /**< Blink On */ }; /** LCD Orientation control, supported for some Controllers */ enum LCDOrient { Top, /**< Top view */ Bottom /**< Upside down view */ }; /** LCD BigFont control, supported for some Controllers */ enum LCDBigFont { None, /**< no lines */ TopLine, /**< 1+2 line */ CenterLine, /**< 2+3 line */ BottomLine, /**< 2+3 line or 3+4 line */ TopBottomLine /**< 1+2 line and 3+4 line */ }; #if(LCD_PRINTF != 1) /** Write a character to the LCD * * @param c The character to write to the display */ int putc(int c); /** Write a raw string to the LCD * * @param string text, may be followed by variables to emulate formatting the string. * However, printf formatting is NOT supported and variables will be ignored! */ int printf(const char* text, ...); #else #if DOXYGEN_ONLY /** Write a character to the LCD * * @param c The character to write to the display */ int putc(int c); /** Write a formatted string to the LCD * * @param format A printf-style format string, followed by the * variables to use in formatting the string. */ int printf(const char* format, ...); #endif #endif /** Locate cursor to a screen column and row * * @param column The horizontal position from the left, indexed from 0 * @param row The vertical position from the top, indexed from 0 */ void locate(int column, int row); /** Return the memoryaddress of screen column and row location * * @param column The horizontal position from the left, indexed from 0 * @param row The vertical position from the top, indexed from 0 * @param return The memoryaddress of screen column and row location */ int getAddress(int column, int row); /** Set the memoryaddress of screen column and row location * * @param column The horizontal position from the left, indexed from 0 * @param row The vertical position from the top, indexed from 0 */ void setAddress(int column, int row); /** Clear the screen and locate to 0,0 */ void cls(); /** Return the number of rows * * @param return The number of rows */ int rows(); /** Return the number of columns * * @param return The number of columns */ int columns(); /** Set the Cursormode * * @param cursorMode The Cursor mode (CurOff_BlkOff, CurOn_BlkOff, CurOff_BlkOn, CurOn_BlkOn) */ void setCursor(LCDCursor cursorMode); /** Set the Displaymode * * @param displayMode The Display mode (DispOff, DispOn) */ void setMode(LCDMode displayMode); /** Set the Backlight mode * * @param backlightMode The Backlight mode (LightOff, LightOn) */ void setBacklight(LCDBacklight backlightMode); /** Set User Defined Characters (UDC) * * @param unsigned char c The Index of the UDC (0..7) for HD44780 clones and (0..15) for some more advanced controllers * @param char *udc_data The bitpatterns for the UDC (8 bytes of 5 significant bits for bitpattern and 3 bits for blinkmode (advanced types)) */ void setUDC(unsigned char c, char *udc_data); /** Set UDC Blink * setUDCBlink method is supported by some compatible devices (eg SSD1803) * * @param blinkMode The Blink mode (BlinkOff, BlinkOn) */ void setUDCBlink(LCDBlink blinkMode); /** Set Contrast * setContrast method is supported by some compatible devices (eg ST7032i) that have onboard LCD voltage generation * Code imported from fork by JH1PJL * * @param unsigned char c contrast data (6 significant bits, valid range 0..63, Value 0 will disable the Vgen) * @return none */ void setContrast(unsigned char c = LCD_DEF_CONTRAST); /** Set Power * setPower method is supported by some compatible devices (eg SSD1803) that have power down modes * * @param bool powerOn Power on/off * @return none */ void setPower(bool powerOn = true); /** Set Orient * setOrient method is supported by some compatible devices (eg SSD1803, US2066) that have top/bottom view modes * * @param LCDOrient orient Orientation * @return none */ void setOrient(LCDOrient orient = Top); /** Set Big Font * setBigFont method is supported by some compatible devices (eg SSD1803, US2066) * * @param lines The selected Big Font lines (None, TopLine, CenterLine, BottomLine, TopBottomLine) * Double height characters can be shown on lines 1+2, 2+3, 3+4 or 1+2 and 3+4 * Valid double height lines depend on the LCDs number of rows. */ void setBigFont(LCDBigFont lines); //test // void _initCtrl(); // int _column; // int _row; protected: /** LCD controller select, mainly used for LCD40x4 */ enum _LCDCtrl_Idx { _LCDCtrl_0, /*< Primary */ _LCDCtrl_1, /*< Secondary */ }; /** Create a TextLCD_Base interface * @brief Base class, can not be instantiated * * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param ctrl LCD controller (default = HD44780) */ TextLCD_Base(LCDType type = LCD16x2, LCDCtrl ctrl = HD44780); // Stream implementation functions virtual int _putc(int value); virtual int _getc(); /** Low level method for LCD controller */ void _init(); /** Low level initialisation method for LCD controller */ void _initCtrl(); /** Low level character address set method */ int _address(int column, int row); /** Low level cursor enable or disable method */ void _setCursor(LCDCursor show); /** Low level method to store user defined characters for current controller * * @param unsigned char c The Index of the UDC (0..7) for HD44780 clones and (0..15) for some more advanced controllers * @param char *udc_data The bitpatterns for the UDC (8 bytes of 5 significant bits) */ void _setUDC(unsigned char c, char *udc_data); /** Low level method to restore the cursortype and display mode for current controller */ void _setCursorAndDisplayMode(LCDMode displayMode, LCDCursor cursorType); /** Low level nibble write operation to LCD controller (serial or parallel) */ void _writeNibble(int value); /** Low level command byte write operation to LCD controller. * Methods resets the RS bit and provides the required timing for the command. */ void _writeCommand(int command); /** Low level data byte write operation to LCD controller (serial or parallel). * Methods sets the RS bit and provides the required timing for the data. */ void _writeData(int data); /** Pure Virtual Low level writes to LCD Bus (serial or parallel) * Set the Enable pin. */ virtual void _setEnable(bool value) = 0; /** Pure Virtual Low level writes to LCD Bus (serial or parallel) * Set the RS pin ( 0 = Command, 1 = Data). */ virtual void _setRS(bool value) = 0; /** Pure Virtual Low level writes to LCD Bus (serial or parallel) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value) = 0; /** Pure Virtual Low level writes to LCD Bus (serial or parallel) * Set the databus value (4 bit). */ virtual void _setData(int value) = 0; /** Low level byte write operation to LCD controller (serial or parallel) * Depending on the RS pin this byte will be interpreted as data or command */ virtual void _writeByte(int value); //Display type LCDType _type; int _nr_cols; int _nr_rows; int _addr_mode; //Display mode LCDMode _currentMode; //Controller type LCDCtrl _ctrl; //Controller select, mainly used for LCD40x4 _LCDCtrl_Idx _ctrl_idx; // Cursor int _column; int _row; LCDCursor _currentCursor; // Function mode saved to allow switch between Instruction sets after initialisation time // Icon, Booster mode and contrast saved to allow contrast change at later time // Only available for controllers with added features int _function, _function_1, _function_x; int _icon_power; int _contrast; }; //--------- End TextLCD_Base ----------- //--------- Start TextLCD Bus ----------- /** Create a TextLCD interface for using regular mbed pins * */ class TextLCD : public TextLCD_Base { public: /** Create a TextLCD interface for using regular mbed pins * * @param rs Instruction/data control line * @param e Enable line (clock) * @param d4-d7 Data lines for using as a 4-bit interface * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param bl Backlight control line (optional, default = NC) * @param e2 Enable2 line (clock for second controller, LCD40x4 only) * @param ctrl LCD controller (default = HD44780) */ TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2, PinName bl = NC, PinName e2 = NC, LCDCtrl ctrl = HD44780); /** Destruct a TextLCD interface for using regular mbed pins * * @param none * @return none */ virtual ~TextLCD(); private: /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Regular mbed pins bus */ DigitalOut _rs, _e; BusOut _d; /** Optional Hardware pins for the Backlight and LCD40x4 device * Default PinName value is NC, must be used as pointer to avoid issues with mbed lib and DigitalOut pins */ DigitalOut *_bl, *_e2; }; //----------- End TextLCD --------------- //--------- Start TextLCD_I2C ----------- #if(LCD_I2C == 1) /* I2C Expander PCF8574/MCP23008 */ /** Create a TextLCD interface using an I2C PCF8574 (or PCF8574A) or MCP23008 portexpander * */ class TextLCD_I2C : public TextLCD_Base { public: /** Create a TextLCD interface using an I2C PCF8574 (or PCF8574A) or MCP23008 portexpander * * @param i2c I2C Bus * @param deviceAddress I2C slave address (PCF8574 or PCF8574A, default = PCF8574_SA0 = 0x40) * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param ctrl LCD controller (default = HD44780) */ TextLCD_I2C(I2C *i2c, char deviceAddress = PCF8574_SA0, LCDType type = LCD16x2, LCDCtrl ctrl = HD44780); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Write data to MCP23008 I2C portexpander * @param reg register to write * @param value data to write * @return none * */ void _write_register (int reg, int value); //I2C bus I2C *_i2c; char _slaveAddress; // Internal bus mirror value for serial bus only char _lcd_bus; }; #endif /* I2C Expander PCF8574/MCP23008 */ //---------- End TextLCD_I2C ------------ //--------- Start TextLCD_SPI ----------- #if(LCD_SPI == 1) /* SPI Expander SN74595 */ /** Create a TextLCD interface using an SPI 74595 portexpander * */ class TextLCD_SPI : public TextLCD_Base { public: /** Create a TextLCD interface using an SPI 74595 portexpander * * @param spi SPI Bus * @param cs chip select pin (active low) * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param ctrl LCD controller (default = HD44780) */ TextLCD_SPI(SPI *spi, PinName cs, LCDType type = LCD16x2, LCDCtrl ctrl = HD44780); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Implementation of Low level writes to LCD Bus (serial expander) * Set the CS pin (0 = select, 1 = deselect). */ virtual void _setCS(bool value); ///** Low level writes to LCD serial bus only (serial expander) // */ // void _writeBus(); // SPI bus SPI *_spi; DigitalOut _cs; // Internal bus mirror value for serial bus only char _lcd_bus; }; #endif /* SPI Expander SN74595 */ //---------- End TextLCD_SPI ------------ //--------- Start TextLCD_SPI_N ----------- #if(LCD_SPI_N == 1) /* Native SPI bus */ /** Create a TextLCD interface using a controller with native SPI4 interface * */ class TextLCD_SPI_N : public TextLCD_Base { public: /** Create a TextLCD interface using a controller with native SPI4 interface * * @param spi SPI Bus * @param cs chip select pin (active low) * @param rs Instruction/data control line * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param bl Backlight control line (optional, default = NC) * @param ctrl LCD controller (default = ST7032_3V3) */ TextLCD_SPI_N(SPI *spi, PinName cs, PinName rs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = ST7032_3V3); virtual ~TextLCD_SPI_N(void); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Low level writes to LCD serial bus only (serial native) */ virtual void _writeByte(int value); // SPI bus SPI *_spi; DigitalOut _cs; DigitalOut _rs; //Backlight DigitalOut *_bl; }; #endif /* Native SPI bus */ //---------- End TextLCD_SPI_N ------------ //------- Start TextLCD_SPI_N_3_9 --------- #if(LCD_SPI_N_3_9 == 1) /* Native SPI bus */ //Code checked out on logic analyser. Not yet tested on hardware.. /** Create a TextLCD interface using a controller with native SPI3 9 bits interface * Note: current mbed libs only support SPI 9 bit mode for NXP platforms * */ class TextLCD_SPI_N_3_9 : public TextLCD_Base { public: /** Create a TextLCD interface using a controller with native SPI3 9 bits interface * Note: current mbed libs only support SPI 9 bit mode for NXP platforms * * @param spi SPI Bus * @param cs chip select pin (active low) * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param bl Backlight control line (optional, default = NC) * @param ctrl LCD controller (default = AIP31068) */ TextLCD_SPI_N_3_9(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = AIP31068); virtual ~TextLCD_SPI_N_3_9(void); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Low level writes to LCD serial bus only (serial native) */ virtual void _writeByte(int value); // SPI bus SPI *_spi; DigitalOut _cs; // controlbyte to select between data and command. Internal value for serial bus only char _controlbyte; //Backlight DigitalOut *_bl; }; #endif /* Native SPI bus */ //-------- End TextLCD_SPI_N_3_9 ---------- //------- Start TextLCD_SPI_N_3_10 --------- #if(LCD_SPI_N_3_10 == 1) /* Native SPI bus */ /** Create a TextLCD interface using a controller with native SPI3 10 bits interface * Note: current mbed libs only support SPI 10 bit mode for NXP platforms * */ class TextLCD_SPI_N_3_10 : public TextLCD_Base { public: /** Create a TextLCD interface using a controller with native SPI3 10 bits interface * Note: current mbed libs only support SPI 10 bit mode for NXP platforms * * @param spi SPI Bus * @param cs chip select pin (active low) * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param bl Backlight control line (optional, default = NC) * @param ctrl LCD controller (default = AIP31068) */ TextLCD_SPI_N_3_10(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = AIP31068); virtual ~TextLCD_SPI_N_3_10(void); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Low level writes to LCD serial bus only (serial native) */ virtual void _writeByte(int value); // SPI bus SPI *_spi; DigitalOut _cs; // controlbyte to select between data and command. Internal value for serial bus only char _controlbyte; //Backlight DigitalOut *_bl; }; #endif /* Native SPI bus */ //-------- End TextLCD_SPI_N_3_10 ---------- //------- Start TextLCD_SPI_N_3_16 --------- #if(LCD_SPI_N_3_16 == 1) /* Native SPI bus */ //Code checked out on logic analyser. Not yet tested on hardware.. /** Create a TextLCD interface using a controller with native SPI3 16 bits interface * */ class TextLCD_SPI_N_3_16 : public TextLCD_Base { public: /** Create a TextLCD interface using a controller with native SPI3 16 bits interface * * @param spi SPI Bus * @param cs chip select pin (active low) * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param bl Backlight control line (optional, default = NC) * @param ctrl LCD controller (default = PT6314) */ TextLCD_SPI_N_3_16(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = PT6314); virtual ~TextLCD_SPI_N_3_16(void); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Low level writes to LCD serial bus only (serial native) */ virtual void _writeByte(int value); // SPI bus SPI *_spi; DigitalOut _cs; // controlbyte to select between data and command. Internal value for serial bus only char _controlbyte; //Backlight DigitalOut *_bl; }; #endif /* Native SPI bus */ //-------- End TextLCD_SPI_N_3_16 ---------- //------- Start TextLCD_SPI_N_3_24 --------- #if(LCD_SPI_N_3_24 == 1) /* Native SPI bus */ /** Create a TextLCD interface using a controller with native SPI3 24 bits interface * Note: lib uses SPI 8 bit mode * */ class TextLCD_SPI_N_3_24 : public TextLCD_Base { public: /** Create a TextLCD interface using a controller with native SPI3 24 bits interface * Note: lib uses SPI 8 bit mode * * @param spi SPI Bus * @param cs chip select pin (active low) * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param bl Backlight control line (optional, default = NC) * @param ctrl LCD controller (default = SSD1803) */ TextLCD_SPI_N_3_24(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = SSD1803_3V3); virtual ~TextLCD_SPI_N_3_24(void); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the RS pin (0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Low level writes to LCD serial bus only (serial native) */ virtual void _writeByte(int value); // SPI bus SPI *_spi; DigitalOut _cs; // controlbyte to select between data and command. Internal value for serial bus only char _controlbyte; //Backlight DigitalOut *_bl; }; #endif /* Native SPI bus */ //-------- End TextLCD_SPI_N_3_24 ---------- //--------- Start TextLCD_I2C_N ----------- #if(LCD_I2C_N == 1) /* Native I2C */ /** Create a TextLCD interface using a controller with native I2C interface * */ class TextLCD_I2C_N : public TextLCD_Base { public: /** Create a TextLCD interface using a controller with native I2C interface * * @param i2c I2C Bus * @param deviceAddress I2C slave address (default = ST7032_SA = 0x7C) * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param bl Backlight control line (optional, default = NC) * @param ctrl LCD controller (default = ST7032_3V3) */ TextLCD_I2C_N(I2C *i2c, char deviceAddress = ST7032_SA, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = ST7032_3V3); virtual ~TextLCD_I2C_N(void); private: /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the Enable pin. */ virtual void _setEnable(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the RS pin ( 0 = Command, 1 = Data). */ virtual void _setRS(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the BL pin (0 = Backlight Off, 1 = Backlight On). */ virtual void _setBL(bool value); /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) * Set the databus value (4 bit). */ virtual void _setData(int value); /** Low level writes to LCD serial bus only (serial native) */ virtual void _writeByte(int value); //I2C bus I2C *_i2c; char _slaveAddress; // controlbyte to select between data and command. Internal value for serial bus only char _controlbyte; //Backlight DigitalOut *_bl; }; #endif /* Native I2C */ //---------- End TextLCD_I2C_N ------------ #endif