Joachim Andersen / TextLCD

1

Dependents:   Program_R11

TextLCD.h@23:d47f226efb24, 2014-04-02 (annotated)

Committer:
wim
Date:
Wed Apr 02 18:16:37 2014 +0000
Revision:
23:d47f226efb24
Parent:
22:35742ec80c24
Child:
24:fb3399713710
Docs update

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon 1:ac48b187213c 1 /* mbed TextLCD Library, for a 4-bit LCD based on HD44780
simon 6:e4cb7ddee0d3 2 * Copyright (c) 2007-2010, sford, http://mbed.org
wim 13:24506ba22480 3 * 2013, v01: WH, Added LCD types, fixed LCD address issues, added Cursor and UDCs
wim 15:b70ebfffb258 4 * 2013, v02: WH, Added I2C and SPI bus interfaces
wim 15:b70ebfffb258 5 * 2013, v03: WH, Added support for LCD40x4 which uses 2 controllers
wim 17:652ab113bc2e 6 * 2013, v04: WH, Added support for Display On/Off, improved 4bit bootprocess
wim 18:bd65dc10f27f 7 * 2013, v05: WH, Added support for 8x2B, added some UDCs
wim 19:c747b9e2e7b8 8 * 2013, v06: WH, Added support for devices that use internal DC/DC converters
wim 20:e0da005a777f 9 * 2013, v07: WH, Added support for backlight and include portdefinitions for LCD2004 Module from DFROBOT
wim 21:9eb628d9e164 10 * 2014, v08: WH, Refactored in Base and Derived Classes to deal with mbed lib change regarding 'NC' defined DigitalOut pins
simon 1:ac48b187213c 11 *
simon 1:ac48b187213c 12 * Permission is hereby granted, free of charge, to any person obtaining a copy
simon 1:ac48b187213c 13 * of this software and associated documentation files (the "Software"), to deal
simon 1:ac48b187213c 14 * in the Software without restriction, including without limitation the rights
simon 1:ac48b187213c 15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
simon 1:ac48b187213c 16 * copies of the Software, and to permit persons to whom the Software is
simon 1:ac48b187213c 17 * furnished to do so, subject to the following conditions:
simon 2:227356c7d12c 18 *
simon 1:ac48b187213c 19 * The above copyright notice and this permission notice shall be included in
simon 1:ac48b187213c 20 * all copies or substantial portions of the Software.
simon 2:227356c7d12c 21 *
simon 1:ac48b187213c 22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
simon 1:ac48b187213c 23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
simon 1:ac48b187213c 24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
simon 1:ac48b187213c 25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
simon 1:ac48b187213c 26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
simon 1:ac48b187213c 27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
simon 1:ac48b187213c 28 * THE SOFTWARE.
simon 1:ac48b187213c 29 */
simon 1:ac48b187213c 30
simon 1:ac48b187213c 31 #ifndef MBED_TEXTLCD_H
simon 1:ac48b187213c 32 #define MBED_TEXTLCD_H
simon 1:ac48b187213c 33
simon 1:ac48b187213c 34 #include "mbed.h"
simon 2:227356c7d12c 35
wim 15:b70ebfffb258 36
simon 5:a53b3e2d6f1e 37 /** A TextLCD interface for driving 4-bit HD44780-based LCDs
simon 2:227356c7d12c 38 *
wim 16:c276b75e6585 39 * Currently supports 8x1, 8x2, 12x4, 16x1, 16x2, 16x4, 20x2, 20x4, 24x2, 24x4, 40x2 and 40x4 panels
wim 22:35742ec80c24 40 * Interface options include direct mbed pins, I2C portexpander (PCF8474, PCF8574A) or SPI bus shiftregister (74595)
wim 19:c747b9e2e7b8 41 * Supports some controllers that provide internal DC/DC converters for VLCD or VLED.
simon 2:227356c7d12c 42 *
simon 2:227356c7d12c 43 * @code
simon 2:227356c7d12c 44 * #include "mbed.h"
simon 2:227356c7d12c 45 * #include "TextLCD.h"
simon 5:a53b3e2d6f1e 46 *
wim 16:c276b75e6585 47 * // I2C Communication
wim 16:c276b75e6585 48 * I2C i2c_lcd(p28,p27); // SDA, SCL
wim 16:c276b75e6585 49 *
wim 16:c276b75e6585 50 * // SPI Communication
wim 16:c276b75e6585 51 * SPI spi_lcd(p5, NC, p7); // MOSI, MISO, SCLK
wim 16:c276b75e6585 52 *
wim 22:35742ec80c24 53 * //TextLCD lcd(p15, p16, p17, p18, p19, p20); // RS, E, D4-D7, LCDType=LCD16x2, BL=NC, E2=NC, LCDTCtrl=HD44780
wim 22:35742ec80c24 54 * //TextLCD_SPI lcd(&spi_lcd, p8, TextLCD::LCD40x4); // SPI bus, CS pin, LCD Type
wim 22:35742ec80c24 55 * TextLCD_I2C lcd(&i2c_lcd, 0x42, TextLCD::LCD20x4); // I2C bus, PCF8574 Slaveaddress, LCD Type
wim 21:9eb628d9e164 56 * //TextLCD_I2C lcd(&i2c_lcd, 0x42, TextLCD::LCD16x2, TextLCD::WS0010); // I2C bus, PCF8574 Slaveaddress, LCD Type, Device Type
simon 5:a53b3e2d6f1e 57 *
simon 2:227356c7d12c 58 * int main() {
wim 16:c276b75e6585 59 * lcd.printf("Hello World!\n");
simon 2:227356c7d12c 60 * }
simon 2:227356c7d12c 61 * @endcode
simon 2:227356c7d12c 62 */
wim 8:03116f75b66e 63
wim 16:c276b75e6585 64 //Pin Defines for I2C PCF8574 and SPI 74595 Bus interfaces
wim 13:24506ba22480 65 //LCD and serial portexpanders should be wired accordingly
wim 20:e0da005a777f 66 //
wim 20:e0da005a777f 67 #if (1)
wim 20:e0da005a777f 68 //Definitions for hardware used by WH
wim 13:24506ba22480 69 //Note: LCD RW pin must be connected to GND
wim 15:b70ebfffb258 70 // E2 is used for LCD40x4 (second controller)
wim 13:24506ba22480 71 // BL may be used for future expansion to control backlight
wim 15:b70ebfffb258 72 #define D_LCD_PIN_D4 0
wim 15:b70ebfffb258 73 #define D_LCD_PIN_D5 1
wim 15:b70ebfffb258 74 #define D_LCD_PIN_D6 2
wim 15:b70ebfffb258 75 #define D_LCD_PIN_D7 3
wim 15:b70ebfffb258 76 #define D_LCD_PIN_RS 4
wim 15:b70ebfffb258 77 #define D_LCD_PIN_E 5
wim 15:b70ebfffb258 78 #define D_LCD_PIN_E2 6
wim 15:b70ebfffb258 79 #define D_LCD_PIN_BL 7
wim 13:24506ba22480 80
wim 20:e0da005a777f 81 #define D_LCD_PIN_RW D_LCD_PIN_E2
wim 20:e0da005a777f 82
wim 20:e0da005a777f 83 #else
wim 20:e0da005a777f 84
wim 20:e0da005a777f 85 //Definitions for LCD2004 Module from DFROBOT, See http://arduino-info.wikispaces.com/LCD-Blue-I2C
wim 20:e0da005a777f 86 //This hardware is different from earlier/different Arduino I2C LCD displays
wim 20:e0da005a777f 87 //Note: LCD RW pin must be kept LOW
wim 20:e0da005a777f 88 // E2 is not available on default Arduino hardware and does not support LCD40x4 (second controller)
wim 20:e0da005a777f 89 // BL is used to control backlight
wim 20:e0da005a777f 90 #define D_LCD_PIN_RS 0
wim 20:e0da005a777f 91 #define D_LCD_PIN_RW 1
wim 20:e0da005a777f 92 #define D_LCD_PIN_E 2
wim 20:e0da005a777f 93 #define D_LCD_PIN_BL 3
wim 20:e0da005a777f 94 #define D_LCD_PIN_D4 4
wim 20:e0da005a777f 95 #define D_LCD_PIN_D5 5
wim 20:e0da005a777f 96 #define D_LCD_PIN_D6 6
wim 20:e0da005a777f 97 #define D_LCD_PIN_D7 7
wim 20:e0da005a777f 98
wim 20:e0da005a777f 99 #define D_LCD_PIN_E2 D_LCD_PIN_RW
wim 20:e0da005a777f 100 #endif
wim 13:24506ba22480 101
wim 13:24506ba22480 102 //Bitpattern Defines for I2C PCF8574 and SPI 74595 Bus
wim 13:24506ba22480 103 //
wim 13:24506ba22480 104 #define D_LCD_D4 (1<<D_LCD_PIN_D4)
wim 13:24506ba22480 105 #define D_LCD_D5 (1<<D_LCD_PIN_D5)
wim 13:24506ba22480 106 #define D_LCD_D6 (1<<D_LCD_PIN_D6)
wim 13:24506ba22480 107 #define D_LCD_D7 (1<<D_LCD_PIN_D7)
wim 13:24506ba22480 108 #define D_LCD_RS (1<<D_LCD_PIN_RS)
wim 13:24506ba22480 109 #define D_LCD_E (1<<D_LCD_PIN_E)
wim 13:24506ba22480 110 #define D_LCD_E2 (1<<D_LCD_PIN_E2)
wim 13:24506ba22480 111 #define D_LCD_BL (1<<D_LCD_PIN_BL)
wim 20:e0da005a777f 112 //#define D_LCD_RW (1<<D_LCD_PIN_RW)
wim 20:e0da005a777f 113
wim 20:e0da005a777f 114
wim 20:e0da005a777f 115 #define D_LCD_BUS_MSK (D_LCD_D4 | D_LCD_D5 | D_LCD_D6 | D_LCD_D7)
wim 20:e0da005a777f 116 #define D_LCD_BUS_DEF 0x00
wim 13:24506ba22480 117
wim 13:24506ba22480 118
wim 13:24506ba22480 119 /** Some sample User Defined Chars 5x7 dots */
wim 11:9ec02df863a1 120 const char udc_ae[] = {0x00, 0x00, 0x1B, 0x05, 0x1F, 0x14, 0x1F, 0x00}; //æ
wim 11:9ec02df863a1 121 const char udc_0e[] = {0x00, 0x00, 0x0E, 0x13, 0x15, 0x19, 0x0E, 0x00}; //ø
wim 11:9ec02df863a1 122 const char udc_ao[] = {0x0E, 0x0A, 0x0E, 0x01, 0x0F, 0x11, 0x0F, 0x00}; //å
wim 11:9ec02df863a1 123 const char udc_AE[] = {0x0F, 0x14, 0x14, 0x1F, 0x14, 0x14, 0x17, 0x00}; //Æ
wim 11:9ec02df863a1 124 const char udc_0E[] = {0x0E, 0x13, 0x15, 0x15, 0x15, 0x19, 0x0E, 0x00}; //Ø
wim 18:bd65dc10f27f 125 const char udc_Ao[] = {0x0E, 0x0A, 0x0E, 0x11, 0x1F, 0x11, 0x11, 0x00}; //Å
wim 18:bd65dc10f27f 126 const char udc_PO[] = {0x04, 0x0A, 0x0A, 0x1F, 0x1B, 0x1B, 0x1F, 0x00}; //Padlock Open
wim 18:bd65dc10f27f 127 const char udc_PC[] = {0x1C, 0x10, 0x08, 0x1F, 0x1B, 0x1B, 0x1F, 0x00}; //Padlock Closed
wim 11:9ec02df863a1 128
wim 11:9ec02df863a1 129 const char udc_0[] = {0x18, 0x14, 0x12, 0x11, 0x12, 0x14, 0x18, 0x00}; // |>
wim 11:9ec02df863a1 130 const char udc_1[] = {0x03, 0x05, 0x09, 0x11, 0x09, 0x05, 0x03, 0x00}; // <|
wim 11:9ec02df863a1 131 const char udc_2[] = {0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x00}; // |
wim 11:9ec02df863a1 132 const char udc_3[] = {0x14, 0x14, 0x14, 0x14, 0x14, 0x14, 0x14, 0x00}; // ||
wim 11:9ec02df863a1 133 const char udc_4[] = {0x15, 0x15, 0x15, 0x15, 0x15, 0x15, 0x15, 0x00}; // |||
wim 11:9ec02df863a1 134 const char udc_5[] = {0x00, 0x1f, 0x00, 0x1f, 0x00, 0x1f, 0x00, 0x00}; // =
wim 11:9ec02df863a1 135 const char udc_6[] = {0x15, 0x0a, 0x15, 0x0a, 0x15, 0x0a, 0x15, 0x00}; // checkerboard
wim 11:9ec02df863a1 136 const char udc_7[] = {0x10, 0x08, 0x04, 0x02, 0x01, 0x00, 0x10, 0x00}; // \
wim 11:9ec02df863a1 137
wim 13:24506ba22480 138 const char udc_degr[] = {0x06, 0x09, 0x09, 0x06, 0x00, 0x00, 0x00, 0x00}; // Degree symbol
wim 13:24506ba22480 139
wim 13:24506ba22480 140 const char udc_TM_T[] = {0x1F, 0x04, 0x04, 0x04, 0x00, 0x00, 0x00, 0x00}; // Trademark T
wim 13:24506ba22480 141 const char udc_TM_M[] = {0x11, 0x1B, 0x15, 0x11, 0x00, 0x00, 0x00, 0x00}; // Trademark M
wim 13:24506ba22480 142
wim 13:24506ba22480 143 //const char udc_Bat_Hi[] = {0x0E, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Full
wim 13:24506ba22480 144 //const char udc_Bat_Ha[] = {0x0E, 0x11, 0x13, 0x17, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Half
wim 13:24506ba22480 145 //const char udc_Bat_Lo[] = {0x0E, 0x11, 0x11, 0x11, 0x11, 0x11, 0x1F, 0x00}; // Battery Low
wim 13:24506ba22480 146 const char udc_Bat_Hi[] = {0x0E, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Full
wim 13:24506ba22480 147 const char udc_Bat_Ha[] = {0x0E, 0x11, 0x11, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Half
wim 13:24506ba22480 148 const char udc_Bat_Lo[] = {0x0E, 0x11, 0x11, 0x11, 0x11, 0x1F, 0x1F, 0x00}; // Battery Low
wim 18:bd65dc10f27f 149 const char udc_AC[] = {0x0A, 0x0A, 0x1F, 0x11, 0x0E, 0x04, 0x04, 0x00}; // AC Power
wim 13:24506ba22480 150
wim 18:bd65dc10f27f 151 //const char udc_smiley[] = {0x00, 0x0A, 0x00, 0x04, 0x11, 0x0E, 0x00, 0x00}; // Smiley
wim 18:bd65dc10f27f 152 //const char udc_droopy[] = {0x00, 0x0A, 0x00, 0x04, 0x00, 0x0E, 0x11, 0x00}; // Droopey
wim 18:bd65dc10f27f 153 //const char udc_note[] = {0x01, 0x03, 0x05, 0x09, 0x0B, 0x1B, 0x18, 0x00}; // Note
wim 18:bd65dc10f27f 154
wim 18:bd65dc10f27f 155 //const char udc_bar_1[] = {0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x00}; // Bar 1
wim 18:bd65dc10f27f 156 //const char udc_bar_2[] = {0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x00}; // Bar 11
wim 18:bd65dc10f27f 157 //const char udc_bar_3[] = {0x1C, 0x1C, 0x1C, 0x1C, 0x1C, 0x1C, 0x1C, 0x00}; // Bar 111
wim 18:bd65dc10f27f 158 //const char udc_bar_4[] = {0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x00}; // Bar 1111
wim 18:bd65dc10f27f 159 //const char udc_bar_5[] = {0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Bar 11111
wim 13:24506ba22480 160
wim 11:9ec02df863a1 161
wim 11:9ec02df863a1 162 /** A TextLCD interface for driving 4-bit HD44780-based LCDs
wim 11:9ec02df863a1 163 *
wim 22:35742ec80c24 164 * @brief Currently supports 8x1, 8x2, 12x2, 12x4, 16x1, 16x2, 16x4, 20x2, 20x4, 24x2, 24x4, 40x2 and 40x4 panels
wim 22:35742ec80c24 165 * Interface options include direct mbed pins, I2C portexpander (PCF8474, PCF8574A) or SPI bus shiftregister (74595)
wim 11:9ec02df863a1 166 *
wim 11:9ec02df863a1 167 */
wim 21:9eb628d9e164 168 class TextLCD_Base : public Stream {
simon 1:ac48b187213c 169 public:
simon 1:ac48b187213c 170
simon 2:227356c7d12c 171 /** LCD panel format */
simon 1:ac48b187213c 172 enum LCDType {
wim 8:03116f75b66e 173 LCD8x1, /**< 8x1 LCD panel */
wim 13:24506ba22480 174 LCD8x2, /**< 8x2 LCD panel */
wim 18:bd65dc10f27f 175 LCD8x2B, /**< 8x2 LCD panel (actually 16x1) */
wim 15:b70ebfffb258 176 LCD12x2, /**< 12x2 LCD panel */
wim 15:b70ebfffb258 177 LCD12x4, /**< 12x4 LCD panel */
wim 13:24506ba22480 178 LCD16x1, /**< 16x1 LCD panel (actually 8x2) */
wim 8:03116f75b66e 179 LCD16x2, /**< 16x2 LCD panel (default) */
wim 8:03116f75b66e 180 LCD16x2B, /**< 16x2 LCD panel alternate addressing */
wim 8:03116f75b66e 181 LCD16x4, /**< 16x4 LCD panel */
wim 8:03116f75b66e 182 LCD20x2, /**< 20x2 LCD panel */
wim 8:03116f75b66e 183 LCD20x4, /**< 20x4 LCD panel */
wim 9:0893d986e717 184 LCD24x2, /**< 24x2 LCD panel */
wim 10:dd9b3a696acd 185 LCD24x4, /**< 24x4 LCD panel, special mode KS0078 */
wim 15:b70ebfffb258 186 LCD40x2, /**< 40x2 LCD panel */
wim 15:b70ebfffb258 187 LCD40x4 /**< 40x4 LCD panel, Two controller version */
simon 1:ac48b187213c 188 };
simon 1:ac48b187213c 189
wim 19:c747b9e2e7b8 190 /** LCD Controller Device */
wim 19:c747b9e2e7b8 191 enum LCDCtrl {
wim 19:c747b9e2e7b8 192 HD44780, /**< HD44780 (default) */
wim 19:c747b9e2e7b8 193 WS0010, /**< WS0010 OLED Controller */
wim 20:e0da005a777f 194 ST7036 /**< ST7036 */
wim 19:c747b9e2e7b8 195 };
wim 19:c747b9e2e7b8 196
wim 19:c747b9e2e7b8 197
wim 10:dd9b3a696acd 198 /** LCD Cursor control */
wim 10:dd9b3a696acd 199 enum LCDCursor {
wim 17:652ab113bc2e 200 CurOff_BlkOff = 0x00, /**< Cursor Off, Blinking Char Off */
wim 17:652ab113bc2e 201 CurOn_BlkOff = 0x02, /**< Cursor On, Blinking Char Off */
wim 17:652ab113bc2e 202 CurOff_BlkOn = 0x01, /**< Cursor Off, Blinking Char On */
wim 17:652ab113bc2e 203 CurOn_BlkOn = 0x03 /**< Cursor On, Blinking Char On */
wim 17:652ab113bc2e 204 };
wim 17:652ab113bc2e 205
wim 17:652ab113bc2e 206
wim 17:652ab113bc2e 207 /** LCD Display control */
wim 17:652ab113bc2e 208 enum LCDMode {
wim 17:652ab113bc2e 209 DispOff = 0x00, /**< Display Off */
wim 17:652ab113bc2e 210 DispOn = 0x04 /**< Display On */
wim 10:dd9b3a696acd 211 };
wim 10:dd9b3a696acd 212
wim 20:e0da005a777f 213 /** LCD Backlight control */
wim 20:e0da005a777f 214 enum LCDBacklight {
wim 20:e0da005a777f 215 LightOff, /**< Backlight Off */
wim 20:e0da005a777f 216 LightOn /**< Backlight On */
wim 20:e0da005a777f 217 };
wim 10:dd9b3a696acd 218
simon 2:227356c7d12c 219
simon 2:227356c7d12c 220 #if DOXYGEN_ONLY
simon 2:227356c7d12c 221 /** Write a character to the LCD
simon 2:227356c7d12c 222 *
simon 2:227356c7d12c 223 * @param c The character to write to the display
simon 2:227356c7d12c 224 */
simon 2:227356c7d12c 225 int putc(int c);
simon 2:227356c7d12c 226
simon 2:227356c7d12c 227 /** Write a formated string to the LCD
simon 2:227356c7d12c 228 *
simon 2:227356c7d12c 229 * @param format A printf-style format string, followed by the
simon 2:227356c7d12c 230 * variables to use in formating the string.
simon 2:227356c7d12c 231 */
simon 2:227356c7d12c 232 int printf(const char* format, ...);
simon 2:227356c7d12c 233 #endif
simon 2:227356c7d12c 234
simon 2:227356c7d12c 235 /** Locate to a screen column and row
simon 2:227356c7d12c 236 *
simon 2:227356c7d12c 237 * @param column The horizontal position from the left, indexed from 0
simon 2:227356c7d12c 238 * @param row The vertical position from the top, indexed from 0
simon 2:227356c7d12c 239 */
simon 1:ac48b187213c 240 void locate(int column, int row);
simon 2:227356c7d12c 241
wim 10:dd9b3a696acd 242
wim 10:dd9b3a696acd 243 /** Return the memoryaddress of screen column and row location
wim 10:dd9b3a696acd 244 *
wim 10:dd9b3a696acd 245 * @param column The horizontal position from the left, indexed from 0
wim 10:dd9b3a696acd 246 * @param row The vertical position from the top, indexed from 0
wim 10:dd9b3a696acd 247 * @param return The memoryaddress of screen column and row location
wim 10:dd9b3a696acd 248 */
wim 9:0893d986e717 249 int getAddress(int column, int row);
wim 10:dd9b3a696acd 250
wim 10:dd9b3a696acd 251
wim 10:dd9b3a696acd 252 /** Set the memoryaddress of screen column and row location
wim 10:dd9b3a696acd 253 *
wim 10:dd9b3a696acd 254 * @param column The horizontal position from the left, indexed from 0
wim 10:dd9b3a696acd 255 * @param row The vertical position from the top, indexed from 0
wim 10:dd9b3a696acd 256 */
wim 9:0893d986e717 257 void setAddress(int column, int row);
wim 9:0893d986e717 258
wim 10:dd9b3a696acd 259
wim 22:35742ec80c24 260 /** Clear the screen and locate to 0,0
wim 22:35742ec80c24 261 */
simon 1:ac48b187213c 262 void cls();
simon 2:227356c7d12c 263
wim 10:dd9b3a696acd 264 /** Return the number of rows
wim 10:dd9b3a696acd 265 *
wim 10:dd9b3a696acd 266 * @param return The number of rows
wim 10:dd9b3a696acd 267 */
simon 1:ac48b187213c 268 int rows();
wim 10:dd9b3a696acd 269
wim 10:dd9b3a696acd 270 /** Return the number of columns
wim 10:dd9b3a696acd 271 *
wim 10:dd9b3a696acd 272 * @param return The number of columns
wim 10:dd9b3a696acd 273 */
wim 10:dd9b3a696acd 274 int columns();
simon 2:227356c7d12c 275
wim 11:9ec02df863a1 276 /** Set the Cursormode
wim 11:9ec02df863a1 277 *
wim 17:652ab113bc2e 278 * @param cursorMode The Cursor mode (CurOff_BlkOff, CurOn_BlkOff, CurOff_BlkOn, CurOn_BlkOn)
wim 11:9ec02df863a1 279 */
wim 17:652ab113bc2e 280 void setCursor(LCDCursor cursorMode);
wim 17:652ab113bc2e 281
wim 17:652ab113bc2e 282
wim 17:652ab113bc2e 283 /** Set the Displaymode
wim 17:652ab113bc2e 284 *
wim 17:652ab113bc2e 285 * @param displayMode The Display mode (DispOff, DispOn)
wim 17:652ab113bc2e 286 */
wim 21:9eb628d9e164 287 void setMode(LCDMode displayMode);
wim 11:9ec02df863a1 288
wim 20:e0da005a777f 289 /** Set the Backlight mode
wim 20:e0da005a777f 290 *
wim 21:9eb628d9e164 291 * @param backlightMode The Backlight mode (LightOff, LightOn)
wim 20:e0da005a777f 292 */
wim 21:9eb628d9e164 293 void setBacklight(LCDBacklight backlightMode);
wim 20:e0da005a777f 294
wim 11:9ec02df863a1 295
wim 11:9ec02df863a1 296 /** Set User Defined Characters
wim 11:9ec02df863a1 297 *
wim 11:9ec02df863a1 298 * @param unsigned char c The Index of the UDC (0..7)
wim 12:6bf9d9957d31 299 * @param char *udc_data The bitpatterns for the UDC (8 bytes of 5 significant bits)
wim 11:9ec02df863a1 300 */
wim 11:9ec02df863a1 301 void setUDC(unsigned char c, char *udc_data);
wim 11:9ec02df863a1 302
wim 20:e0da005a777f 303
simon 1:ac48b187213c 304 protected:
wim 13:24506ba22480 305
wim 21:9eb628d9e164 306 /** LCD controller select, mainly used for LCD40x4
wim 21:9eb628d9e164 307 */
wim 19:c747b9e2e7b8 308 enum _LCDCtrl_Idx {
wim 15:b70ebfffb258 309 _LCDCtrl_0, /*< Primary */
wim 15:b70ebfffb258 310 _LCDCtrl_1, /*< Secondary */
wim 15:b70ebfffb258 311 };
wim 21:9eb628d9e164 312
wim 21:9eb628d9e164 313 /** Create a TextLCD_Base interface
wim 21:9eb628d9e164 314 * @brief Base class, can not be instantiated
wim 21:9eb628d9e164 315 *
wim 21:9eb628d9e164 316 * @param type Sets the panel size/addressing mode (default = LCD16x2)
wim 21:9eb628d9e164 317 * @param ctrl LCD controller (default = HD44780)
wim 21:9eb628d9e164 318 */
wim 21:9eb628d9e164 319 TextLCD_Base(LCDType type = LCD16x2, LCDCtrl ctrl = HD44780);
wim 21:9eb628d9e164 320
wim 15:b70ebfffb258 321
simon 1:ac48b187213c 322 // Stream implementation functions
simon 1:ac48b187213c 323 virtual int _putc(int value);
simon 1:ac48b187213c 324 virtual int _getc();
simon 1:ac48b187213c 325
wim 21:9eb628d9e164 326 /** Low level methods for LCD controller
wim 21:9eb628d9e164 327 */
wim 13:24506ba22480 328 void _init();
wim 15:b70ebfffb258 329 void _initCtrl();
wim 13:24506ba22480 330 int _address(int column, int row);
wim 21:9eb628d9e164 331 void _setCursor(LCDCursor show);
wim 17:652ab113bc2e 332 void _setUDC(unsigned char c, char *udc_data);
wim 21:9eb628d9e164 333 void _setCursorAndDisplayMode(LCDMode displayMode, LCDCursor cursorType);
wim 13:24506ba22480 334
wim 21:9eb628d9e164 335 /** Low level write operations to LCD controller
wim 21:9eb628d9e164 336 */
wim 17:652ab113bc2e 337 void _writeNibble(int value);
wim 15:b70ebfffb258 338 void _writeByte(int value);
wim 15:b70ebfffb258 339 void _writeCommand(int command);
wim 15:b70ebfffb258 340 void _writeData(int data);
wim 15:b70ebfffb258 341
wim 21:9eb628d9e164 342 /** Pure Virtual Low level writes to LCD Bus (serial or parallel)
wim 21:9eb628d9e164 343 */
wim 21:9eb628d9e164 344 virtual void _setEnable(bool value) = 0;
wim 21:9eb628d9e164 345 virtual void _setRS(bool value) = 0;
wim 21:9eb628d9e164 346 virtual void _setBL(bool value) = 0;
wim 21:9eb628d9e164 347 virtual void _setData(int value) = 0;
wim 13:24506ba22480 348
wim 13:24506ba22480 349
wim 13:24506ba22480 350 //Display type
simon 1:ac48b187213c 351 LCDType _type;
simon 1:ac48b187213c 352
wim 21:9eb628d9e164 353 //Display mode
wim 17:652ab113bc2e 354 LCDMode _currentMode;
wim 17:652ab113bc2e 355
wim 19:c747b9e2e7b8 356 //Controller type
wim 19:c747b9e2e7b8 357 LCDCtrl _ctrl;
wim 19:c747b9e2e7b8 358
wim 15:b70ebfffb258 359 //Controller select, mainly used for LCD40x4
wim 19:c747b9e2e7b8 360 _LCDCtrl_Idx _ctrl_idx;
wim 15:b70ebfffb258 361
wim 13:24506ba22480 362 // Cursor
simon 1:ac48b187213c 363 int _column;
simon 1:ac48b187213c 364 int _row;
wim 15:b70ebfffb258 365 LCDCursor _currentCursor;
simon 1:ac48b187213c 366 };
simon 1:ac48b187213c 367
wim 23:d47f226efb24 368 //--------- End TextLCD_Base -----------
wim 22:35742ec80c24 369
wim 22:35742ec80c24 370
wim 22:35742ec80c24 371
wim 23:d47f226efb24 372 //--------- Start TextLCD Bus -----------
wim 21:9eb628d9e164 373
wim 21:9eb628d9e164 374 /** Create a TextLCD interface for using regular mbed pins
wim 21:9eb628d9e164 375 *
wim 21:9eb628d9e164 376 */
wim 21:9eb628d9e164 377 class TextLCD : public TextLCD_Base {
wim 21:9eb628d9e164 378 public:
wim 21:9eb628d9e164 379 /** Create a TextLCD interface for using regular mbed pins
wim 21:9eb628d9e164 380 *
wim 21:9eb628d9e164 381 * @param rs Instruction/data control line
wim 21:9eb628d9e164 382 * @param e Enable line (clock)
wim 21:9eb628d9e164 383 * @param d4-d7 Data lines for using as a 4-bit interface
wim 21:9eb628d9e164 384 * @param type Sets the panel size/addressing mode (default = LCD16x2)
wim 21:9eb628d9e164 385 * @param bl Backlight control line (optional, default = NC)
wim 21:9eb628d9e164 386 * @param e2 Enable2 line (clock for second controller, LCD40x4 only)
wim 21:9eb628d9e164 387 * @param ctrl LCD controller (default = HD44780)
wim 21:9eb628d9e164 388 */
wim 21:9eb628d9e164 389 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);
wim 21:9eb628d9e164 390
wim 22:35742ec80c24 391
wim 22:35742ec80c24 392 /** Destruct a TextLCD interface for using regular mbed pins
wim 22:35742ec80c24 393 *
wim 22:35742ec80c24 394 * @param none
wim 22:35742ec80c24 395 * @return none
wim 22:35742ec80c24 396 */
wim 22:35742ec80c24 397 virtual ~TextLCD();
wim 22:35742ec80c24 398
wim 21:9eb628d9e164 399 private:
wim 21:9eb628d9e164 400 //Low level writes to LCD Bus (serial or parallel)
wim 21:9eb628d9e164 401 virtual void _setEnable(bool value);
wim 21:9eb628d9e164 402 virtual void _setRS(bool value);
wim 21:9eb628d9e164 403 virtual void _setBL(bool value);
wim 21:9eb628d9e164 404 virtual void _setData(int value);
wim 21:9eb628d9e164 405
wim 22:35742ec80c24 406 /** Regular mbed pins bus
wim 22:35742ec80c24 407 */
wim 22:35742ec80c24 408 DigitalOut _rs, _e;
wim 22:35742ec80c24 409 BusOut _d;
wim 22:35742ec80c24 410
wim 22:35742ec80c24 411 /** Optional Hardware pins for the Backlight and LCD40x4 device
wim 22:35742ec80c24 412 * Default PinName value is NC, must be used as pointer to avoid issues with mbed lib and DigitalOut pins
wim 22:35742ec80c24 413 */
wim 22:35742ec80c24 414 DigitalOut *_bl, *_e2;
wim 21:9eb628d9e164 415 };
wim 21:9eb628d9e164 416
wim 22:35742ec80c24 417
wim 23:d47f226efb24 418 //----------- End TextLCD ---------------
wim 21:9eb628d9e164 419
wim 21:9eb628d9e164 420
wim 23:d47f226efb24 421 //--------- Start TextLCD_I2C -----------
wim 22:35742ec80c24 422
wim 22:35742ec80c24 423
wim 22:35742ec80c24 424 /** Create a TextLCD interface using an I2C PC8574 or PCF8574A portexpander
wim 21:9eb628d9e164 425 *
wim 21:9eb628d9e164 426 */
wim 21:9eb628d9e164 427 class TextLCD_I2C : public TextLCD_Base {
wim 21:9eb628d9e164 428 public:
wim 22:35742ec80c24 429 /** Create a TextLCD interface using an I2C PC8574 or PCF8574A portexpander
wim 21:9eb628d9e164 430 *
wim 21:9eb628d9e164 431 * @param i2c I2C Bus
wim 22:35742ec80c24 432 * @param deviceAddress I2C slave address (PCF8574 or PCF8574A, default = 0x40)
wim 21:9eb628d9e164 433 * @param type Sets the panel size/addressing mode (default = LCD16x2)
wim 21:9eb628d9e164 434 * @param ctrl LCD controller (default = HD44780)
wim 21:9eb628d9e164 435 */
wim 22:35742ec80c24 436 TextLCD_I2C(I2C *i2c, char deviceAddress = 0x40, LCDType type = LCD16x2, LCDCtrl ctrl = HD44780);
wim 21:9eb628d9e164 437
wim 21:9eb628d9e164 438 private:
wim 21:9eb628d9e164 439 //Low level writes to LCD Bus (serial or parallel)
wim 21:9eb628d9e164 440 virtual void _setEnable(bool value);
wim 21:9eb628d9e164 441 virtual void _setRS(bool value);
wim 21:9eb628d9e164 442 virtual void _setBL(bool value);
wim 21:9eb628d9e164 443 virtual void _setData(int value);
wim 21:9eb628d9e164 444
wim 21:9eb628d9e164 445 //I2C bus
wim 21:9eb628d9e164 446 I2C *_i2c;
wim 21:9eb628d9e164 447 char _slaveAddress;
wim 21:9eb628d9e164 448
wim 21:9eb628d9e164 449 // Internal bus mirror value for serial bus only
wim 21:9eb628d9e164 450 char _lcd_bus;
wim 21:9eb628d9e164 451
wim 21:9eb628d9e164 452 };
wim 21:9eb628d9e164 453
wim 21:9eb628d9e164 454
wim 23:d47f226efb24 455 //---------- End TextLCD_I2C ------------
wim 22:35742ec80c24 456
wim 22:35742ec80c24 457
wim 22:35742ec80c24 458
wim 23:d47f226efb24 459 //--------- Start TextLCD_SPI -----------
wim 22:35742ec80c24 460
wim 21:9eb628d9e164 461
wim 21:9eb628d9e164 462 /** Create a TextLCD interface using an SPI 74595 portexpander
wim 21:9eb628d9e164 463 *
wim 21:9eb628d9e164 464 */
wim 21:9eb628d9e164 465 class TextLCD_SPI : public TextLCD_Base {
wim 21:9eb628d9e164 466 public:
wim 21:9eb628d9e164 467 /** Create a TextLCD interface using an SPI 74595 portexpander
wim 21:9eb628d9e164 468 *
wim 21:9eb628d9e164 469 * @param spi SPI Bus
wim 21:9eb628d9e164 470 * @param cs chip select pin (active low)
wim 21:9eb628d9e164 471 * @param type Sets the panel size/addressing mode (default = LCD16x2)
wim 21:9eb628d9e164 472 * @param ctrl LCD controller (default = HD44780)
wim 21:9eb628d9e164 473 */
wim 21:9eb628d9e164 474 TextLCD_SPI(SPI *spi, PinName cs, LCDType type = LCD16x2, LCDCtrl ctrl = HD44780);
wim 21:9eb628d9e164 475
wim 21:9eb628d9e164 476
wim 21:9eb628d9e164 477 private:
wim 21:9eb628d9e164 478 //Low level writes to LCD Bus (serial or parallel)
wim 21:9eb628d9e164 479 virtual void _setEnable(bool value);
wim 21:9eb628d9e164 480 virtual void _setRS(bool value);
wim 21:9eb628d9e164 481 virtual void _setBL(bool value);
wim 21:9eb628d9e164 482 virtual void _setData(int value);
wim 21:9eb628d9e164 483 virtual void _setCS(bool value);
wim 21:9eb628d9e164 484
wim 21:9eb628d9e164 485 //Low level writes to LCD serial bus only
wim 21:9eb628d9e164 486 void _writeBus();
wim 21:9eb628d9e164 487
wim 21:9eb628d9e164 488 // SPI bus
wim 21:9eb628d9e164 489 SPI *_spi;
wim 21:9eb628d9e164 490 DigitalOut _cs;
wim 21:9eb628d9e164 491
wim 21:9eb628d9e164 492 // Internal bus mirror value for serial bus only
wim 21:9eb628d9e164 493 char _lcd_bus;
wim 21:9eb628d9e164 494
wim 21:9eb628d9e164 495 };
wim 21:9eb628d9e164 496
wim 23:d47f226efb24 497 //---------- End TextLCD_SPI ------------
wim 21:9eb628d9e164 498
simon 1:ac48b187213c 499 #endif