Kenji Arai
In TextLCD_I2C_N Class, added void setContrast(unsigned char c) function as temporary. This is for ST7032i non-volume type contrast control.
Dependents: LPC1114_data_logger RTC_w_COM Frequency_Counter_w_GPS_1PPS CW_Decoder_using_FFT_on_F446 ... more
Fork of
TextLCD
by 
Wim Huiskamp
In TextLCD_I2C_N Class, added void setContrast(unsigned char c) function as temporary.
TextLCD.h@31:f8e67a681560, 2020-08-04 (annotated)
- Committer:
- kenjiArai
- Date:
- Tue Aug 04 03:55:44 2020 +0000
- Revision:
- 31:f8e67a681560
- Parent:
- 30:4c57a022a56c
added #include "Stream.h" (need to run on mbed-os6.2.0)
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| kenjiArai | 30:4c57a022a56c | 1 | /* mbed TextLCD Library, for LCDs based on HD44780 controllers |
| 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 |
| wim | 25:6162b31128c9 | 11 | * 2014, v09: WH/EO, Added Class for Native SPI controllers such as ST7032 |
| kenjiArai | 30:4c57a022a56c | 12 | * 2014, v10: WH, Added Class for Native I2C controllers such as ST7032i, Added support for MCP23008 I2C portexpander, Added support for Adafruit module |
| kenjiArai | 30:4c57a022a56c | 13 | * 2014, v11: WH, Added support for native I2C controllers such as PCF21XX, Improved the _initCtrl() method to deal with differences between all supported controllers |
| kenjiArai | 30:4c57a022a56c | 14 | * 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) |
| kenjiArai | 30:4c57a022a56c | 15 | * 2014, v13: WH, Added support for controllers US2066/SSD1311 (OLED), added setUDCBlink() method for supported devices (eg SSD1803), fixed issue in setPower() |
| kenjiArai | 30:4c57a022a56c | 16 | * 2014, v14: WH, Added support for PT6314 (VFD), added setOrient() method for supported devices (eg SSD1803, US2066), added Double Height lines for supported devices, |
| kenjiArai | 30:4c57a022a56c | 17 | * added 16 UDCs for supported devices (eg PCF2103), moved UDC defines to TextLCD_UDC file, added TextLCD_Config.h for feature and footprint settings. |
| kenjiArai | 30:4c57a022a56c | 18 | * 2014, v15: WH, Added AC780 support, added I2C expander modules, fixed setBacklight() for inverted logic modules. Fixed bug in LCD_SPI_N define |
| kenjiArai | 30:4c57a022a56c | 19 | * 2014, v16: WH, Added ST7070 and KS0073 support, added setIcon(), clrIcon() and setInvert() method for supported devices |
| kenjiArai | 30:4c57a022a56c | 20 | * 2015, v17: WH, Clean up low-level _writeCommand() and _writeData(), Added support for alternative fonttables (eg PCF21XX), Added ST7066_ACM controller for ACM1602 module |
| kenjiArai | 30:4c57a022a56c | 21 | * 2015, v18: WH, Performance improvement I2C portexpander |
| kenjiArai | 30:4c57a022a56c | 22 | * 2015, v19: WH, Added 10x2D and 10x4D type for SSD1803 |
| kenjiArai | 30:4c57a022a56c | 23 | * 2015, v20: WH, Fixed occasional Init fail caused by insufficient wait time after ReturnHome command (0x02), Added defines to reduce memory footprint (eg LCD_ICON), |
| kenjiArai | 30:4c57a022a56c | 24 | * Fixed and Added more fonttable support for PCF2119R_3V3, Added HD66712 controller. |
| kenjiArai | 30:4c57a022a56c | 25 | * 2015, v21: WH, Added LCD32x2 defines and code, Fixed LCD12x4D enum, Added font enums, Added SPLC792A controller, |
| kenjiArai | 30:4c57a022a56c | 26 | * Added UTF8_2_LCD decode for Cyrilic font (By Andriy Ribalko). Added setFont() |
| simon | 1:ac48b187213c | 27 | * |
| simon | 1:ac48b187213c | 28 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| simon | 1:ac48b187213c | 29 | * of this software and associated documentation files (the "Software"), to deal |
| simon | 1:ac48b187213c | 30 | * in the Software without restriction, including without limitation the rights |
| simon | 1:ac48b187213c | 31 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| simon | 1:ac48b187213c | 32 | * copies of the Software, and to permit persons to whom the Software is |
| simon | 1:ac48b187213c | 33 | * furnished to do so, subject to the following conditions: |
| simon | 2:227356c7d12c | 34 | * |
| simon | 1:ac48b187213c | 35 | * The above copyright notice and this permission notice shall be included in |
| simon | 1:ac48b187213c | 36 | * all copies or substantial portions of the Software. |
| simon | 2:227356c7d12c | 37 | * |
| simon | 1:ac48b187213c | 38 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| simon | 1:ac48b187213c | 39 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| simon | 1:ac48b187213c | 40 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| simon | 1:ac48b187213c | 41 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| simon | 1:ac48b187213c | 42 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| simon | 1:ac48b187213c | 43 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| simon | 1:ac48b187213c | 44 | * THE SOFTWARE. |
| simon | 1:ac48b187213c | 45 | */ |
| simon | 1:ac48b187213c | 46 | |
| simon | 1:ac48b187213c | 47 | #ifndef MBED_TEXTLCD_H |
| simon | 1:ac48b187213c | 48 | #define MBED_TEXTLCD_H |
| simon | 1:ac48b187213c | 49 | |
| simon | 1:ac48b187213c | 50 | #include "mbed.h" |
| kenjiArai | 30:4c57a022a56c | 51 | #include "TextLCD_Config.h" |
| kenjiArai | 30:4c57a022a56c | 52 | #include "TextLCD_UDC.h" |
| kenjiArai | 31:f8e67a681560 | 53 | // modified by by JH1PJL |
| kenjiArai | 31:f8e67a681560 | 54 | #include "Stream.h" // Aug. 4th, 2020, need to run on mbed-os6 |
| kenjiArai | 30:4c57a022a56c | 55 | |
| kenjiArai | 30:4c57a022a56c | 56 | //// modified by by JH1PJL |
| kenjiArai | 30:4c57a022a56c | 57 | #if (MBED_MAJOR_VERSION == 2) |
| kenjiArai | 30:4c57a022a56c | 58 | #define WAIT_MS(x) wait_ms(x) |
| kenjiArai | 31:f8e67a681560 | 59 | #elif (MBED_MAJOR_VERSION == 5) || (MBED_MAJOR_VERSION == 6) |
| kenjiArai | 31:f8e67a681560 | 60 | #define WAIT_MS(x) thread_sleep_for(x) |
| kenjiArai | 30:4c57a022a56c | 61 | #else |
| kenjiArai | 30:4c57a022a56c | 62 | #warning "I cannot control wait_ms()!!" |
| kenjiArai | 30:4c57a022a56c | 63 | #endif |
| simon | 2:227356c7d12c | 64 | |
| simon | 5:a53b3e2d6f1e | 65 | /** A TextLCD interface for driving 4-bit HD44780-based LCDs |
| simon | 2:227356c7d12c | 66 | * |
| kenjiArai | 30:4c57a022a56c | 67 | * Currently supports 8x1, 8x2, 12x3, 12x4, 16x1, 16x2, 16x3, 16x4, 20x2, 20x4, 24x1, 24x2, 24x4, 40x2 and 40x4 panels. |
| wim | 27:22d5086f6ba6 | 68 | * Interface options include direct mbed pins, I2C portexpander (PCF8474/PCF8574A or MCP23008) or SPI bus shiftregister (74595). |
| kenjiArai | 30:4c57a022a56c | 69 | * Supports some controllers with native I2C or SPI interface. Supports some controllers that provide internal DC/DC converters for VLCD or VLED. |
| kenjiArai | 30:4c57a022a56c | 70 | * Supports some controllers that feature programmable contrast control, powerdown, blinking UDCs and/or top/down orientation modes. |
| simon | 2:227356c7d12c | 71 | * |
| simon | 2:227356c7d12c | 72 | * @code |
| simon | 2:227356c7d12c | 73 | * #include "mbed.h" |
| simon | 2:227356c7d12c | 74 | * #include "TextLCD.h" |
| simon | 5:a53b3e2d6f1e | 75 | * |
| wim | 16:c276b75e6585 | 76 | * // I2C Communication |
| wim | 16:c276b75e6585 | 77 | * I2C i2c_lcd(p28,p27); // SDA, SCL |
| wim | 16:c276b75e6585 | 78 | * |
| wim | 16:c276b75e6585 | 79 | * // SPI Communication |
| wim | 16:c276b75e6585 | 80 | * SPI spi_lcd(p5, NC, p7); // MOSI, MISO, SCLK |
| wim | 16:c276b75e6585 | 81 | * |
| wim | 22:35742ec80c24 | 82 | * //TextLCD lcd(p15, p16, p17, p18, p19, p20); // RS, E, D4-D7, LCDType=LCD16x2, BL=NC, E2=NC, LCDTCtrl=HD44780 |
| wim | 28:30fa94f7341c | 83 | * //TextLCD_SPI lcd(&spi_lcd, p8, TextLCD::LCD40x4); // SPI bus, 74595 expander, CS pin, LCD Type |
| kenjiArai | 30:4c57a022a56c | 84 | * TextLCD_I2C lcd(&i2c_lcd, 0x42, TextLCD::LCD20x4); // I2C bus, PCF8574 Slaveaddress, LCD Type |
| kenjiArai | 30:4c57a022a56c | 85 | * //TextLCD_I2C lcd(&i2c_lcd, 0x42, TextLCD::LCD16x2, TextLCD::WS0010); // I2C bus, PCF8574 Slaveaddress, LCD Type, Device Type (OLED) |
| wim | 27:22d5086f6ba6 | 86 | * //TextLCD_SPI_N lcd(&spi_lcd, p8, p9); // SPI bus, CS pin, RS pin, LCDType=LCD16x2, BL=NC, LCDTCtrl=ST7032_3V3 |
| kenjiArai | 30:4c57a022a56c | 87 | * //TextLCD_I2C_N lcd(&i2c_lcd, ST7032_SA, TextLCD::LCD16x2, NC, TextLCD::ST7032_3V3); // I2C bus, Slaveaddress, LCD Type, BL=NC, LCDTCtrl=ST7032_3V3 |
| kenjiArai | 30:4c57a022a56c | 88 | * //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 |
| kenjiArai | 30:4c57a022a56c | 89 | * //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) |
| kenjiArai | 30:4c57a022a56c | 90 | * |
| simon | 2:227356c7d12c | 91 | * int main() { |
| wim | 16:c276b75e6585 | 92 | * lcd.printf("Hello World!\n"); |
| simon | 2:227356c7d12c | 93 | * } |
| simon | 2:227356c7d12c | 94 | * @endcode |
| simon | 2:227356c7d12c | 95 | */ |
| wim | 8:03116f75b66e | 96 | |
| kenjiArai | 30:4c57a022a56c | 97 | //The TextLCD_Config.h file selects hardware interface options to reduce memory footprint |
| kenjiArai | 30:4c57a022a56c | 98 | //and provides Pin Defines for I2C PCF8574/PCF8574A or MCP23008 and SPI 74595 bus expander interfaces. |
| kenjiArai | 30:4c57a022a56c | 99 | //The LCD and serial portexpanders should be wired accordingly. |
| wim | 26:bd897a001012 | 100 | |
| kenjiArai | 30:4c57a022a56c | 101 | /* LCD Type information on Rows, Columns and Variant. This information is encoded in |
| kenjiArai | 30:4c57a022a56c | 102 | * an int and used for the LCDType enumerators in order to simplify code maintenance */ |
| wim | 13:24506ba22480 | 103 | |
| kenjiArai | 30:4c57a022a56c | 104 | // Type ID encoded in b7..b0 |
| kenjiArai | 30:4c57a022a56c | 105 | #define LCD_T_ID_MSK 0x000000FF |
| kenjiArai | 30:4c57a022a56c | 106 | #define LCD_T_ID_SHFT 0 |
| wim | 20:e0da005a777f | 107 | |
| kenjiArai | 30:4c57a022a56c | 108 | // Columns encoded in b15..b8 |
| kenjiArai | 30:4c57a022a56c | 109 | #define LCD_T_COL_MSK 0x0000FF00 |
| kenjiArai | 30:4c57a022a56c | 110 | #define LCD_T_COL_SHFT 8 |
| kenjiArai | 30:4c57a022a56c | 111 | #define LCD_T_C6 0x00000600 |
| kenjiArai | 30:4c57a022a56c | 112 | #define LCD_T_C8 0x00000800 |
| kenjiArai | 30:4c57a022a56c | 113 | #define LCD_T_C10 0x00000A00 |
| kenjiArai | 30:4c57a022a56c | 114 | #define LCD_T_C12 0x00000C00 |
| kenjiArai | 30:4c57a022a56c | 115 | #define LCD_T_C16 0x00001000 |
| kenjiArai | 30:4c57a022a56c | 116 | #define LCD_T_C20 0x00001400 |
| kenjiArai | 30:4c57a022a56c | 117 | #define LCD_T_C24 0x00001800 |
| kenjiArai | 30:4c57a022a56c | 118 | #define LCD_T_C32 0x00002000 |
| kenjiArai | 30:4c57a022a56c | 119 | #define LCD_T_C40 0x00002800 |
| kenjiArai | 30:4c57a022a56c | 120 | //#define LCD_T_C52 0x00003400 |
| wim | 13:24506ba22480 | 121 | |
| kenjiArai | 30:4c57a022a56c | 122 | // Rows encoded in b23..b16 |
| kenjiArai | 30:4c57a022a56c | 123 | #define LCD_T_ROW_MSK 0x00FF0000 |
| kenjiArai | 30:4c57a022a56c | 124 | #define LCD_T_ROW_SHFT 16 |
| kenjiArai | 30:4c57a022a56c | 125 | #define LCD_T_R1 0x00010000 |
| kenjiArai | 30:4c57a022a56c | 126 | #define LCD_T_R2 0x00020000 |
| kenjiArai | 30:4c57a022a56c | 127 | #define LCD_T_R3 0x00030000 |
| kenjiArai | 30:4c57a022a56c | 128 | #define LCD_T_R4 0x00040000 |
| kenjiArai | 30:4c57a022a56c | 129 | #define LCD_T_R6 0x00060000 |
| kenjiArai | 30:4c57a022a56c | 130 | |
| kenjiArai | 30:4c57a022a56c | 131 | // Addressing mode encoded in b27..b24 |
| kenjiArai | 30:4c57a022a56c | 132 | #define LCD_T_ADR_MSK 0x0F000000 |
| kenjiArai | 30:4c57a022a56c | 133 | #define LCD_T_ADR_SHFT 24 |
| kenjiArai | 30:4c57a022a56c | 134 | #define LCD_T_A 0x00000000 /*Mode A Default 1, 2 or 4 line display */ |
| kenjiArai | 30:4c57a022a56c | 135 | #define LCD_T_B 0x01000000 /*Mode B, Alternate 8x2 (actually 16x1 display) */ |
| kenjiArai | 30:4c57a022a56c | 136 | #define LCD_T_C 0x02000000 /*Mode C, Alternate 16x1 (actually 8x2 display) */ |
| kenjiArai | 30:4c57a022a56c | 137 | #define LCD_T_D 0x03000000 /*Mode D, Alternate 3 or 4 line display (12x4, 20x4, 24x4) */ |
| kenjiArai | 30:4c57a022a56c | 138 | #define LCD_T_D1 0x04000000 /*Mode D1, Alternate 3 out of 4 line display (12x3, 20x3, 24x3) */ |
| kenjiArai | 30:4c57a022a56c | 139 | #define LCD_T_E 0x05000000 /*Mode E, 40x4 display (actually two 40x2) */ |
| kenjiArai | 30:4c57a022a56c | 140 | #define LCD_T_F 0x06000000 /*Mode F, 16x3 display (actually 24x2) */ |
| kenjiArai | 30:4c57a022a56c | 141 | #define LCD_T_G 0x07000000 /*Mode G, 16x3 display */ |
| wim | 13:24506ba22480 | 142 | |
| kenjiArai | 30:4c57a022a56c | 143 | /* LCD Ctrl information on interface support and features. This information is encoded in |
| kenjiArai | 30:4c57a022a56c | 144 | * an int and used for the LCDCtrl enumerators in order to simplify code maintenance */ |
| kenjiArai | 30:4c57a022a56c | 145 | // Interface encoded in b31..b24 |
| kenjiArai | 30:4c57a022a56c | 146 | #define LCD_C_BUS_MSK 0xFF000000 |
| kenjiArai | 30:4c57a022a56c | 147 | #define LCD_C_BUS_SHFT 24 |
| kenjiArai | 30:4c57a022a56c | 148 | #define LCD_C_PAR 0x01000000 /*Parallel 4 or 8 bit data, E pin, RS pin, RW=GND */ |
| kenjiArai | 30:4c57a022a56c | 149 | #define LCD_C_SPI3_8 0x02000000 /*SPI 3 line (MOSI, SCL, CS pins), 8 bits (Count Command initiates Data transfer) */ |
| kenjiArai | 30:4c57a022a56c | 150 | #define LCD_C_SPI3_9 0x04000000 /*SPI 3 line (MOSI, SCL, CS pins), 9 bits (RS + 8 Data) */ |
| kenjiArai | 30:4c57a022a56c | 151 | #define LCD_C_SPI3_10 0x08000000 /*SPI 3 line (MOSI, SCL, CS pins), 10 bits (RS, RW + 8 Data) */ |
| kenjiArai | 30:4c57a022a56c | 152 | #define LCD_C_SPI3_16 0x10000000 /*SPI 3 line (MOSI, SCL, CS pins), 16 bits (RS, RW + 8 Data) */ |
| kenjiArai | 30:4c57a022a56c | 153 | #define LCD_C_SPI3_24 0x20000000 /*SPI 3 line (MOSI, SCL, CS pins), 24 bits (RS, RW + 8 Data) */ |
| kenjiArai | 30:4c57a022a56c | 154 | #define LCD_C_SPI4 0x40000000 /*SPI 4 line (MOSI, SCL, CS, RS pin), RS pin + 8 Data */ |
| kenjiArai | 30:4c57a022a56c | 155 | #define LCD_C_I2C 0x80000000 /*I2C (SDA, SCL pin), 8 control bits (Co, RS, RW) + 8 Data */ |
| kenjiArai | 30:4c57a022a56c | 156 | // Features encoded in b23..b16 |
| kenjiArai | 30:4c57a022a56c | 157 | #define LCD_C_FTR_MSK 0x00FF0000 |
| kenjiArai | 30:4c57a022a56c | 158 | #define LCD_C_FTR_SHFT 16 |
| kenjiArai | 30:4c57a022a56c | 159 | #define LCD_C_BST 0x00010000 /*Booster */ |
| kenjiArai | 30:4c57a022a56c | 160 | #define LCD_C_CTR 0x00020000 /*Contrast Control */ |
| kenjiArai | 30:4c57a022a56c | 161 | #define LCD_C_ICN 0x00040000 /*Icons */ |
| kenjiArai | 30:4c57a022a56c | 162 | #define LCD_C_PDN 0x00080000 /*Power Down */ |
| kenjiArai | 30:4c57a022a56c | 163 | // Fonttable encoded in b15..b12 |
| kenjiArai | 30:4c57a022a56c | 164 | #define LCD_C_FNT_MSK 0x0000F000 |
| kenjiArai | 30:4c57a022a56c | 165 | #define LCD_C_FNT_SHFT 12 |
| kenjiArai | 30:4c57a022a56c | 166 | #define LCD_C_F0 0x00000000 /*Default HD44780 UK/JAP */ |
| kenjiArai | 30:4c57a022a56c | 167 | #define LCD_C_FC 0x00001000 /*PCF21xxC */ |
| kenjiArai | 30:4c57a022a56c | 168 | #define LCD_C_FR 0x00002000 /*PCF21XXR */ |
| kenjiArai | 30:4c57a022a56c | 169 | #define LCD_C_FK 0x00003000 /*PCF21XXK */ |
| kenjiArai | 30:4c57a022a56c | 170 | #define LCD_C_FRA 0x00004000 /*SSD1803 ROM_A UK/EU */ |
| kenjiArai | 30:4c57a022a56c | 171 | #define LCD_C_FRB 0x00005000 /*SSD1803 ROM_B UK/Cyrillic */ |
| kenjiArai | 30:4c57a022a56c | 172 | #define LCD_C_FRC 0x00006000 /*SSD1803 ROM_C UK/JAP */ |
| kenjiArai | 30:4c57a022a56c | 173 | #define LCD_C_FD 0x00007000 /*SPLC780D EU/Cyrillic */ |
| kenjiArai | 30:4c57a022a56c | 174 | #define LCD_C_FT 0x00008000 /*ST7066-0T EU/Cyrillic */ |
| wim | 13:24506ba22480 | 175 | |
| kenjiArai | 30:4c57a022a56c | 176 | // Type ID encoded in b7..b0 |
| kenjiArai | 30:4c57a022a56c | 177 | #define LCD_C_ID_MSK 0x000000FF |
| kenjiArai | 30:4c57a022a56c | 178 | #define LCD_C_ID_SHFT 0 |
| wim | 11:9ec02df863a1 | 179 | |
| wim | 11:9ec02df863a1 | 180 | /** A TextLCD interface for driving 4-bit HD44780-based LCDs |
| wim | 11:9ec02df863a1 | 181 | * |
| kenjiArai | 30:4c57a022a56c | 182 | * @brief Currently supports 8x1, 8x2, 12x2, 12x3, 12x4, 16x1, 16x2, 16x3, 16x4, 20x2, 20x4, 24x2, 24x4, 40x2 and 40x4 panels |
| kenjiArai | 30:4c57a022a56c | 183 | * Interface options include direct mbed pins, I2C portexpander (PCF8474/PCF8574A or MCP23008) or |
| kenjiArai | 30:4c57a022a56c | 184 | * SPI bus shiftregister (74595) or native I2C or SPI interfaces for some supported devices. |
| wim | 11:9ec02df863a1 | 185 | */ |
| wim | 21:9eb628d9e164 | 186 | class TextLCD_Base : public Stream { |
| kenjiArai | 30:4c57a022a56c | 187 | //class TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 188 | |
| kenjiArai | 30:4c57a022a56c | 189 | //Unfortunately the following #define selection breaks Doxygen !!! |
| kenjiArai | 30:4c57a022a56c | 190 | //Add it manually when you want to disable the Stream inheritance |
| kenjiArai | 30:4c57a022a56c | 191 | //#if (LCD_PRINTF == 1) |
| kenjiArai | 30:4c57a022a56c | 192 | //class TextLCD_Base : public Stream { |
| kenjiArai | 30:4c57a022a56c | 193 | //#else |
| kenjiArai | 30:4c57a022a56c | 194 | //class TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 195 | //#endif |
| kenjiArai | 30:4c57a022a56c | 196 | |
| simon | 1:ac48b187213c | 197 | public: |
| simon | 1:ac48b187213c | 198 | |
| simon | 2:227356c7d12c | 199 | /** LCD panel format */ |
| kenjiArai | 30:4c57a022a56c | 200 | // The commented out types exist but have not yet been tested with the library |
| simon | 1:ac48b187213c | 201 | enum LCDType { |
| kenjiArai | 30:4c57a022a56c | 202 | // LCD6x1 = (LCD_T_A | LCD_T_C6 | LCD_T_R1), /**< 6x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 203 | // LCD6x2 = (LCD_T_A | LCD_T_C6 | LCD_T_R2), /**< 6x2 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 204 | LCD8x1 = (LCD_T_A | LCD_T_C8 | LCD_T_R1), /**< 8x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 205 | LCD8x2 = (LCD_T_A | LCD_T_C8 | LCD_T_R2), /**< 8x2 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 206 | LCD8x2B = (LCD_T_B | LCD_T_C8 | LCD_T_R2), /**< 8x2 LCD panel (actually 16x1) */ |
| kenjiArai | 30:4c57a022a56c | 207 | // LCD10x2D = (LCD_T_D | LCD_T_C10 | LCD_T_R2), /**< 10x2 LCD panel, special mode SSD1803, 4-line but double height */ |
| kenjiArai | 30:4c57a022a56c | 208 | LCD10x4D = (LCD_T_D | LCD_T_C10 | LCD_T_R4), /**< 10x4 LCD panel, special mode SSD1803 */ |
| kenjiArai | 30:4c57a022a56c | 209 | LCD12x1 = (LCD_T_A | LCD_T_C12 | LCD_T_R1), /**< 12x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 210 | LCD12x2 = (LCD_T_A | LCD_T_C12 | LCD_T_R2), /**< 12x2 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 211 | LCD12x3D = (LCD_T_D | LCD_T_C12 | LCD_T_R3), /**< 12x3 LCD panel, special mode PCF21XX, KS0073 */ |
| kenjiArai | 30:4c57a022a56c | 212 | LCD12x3D1 = (LCD_T_D1 | LCD_T_C12 | LCD_T_R3), /**< 12x3 LCD panel, special mode PCF21XX, KS0073 */ |
| kenjiArai | 30:4c57a022a56c | 213 | // LCD12x3G = (LCD_T_G | LCD_T_C12 | LCD_T_R3), /**< 12x3 LCD panel, special mode ST7036 */ |
| kenjiArai | 30:4c57a022a56c | 214 | LCD12x4 = (LCD_T_A | LCD_T_C12 | LCD_T_R4), /**< 12x4 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 215 | LCD12x4D = (LCD_T_D | LCD_T_C12 | LCD_T_R4), /**< 12x4 LCD panel, special mode PCF21XX, KS0073 */ |
| kenjiArai | 30:4c57a022a56c | 216 | LCD16x1 = (LCD_T_A | LCD_T_C16 | LCD_T_R1), /**< 16x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 217 | LCD16x1C = (LCD_T_C | LCD_T_C16 | LCD_T_R1), /**< 16x1 LCD panel (actually 8x2) */ |
| kenjiArai | 30:4c57a022a56c | 218 | LCD16x2 = (LCD_T_A | LCD_T_C16 | LCD_T_R2), /**< 16x2 LCD panel (default) */ |
| kenjiArai | 30:4c57a022a56c | 219 | // LCD16x2B = (LCD_T_B | LCD_T_C16 | LCD_T_R2), /**< 16x2 LCD panel, alternate addressing, wrong.. */ |
| kenjiArai | 30:4c57a022a56c | 220 | LCD16x3D = (LCD_T_D | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel, special mode SSD1803 */ |
| kenjiArai | 30:4c57a022a56c | 221 | // LCD16x3D1 = (LCD_T_D1 | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel, special mode SSD1803 */ |
| kenjiArai | 30:4c57a022a56c | 222 | LCD16x3F = (LCD_T_F | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel (actually 24x2) */ |
| kenjiArai | 30:4c57a022a56c | 223 | LCD16x3G = (LCD_T_G | LCD_T_C16 | LCD_T_R3), /**< 16x3 LCD panel, special mode ST7036 */ |
| kenjiArai | 30:4c57a022a56c | 224 | LCD16x4 = (LCD_T_A | LCD_T_C16 | LCD_T_R4), /**< 16x4 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 225 | // LCD16x4D = (LCD_T_D | LCD_T_C16 | LCD_T_R4), /**< 16x4 LCD panel, special mode SSD1803 */ |
| kenjiArai | 30:4c57a022a56c | 226 | LCD20x1 = (LCD_T_A | LCD_T_C20 | LCD_T_R1), /**< 20x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 227 | LCD20x2 = (LCD_T_A | LCD_T_C20 | LCD_T_R2), /**< 20x2 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 228 | // LCD20x3 = (LCD_T_A | LCD_T_C20 | LCD_T_R3), /**< 20x3 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 229 | // LCD20x3D = (LCD_T_D | LCD_T_C20 | LCD_T_R3), /**< 20x3 LCD panel, special mode SSD1803, KS0073 */ |
| kenjiArai | 30:4c57a022a56c | 230 | // LCD20x3D1 = (LCD_T_D1 | LCD_T_C20 | LCD_T_R3), /**< 20x3 LCD panel, special mode SSD1803, KS0073 */ |
| kenjiArai | 30:4c57a022a56c | 231 | LCD20x4 = (LCD_T_A | LCD_T_C20 | LCD_T_R4), /**< 20x4 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 232 | LCD20x4D = (LCD_T_D | LCD_T_C20 | LCD_T_R4), /**< 20x4 LCD panel, special mode SSD1803, KS0073 */ |
| kenjiArai | 30:4c57a022a56c | 233 | // LCD20x6 = (LCD_T_E | LCD_T_C20 | LCD_T_R6), /**< 20x6 LCD panel, Two controller version */ |
| kenjiArai | 30:4c57a022a56c | 234 | LCD24x1 = (LCD_T_A | LCD_T_C24 | LCD_T_R1), /**< 24x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 235 | LCD24x2 = (LCD_T_A | LCD_T_C24 | LCD_T_R2), /**< 24x2 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 236 | // LCD24x3D = (LCD_T_D | LCD_T_C24 | LCD_T_R3), /**< 24x3 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 237 | // LCD24x3D1 = (LCD_T_D | LCD_T_C24 | LCD_T_R3), /**< 24x3 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 238 | LCD24x4D = (LCD_T_D | LCD_T_C24 | LCD_T_R4), /**< 24x4 LCD panel, special mode KS0078 */ |
| kenjiArai | 30:4c57a022a56c | 239 | // LCD32x1 = (LCD_T_A | LCD_T_C32 | LCD_T_R1), /**< 32x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 240 | // LCD32x1C = (LCD_T_C | LCD_T_C32 | LCD_T_R1), /**< 32x1 LCD panel (actually 16x2) */ |
| kenjiArai | 30:4c57a022a56c | 241 | LCD32x2 = (LCD_T_A | LCD_T_C32 | LCD_T_R2), /**< 32x2 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 242 | // LCD32x4 = (LCD_T_A | LCD_T_C32 | LCD_T_R4), /**< 32x4 LCD panel, Two controller version ? */ |
| kenjiArai | 30:4c57a022a56c | 243 | // LCD40x1 = (LCD_T_A | LCD_T_C40 | LCD_T_R1), /**< 40x1 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 244 | // LCD40x1C = (LCD_T_C | LCD_T_C40 | LCD_T_R1), /**< 40x1 LCD panel (actually 20x2) */ |
| kenjiArai | 30:4c57a022a56c | 245 | LCD40x2 = (LCD_T_A | LCD_T_C40 | LCD_T_R2), /**< 40x2 LCD panel */ |
| kenjiArai | 30:4c57a022a56c | 246 | // LCD52x1 = (LCD_T_A | LCD_T_C52 | LCD_T_R1), /**< 52x1 LCD panel, special mode KS0073 */ |
| kenjiArai | 30:4c57a022a56c | 247 | #if (LCD_TWO_CTRL == 1) |
| kenjiArai | 30:4c57a022a56c | 248 | LCD40x4 = (LCD_T_E | LCD_T_C40 | LCD_T_R4) /**< 40x4 LCD panel, Two controller version */ |
| kenjiArai | 30:4c57a022a56c | 249 | #endif |
| simon | 1:ac48b187213c | 250 | }; |
| simon | 1:ac48b187213c | 251 | |
| kenjiArai | 30:4c57a022a56c | 252 | |
| wim | 19:c747b9e2e7b8 | 253 | /** LCD Controller Device */ |
| wim | 19:c747b9e2e7b8 | 254 | enum LCDCtrl { |
| kenjiArai | 30:4c57a022a56c | 255 | HD44780 = 0 | LCD_C_PAR, /**< HD44780 or full equivalent (default) */ |
| kenjiArai | 30:4c57a022a56c | 256 | AC780 = 1 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_PDN), /**< AC780/KS0066i 4/8 bit, SPI, I2C */ |
| kenjiArai | 30:4c57a022a56c | 257 | AIP31068 = 2 | (LCD_C_SPI3_9 | LCD_C_I2C | LCD_C_BST), /**< AIP31068 I2C, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 258 | KS0073 = 3 | (LCD_C_PAR | LCD_C_SPI3_24 | LCD_C_PDN), /**< KS0073 4/8 bit, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 259 | KS0078 = 4 | (LCD_C_PAR | LCD_C_SPI3_24 | LCD_C_PDN), /**< KS0078 24x4 support, 4/8 bit, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 260 | PCF2103_3V3 = 5 | (LCD_C_PAR | LCD_C_I2C), /**< PCF2103 3V3 no Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 261 | PCF2113_3V3 = 6 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< PCF2113 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 262 | PCF2116_3V3 = 7 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST), /**< PCF2116 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 263 | // PCF2116C_3V3 = | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_FC), /**< PCF2116C 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 264 | // PCF2116K_3V3 = | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_FK), /**< PCF2116K 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 265 | PCF2116_5V = 8 | (LCD_C_PAR | LCD_C_I2C), /**< PCF2116 5V no Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 266 | PCF2116C_5V = 9 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_FC), /**< PCF2116C 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 267 | PCF2119_3V3 = 10 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< PCF2119 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 268 | // PCF2119C_3V3 = 11 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_CTR | LCD_C_FC), /**< PCF2119K 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 269 | PCF2119R_3V3 = 12 | (LCD_C_PAR | LCD_C_I2C | LCD_C_BST | LCD_C_CTR | LCD_C_FR), /**< PCF2119R 3V3 with Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 270 | // PCF2119_5V = | (LCD_C_PAR | LCD_C_I2C), /**< PCF2119 5V no Booster, 4/8 bit, I2C */ |
| kenjiArai | 30:4c57a022a56c | 271 | PT6314 = 13 | (LCD_C_PAR | LCD_C_SPI3_16 | LCD_C_CTR), /**< PT6314 VFD Controller, 4/8 bit, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 272 | // PT6880 = xx | (LCD_C_PAR | LCD_C_SPI3_16 | LCD_C_CTR), /**< PT6880 OLED controller, 4/8 bit, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 273 | 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 */ |
| kenjiArai | 30:4c57a022a56c | 274 | // 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 */ |
| kenjiArai | 30:4c57a022a56c | 275 | ST7032_3V3 = 16 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< ST7032/SPLC792A 3V3 with Booster, 4/8 bit, SPI4, I2C */ |
| kenjiArai | 30:4c57a022a56c | 276 | ST7032_5V = 17 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_CTR), /**< ST7032/SPLC792A 5V no Booster, 4/8 bit, SPI4, I2C */ |
| kenjiArai | 30:4c57a022a56c | 277 | ST7036_3V3 = 18 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< ST7036 3V3 with Booster, 4/8 bit, SPI4, I2C */ |
| kenjiArai | 30:4c57a022a56c | 278 | ST7036_5V = 19 | (LCD_C_PAR | LCD_C_SPI4 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR), /**< ST7036 5V no Booster, 4/8 bit, SPI4, I2C */ |
| kenjiArai | 30:4c57a022a56c | 279 | ST7066_ACM = 20 | (LCD_C_PAR | LCD_C_I2C), /**< ST7066 4/8 bit, I2C on ACM1602 using a PIC */ |
| kenjiArai | 30:4c57a022a56c | 280 | ST7070 = 21 | (LCD_C_PAR | LCD_C_SPI3_8 | LCD_C_SPI4), /**< ST7070 4/8 bit, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 281 | US2066_3V3 = 22 | (LCD_C_PAR | LCD_C_SPI3_24 | LCD_C_I2C | LCD_C_CTR | LCD_C_PDN), /**< US2066/SSD1311 3V3, 4/8 bit, I2C, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 282 | WS0010 = 23 | (LCD_C_PAR | LCD_C_SPI3_10 | LCD_C_PDN), /**< WS0010/RS0010 OLED Controller, 4/8 bit, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 283 | // WS0012 = 24 | (LCD_C_PAR | LCD_C_SPI3_10 | LCD_C_I2C | LCD_C_PDN), /**< WS0012 4/8 bit, SPI, I2C */ |
| kenjiArai | 30:4c57a022a56c | 284 | HD66712 = 25 | (LCD_C_PAR | LCD_C_SPI3_24 | LCD_C_BST | LCD_C_PDN), /**< HD66712 Controller, 4/8 bit, SPI3 */ |
| kenjiArai | 30:4c57a022a56c | 285 | SPLC792A_3V3 = 26 | (LCD_C_PAR | LCD_C_SPI3_9 | LCD_C_SPI4 | LCD_C_I2C | LCD_C_BST | LCD_C_CTR) /**< ST7032/SPLC792A 3V3 with Booster, 4/8 bit, SPI3, SPI4, I2C */ |
| wim | 19:c747b9e2e7b8 | 286 | }; |
| wim | 19:c747b9e2e7b8 | 287 | |
| wim | 19:c747b9e2e7b8 | 288 | |
| wim | 10:dd9b3a696acd | 289 | /** LCD Cursor control */ |
| wim | 10:dd9b3a696acd | 290 | enum LCDCursor { |
| wim | 17:652ab113bc2e | 291 | CurOff_BlkOff = 0x00, /**< Cursor Off, Blinking Char Off */ |
| kenjiArai | 30:4c57a022a56c | 292 | CurOff_BlkOn = 0x01, /**< Cursor Off, Blinking Char On */ |
| kenjiArai | 30:4c57a022a56c | 293 | CurOn_BlkOff = 0x02, /**< Cursor On, Blinking Char Off */ |
| kenjiArai | 30:4c57a022a56c | 294 | CurOn_BlkOn = 0x03 /**< Cursor On, Blinking Char On */ |
| wim | 17:652ab113bc2e | 295 | }; |
| wim | 17:652ab113bc2e | 296 | |
| wim | 17:652ab113bc2e | 297 | /** LCD Display control */ |
| wim | 17:652ab113bc2e | 298 | enum LCDMode { |
| wim | 17:652ab113bc2e | 299 | DispOff = 0x00, /**< Display Off */ |
| wim | 17:652ab113bc2e | 300 | DispOn = 0x04 /**< Display On */ |
| wim | 10:dd9b3a696acd | 301 | }; |
| wim | 10:dd9b3a696acd | 302 | |
| wim | 20:e0da005a777f | 303 | /** LCD Backlight control */ |
| wim | 20:e0da005a777f | 304 | enum LCDBacklight { |
| wim | 20:e0da005a777f | 305 | LightOff, /**< Backlight Off */ |
| wim | 20:e0da005a777f | 306 | LightOn /**< Backlight On */ |
| wim | 20:e0da005a777f | 307 | }; |
| wim | 10:dd9b3a696acd | 308 | |
| kenjiArai | 30:4c57a022a56c | 309 | /** LCD Blink control (UDC), supported for some Controllers */ |
| kenjiArai | 30:4c57a022a56c | 310 | enum LCDBlink { |
| kenjiArai | 30:4c57a022a56c | 311 | BlinkOff, /**< Blink Off */ |
| kenjiArai | 30:4c57a022a56c | 312 | BlinkOn /**< Blink On */ |
| kenjiArai | 30:4c57a022a56c | 313 | }; |
| simon | 2:227356c7d12c | 314 | |
| kenjiArai | 30:4c57a022a56c | 315 | /** LCD Orientation control, supported for some Controllers */ |
| kenjiArai | 30:4c57a022a56c | 316 | enum LCDOrient { |
| kenjiArai | 30:4c57a022a56c | 317 | Top, /**< Top view */ |
| kenjiArai | 30:4c57a022a56c | 318 | Bottom /**< Upside down view */ |
| kenjiArai | 30:4c57a022a56c | 319 | }; |
| kenjiArai | 30:4c57a022a56c | 320 | |
| kenjiArai | 30:4c57a022a56c | 321 | #if (LCD_BIGFONT == 1) |
| kenjiArai | 30:4c57a022a56c | 322 | /** LCD BigFont control, supported for some Controllers */ |
| kenjiArai | 30:4c57a022a56c | 323 | enum LCDBigFont { |
| kenjiArai | 30:4c57a022a56c | 324 | None, /**< no lines */ |
| kenjiArai | 30:4c57a022a56c | 325 | TopLine, /**< 1+2 line */ |
| kenjiArai | 30:4c57a022a56c | 326 | CenterLine, /**< 2+3 line */ |
| kenjiArai | 30:4c57a022a56c | 327 | BottomLine, /**< 2+3 line or 3+4 line */ |
| kenjiArai | 30:4c57a022a56c | 328 | TopBottomLine /**< 1+2 line and 3+4 line */ |
| kenjiArai | 30:4c57a022a56c | 329 | }; |
| kenjiArai | 30:4c57a022a56c | 330 | #endif |
| kenjiArai | 30:4c57a022a56c | 331 | |
| kenjiArai | 30:4c57a022a56c | 332 | #if (LCD_FONTSEL == 1) |
| kenjiArai | 30:4c57a022a56c | 333 | /** LCD setFont control. |
| kenjiArai | 30:4c57a022a56c | 334 | Note: most controllers support only one font and the hardware specific |
| kenjiArai | 30:4c57a022a56c | 335 | fonttable is encoded as part of the controller type number (eg PCF21XXC or PCF21XXR). |
| kenjiArai | 30:4c57a022a56c | 336 | Some controllers support multiple tables that can only be selected by logic levels on a few pins. |
| kenjiArai | 30:4c57a022a56c | 337 | Some controllers also support runtime fontable switching through a specific instruction */ |
| kenjiArai | 30:4c57a022a56c | 338 | enum LCDFont { |
| kenjiArai | 30:4c57a022a56c | 339 | /**< HD44780 fonttable */ |
| kenjiArai | 30:4c57a022a56c | 340 | Font_0 = LCD_C_F0, /**< default, UK/JAP */ |
| kenjiArai | 30:4c57a022a56c | 341 | /**< PCF21XX fonttables */ |
| kenjiArai | 30:4c57a022a56c | 342 | Font_C = LCD_C_FC, /**< PCF21XXC */ |
| kenjiArai | 30:4c57a022a56c | 343 | Font_R = LCD_C_FR, /**< PCF21XXR */ |
| kenjiArai | 30:4c57a022a56c | 344 | /**< SSD1803 ROM tables */ |
| kenjiArai | 30:4c57a022a56c | 345 | Font_RA = LCD_C_FRA, /**< UK/EU */ |
| kenjiArai | 30:4c57a022a56c | 346 | Font_RB = LCD_C_FRB, /**< UK/Cyrillic */ |
| kenjiArai | 30:4c57a022a56c | 347 | Font_RC = LCD_C_FRC, /**< default, UK/JAP */ |
| kenjiArai | 30:4c57a022a56c | 348 | Font_D = LCD_C_FD, /**< SPLC780D Cyrillic */ |
| kenjiArai | 30:4c57a022a56c | 349 | Font_T = LCD_C_FT /**< ST7066-0T Cyrillic */ |
| kenjiArai | 30:4c57a022a56c | 350 | }; |
| kenjiArai | 30:4c57a022a56c | 351 | #endif |
| kenjiArai | 30:4c57a022a56c | 352 | |
| kenjiArai | 30:4c57a022a56c | 353 | #if ((LCD_C_FONT == 1) || (LCD_R_FONT == 1)) //PCF21xxC or PCF21xxR font |
| kenjiArai | 30:4c57a022a56c | 354 | /** Convert ASCII character code to the LCD fonttable code |
| kenjiArai | 30:4c57a022a56c | 355 | * |
| kenjiArai | 30:4c57a022a56c | 356 | * @param c The character to write to the display |
| kenjiArai | 30:4c57a022a56c | 357 | * @return The character code for the specific fonttable of the controller |
| kenjiArai | 30:4c57a022a56c | 358 | */ |
| kenjiArai | 30:4c57a022a56c | 359 | int ASCII_2_LCD (int c); |
| kenjiArai | 30:4c57a022a56c | 360 | #endif |
| kenjiArai | 30:4c57a022a56c | 361 | |
| kenjiArai | 30:4c57a022a56c | 362 | #if(LCD_UTF8_FONT == 1) |
| kenjiArai | 30:4c57a022a56c | 363 | /** Convert UTF8 2-byte character code to the LCD fonttable code |
| kenjiArai | 30:4c57a022a56c | 364 | * @param c The character to write to the display |
| kenjiArai | 30:4c57a022a56c | 365 | * @return character code for the specific fonttable of the controller or -1 if UTF8 code is not yet complete or incorrect |
| kenjiArai | 30:4c57a022a56c | 366 | * |
| kenjiArai | 30:4c57a022a56c | 367 | * Orig by Andriy, Modified by WH |
| kenjiArai | 30:4c57a022a56c | 368 | * |
| kenjiArai | 30:4c57a022a56c | 369 | * Note: The UTF8 decoding table for a specific controller is defined and selected in file TextLCD_UTF8.inc |
| kenjiArai | 30:4c57a022a56c | 370 | * The table is accessed in this UTF_2_LCD() method through |
| kenjiArai | 30:4c57a022a56c | 371 | * #define UTF_FIRST, UTF_LAST, UTF_SEQ_REC_FIRST, UTF_SEQ_REC_LAST and |
| kenjiArai | 30:4c57a022a56c | 372 | * #define UTF_SEQ_RECODE and UTF_RND_RECODE |
| kenjiArai | 30:4c57a022a56c | 373 | */ |
| kenjiArai | 30:4c57a022a56c | 374 | int UTF_2_LCD (int c); |
| kenjiArai | 30:4c57a022a56c | 375 | #endif |
| kenjiArai | 30:4c57a022a56c | 376 | |
| kenjiArai | 30:4c57a022a56c | 377 | |
| kenjiArai | 30:4c57a022a56c | 378 | #if(LCD_PRINTF != 1) |
| kenjiArai | 30:4c57a022a56c | 379 | /** Write a character to the LCD |
| kenjiArai | 30:4c57a022a56c | 380 | * |
| kenjiArai | 30:4c57a022a56c | 381 | * @param c The character to write to the display |
| kenjiArai | 30:4c57a022a56c | 382 | */ |
| kenjiArai | 30:4c57a022a56c | 383 | int putc(int c); |
| kenjiArai | 30:4c57a022a56c | 384 | |
| kenjiArai | 30:4c57a022a56c | 385 | /** Write a raw string to the LCD |
| kenjiArai | 30:4c57a022a56c | 386 | * |
| kenjiArai | 30:4c57a022a56c | 387 | * @param string text, may be followed by variables to emulate formatting the string. |
| kenjiArai | 30:4c57a022a56c | 388 | * However, printf formatting is NOT supported and variables will be ignored! |
| kenjiArai | 30:4c57a022a56c | 389 | */ |
| kenjiArai | 30:4c57a022a56c | 390 | int printf(const char* text, ...); |
| kenjiArai | 30:4c57a022a56c | 391 | #else |
| simon | 2:227356c7d12c | 392 | #if DOXYGEN_ONLY |
| simon | 2:227356c7d12c | 393 | /** Write a character to the LCD |
| simon | 2:227356c7d12c | 394 | * |
| simon | 2:227356c7d12c | 395 | * @param c The character to write to the display |
| simon | 2:227356c7d12c | 396 | */ |
| simon | 2:227356c7d12c | 397 | int putc(int c); |
| simon | 2:227356c7d12c | 398 | |
| kenjiArai | 30:4c57a022a56c | 399 | /** Write a formatted string to the LCD |
| simon | 2:227356c7d12c | 400 | * |
| simon | 2:227356c7d12c | 401 | * @param format A printf-style format string, followed by the |
| kenjiArai | 30:4c57a022a56c | 402 | * variables to use in formatting the string. |
| simon | 2:227356c7d12c | 403 | */ |
| kenjiArai | 30:4c57a022a56c | 404 | int printf(const char* format, ...); |
| simon | 2:227356c7d12c | 405 | #endif |
| kenjiArai | 30:4c57a022a56c | 406 | |
| kenjiArai | 30:4c57a022a56c | 407 | #endif |
| simon | 2:227356c7d12c | 408 | |
| kenjiArai | 30:4c57a022a56c | 409 | /** Locate cursor to a screen column and row |
| simon | 2:227356c7d12c | 410 | * |
| simon | 2:227356c7d12c | 411 | * @param column The horizontal position from the left, indexed from 0 |
| simon | 2:227356c7d12c | 412 | * @param row The vertical position from the top, indexed from 0 |
| simon | 2:227356c7d12c | 413 | */ |
| simon | 1:ac48b187213c | 414 | void locate(int column, int row); |
| simon | 2:227356c7d12c | 415 | |
| wim | 10:dd9b3a696acd | 416 | /** Return the memoryaddress of screen column and row location |
| wim | 10:dd9b3a696acd | 417 | * |
| wim | 10:dd9b3a696acd | 418 | * @param column The horizontal position from the left, indexed from 0 |
| wim | 10:dd9b3a696acd | 419 | * @param row The vertical position from the top, indexed from 0 |
| kenjiArai | 30:4c57a022a56c | 420 | * @return The memoryaddress of screen column and row location |
| wim | 10:dd9b3a696acd | 421 | */ |
| kenjiArai | 30:4c57a022a56c | 422 | int getAddress(int column, int row); |
| wim | 10:dd9b3a696acd | 423 | |
| wim | 10:dd9b3a696acd | 424 | /** Set the memoryaddress of screen column and row location |
| wim | 10:dd9b3a696acd | 425 | * |
| wim | 10:dd9b3a696acd | 426 | * @param column The horizontal position from the left, indexed from 0 |
| wim | 10:dd9b3a696acd | 427 | * @param row The vertical position from the top, indexed from 0 |
| wim | 10:dd9b3a696acd | 428 | */ |
| wim | 9:0893d986e717 | 429 | void setAddress(int column, int row); |
| wim | 9:0893d986e717 | 430 | |
| wim | 22:35742ec80c24 | 431 | /** Clear the screen and locate to 0,0 |
| wim | 22:35742ec80c24 | 432 | */ |
| simon | 1:ac48b187213c | 433 | void cls(); |
| simon | 2:227356c7d12c | 434 | |
| wim | 10:dd9b3a696acd | 435 | /** Return the number of rows |
| wim | 10:dd9b3a696acd | 436 | * |
| kenjiArai | 30:4c57a022a56c | 437 | * @return The number of rows |
| wim | 10:dd9b3a696acd | 438 | */ |
| simon | 1:ac48b187213c | 439 | int rows(); |
| wim | 10:dd9b3a696acd | 440 | |
| wim | 10:dd9b3a696acd | 441 | /** Return the number of columns |
| wim | 10:dd9b3a696acd | 442 | * |
| kenjiArai | 30:4c57a022a56c | 443 | * @return The number of columns |
| wim | 10:dd9b3a696acd | 444 | */ |
| wim | 10:dd9b3a696acd | 445 | int columns(); |
| simon | 2:227356c7d12c | 446 | |
| wim | 11:9ec02df863a1 | 447 | /** Set the Cursormode |
| wim | 11:9ec02df863a1 | 448 | * |
| wim | 17:652ab113bc2e | 449 | * @param cursorMode The Cursor mode (CurOff_BlkOff, CurOn_BlkOff, CurOff_BlkOn, CurOn_BlkOn) |
| wim | 11:9ec02df863a1 | 450 | */ |
| wim | 17:652ab113bc2e | 451 | void setCursor(LCDCursor cursorMode); |
| wim | 17:652ab113bc2e | 452 | |
| wim | 17:652ab113bc2e | 453 | /** Set the Displaymode |
| wim | 17:652ab113bc2e | 454 | * |
| wim | 17:652ab113bc2e | 455 | * @param displayMode The Display mode (DispOff, DispOn) |
| wim | 17:652ab113bc2e | 456 | */ |
| wim | 21:9eb628d9e164 | 457 | void setMode(LCDMode displayMode); |
| wim | 11:9ec02df863a1 | 458 | |
| wim | 20:e0da005a777f | 459 | /** Set the Backlight mode |
| wim | 20:e0da005a777f | 460 | * |
| wim | 21:9eb628d9e164 | 461 | * @param backlightMode The Backlight mode (LightOff, LightOn) |
| wim | 20:e0da005a777f | 462 | */ |
| wim | 21:9eb628d9e164 | 463 | void setBacklight(LCDBacklight backlightMode); |
| wim | 20:e0da005a777f | 464 | |
| kenjiArai | 30:4c57a022a56c | 465 | /** Set User Defined Characters (UDC) |
| wim | 11:9ec02df863a1 | 466 | * |
| kenjiArai | 30:4c57a022a56c | 467 | * @param unsigned char c The Index of the UDC (0..7) for HD44780 clones and (0..15) for some more advanced controllers |
| kenjiArai | 30:4c57a022a56c | 468 | * @param char *udc_data The bitpatterns for the UDC (8 bytes of 5 significant bits for bitpattern and 3 bits for blinkmode (advanced types)) |
| wim | 11:9ec02df863a1 | 469 | */ |
| wim | 11:9ec02df863a1 | 470 | void setUDC(unsigned char c, char *udc_data); |
| wim | 11:9ec02df863a1 | 471 | |
| kenjiArai | 30:4c57a022a56c | 472 | #if(LCD_BLINK == 1) |
| kenjiArai | 30:4c57a022a56c | 473 | /** Set UDC Blink and Icon blink |
| kenjiArai | 30:4c57a022a56c | 474 | * setUDCBlink method is supported by some compatible devices (eg SSD1803) |
| kenjiArai | 30:4c57a022a56c | 475 | * |
| kenjiArai | 30:4c57a022a56c | 476 | * @param blinkMode The Blink mode (BlinkOff, BlinkOn) |
| kenjiArai | 30:4c57a022a56c | 477 | */ |
| kenjiArai | 30:4c57a022a56c | 478 | void setUDCBlink(LCDBlink blinkMode); |
| kenjiArai | 30:4c57a022a56c | 479 | #endif |
| kenjiArai | 30:4c57a022a56c | 480 | |
| kenjiArai | 30:4c57a022a56c | 481 | #if(LCD_CONTRAST == 1) |
| kenjiArai | 29:986538f94abe | 482 | /** Set Contrast |
| kenjiArai | 30:4c57a022a56c | 483 | * setContrast method is supported by some compatible devices (eg ST7032i) that have onboard LCD voltage generation |
| kenjiArai | 30:4c57a022a56c | 484 | * Code imported from fork by JH1PJL |
| kenjiArai | 30:4c57a022a56c | 485 | * |
| kenjiArai | 30:4c57a022a56c | 486 | * @param unsigned char c contrast data (6 significant bits, valid range 0..63, Value 0 will disable the Vgen) |
| kenjiArai | 30:4c57a022a56c | 487 | * @return none |
| kenjiArai | 30:4c57a022a56c | 488 | */ |
| kenjiArai | 30:4c57a022a56c | 489 | void setContrast(unsigned char c = LCD_DEF_CONTRAST); |
| kenjiArai | 30:4c57a022a56c | 490 | #endif |
| kenjiArai | 30:4c57a022a56c | 491 | |
| kenjiArai | 30:4c57a022a56c | 492 | #if(LCD_POWER == 1) |
| kenjiArai | 30:4c57a022a56c | 493 | /** Set Power |
| kenjiArai | 30:4c57a022a56c | 494 | * setPower method is supported by some compatible devices (eg SSD1803) that have power down modes |
| kenjiArai | 30:4c57a022a56c | 495 | * |
| kenjiArai | 30:4c57a022a56c | 496 | * @param bool powerOn Power on/off |
| kenjiArai | 30:4c57a022a56c | 497 | * @return none |
| kenjiArai | 30:4c57a022a56c | 498 | */ |
| kenjiArai | 30:4c57a022a56c | 499 | void setPower(bool powerOn = true); |
| kenjiArai | 30:4c57a022a56c | 500 | #endif |
| kenjiArai | 30:4c57a022a56c | 501 | |
| kenjiArai | 30:4c57a022a56c | 502 | #if(LCD_ORIENT == 1) |
| kenjiArai | 30:4c57a022a56c | 503 | /** Set Orient |
| kenjiArai | 30:4c57a022a56c | 504 | * setOrient method is supported by some compatible devices (eg SSD1803, US2066) that have top/bottom view modes |
| kenjiArai | 30:4c57a022a56c | 505 | * |
| kenjiArai | 30:4c57a022a56c | 506 | * @param LCDOrient orient Orientation |
| kenjiArai | 30:4c57a022a56c | 507 | * @return none |
| kenjiArai | 30:4c57a022a56c | 508 | */ |
| kenjiArai | 30:4c57a022a56c | 509 | void setOrient(LCDOrient orient = Top); |
| kenjiArai | 30:4c57a022a56c | 510 | #endif |
| kenjiArai | 30:4c57a022a56c | 511 | |
| kenjiArai | 30:4c57a022a56c | 512 | #if(LCD_BIGFONT == 1) |
| kenjiArai | 30:4c57a022a56c | 513 | /** Set Big Font |
| kenjiArai | 30:4c57a022a56c | 514 | * setBigFont method is supported by some compatible devices (eg SSD1803, US2066) |
| kenjiArai | 29:986538f94abe | 515 | * |
| kenjiArai | 30:4c57a022a56c | 516 | * @param lines The selected Big Font lines (None, TopLine, CenterLine, BottomLine, TopBottomLine) |
| kenjiArai | 30:4c57a022a56c | 517 | * Double height characters can be shown on lines 1+2, 2+3, 3+4 or 1+2 and 3+4 |
| kenjiArai | 30:4c57a022a56c | 518 | * Valid double height lines depend on the LCDs number of rows. |
| kenjiArai | 30:4c57a022a56c | 519 | * @return none |
| kenjiArai | 30:4c57a022a56c | 520 | */ |
| kenjiArai | 30:4c57a022a56c | 521 | void setBigFont(LCDBigFont lines); |
| kenjiArai | 30:4c57a022a56c | 522 | #endif |
| kenjiArai | 30:4c57a022a56c | 523 | |
| kenjiArai | 30:4c57a022a56c | 524 | #if(LCD_FONTSEL == 1) |
| kenjiArai | 30:4c57a022a56c | 525 | /** Set Font |
| kenjiArai | 30:4c57a022a56c | 526 | * setFont method is supported by some compatible devices (eg SSD1803, US2066, ST7070) |
| kenjiArai | 30:4c57a022a56c | 527 | * |
| kenjiArai | 30:4c57a022a56c | 528 | * @param LCDFont font The selected Font |
| kenjiArai | 30:4c57a022a56c | 529 | * @return none |
| kenjiArai | 29:986538f94abe | 530 | */ |
| kenjiArai | 30:4c57a022a56c | 531 | void setFont(LCDFont font = Font_0); |
| kenjiArai | 30:4c57a022a56c | 532 | #endif |
| kenjiArai | 30:4c57a022a56c | 533 | |
| kenjiArai | 30:4c57a022a56c | 534 | |
| kenjiArai | 30:4c57a022a56c | 535 | #if(LCD_ICON==1) |
| kenjiArai | 30:4c57a022a56c | 536 | /** Set Icons |
| kenjiArai | 30:4c57a022a56c | 537 | * |
| kenjiArai | 30:4c57a022a56c | 538 | * @param unsigned char idx The Index of the icon pattern (0..15) for KS0073 and similar controllers |
| kenjiArai | 30:4c57a022a56c | 539 | * and Index (0..31) for PCF2103 and similar controllers |
| kenjiArai | 30:4c57a022a56c | 540 | * @param unsigned char data The bitpattern for the icons (6 lsb for KS0073 bitpattern (5 lsb for KS0078) and 2 msb for blinkmode) |
| kenjiArai | 30:4c57a022a56c | 541 | * The bitpattern for the PCF2103 icons is 5 lsb (UDC 0..2) and 5 lsb for blinkmode (UDC 4..6) |
| kenjiArai | 30:4c57a022a56c | 542 | */ |
| kenjiArai | 30:4c57a022a56c | 543 | void setIcon(unsigned char idx, unsigned char data); |
| kenjiArai | 30:4c57a022a56c | 544 | |
| kenjiArai | 30:4c57a022a56c | 545 | /** Clear Icons |
| kenjiArai | 30:4c57a022a56c | 546 | * |
| kenjiArai | 30:4c57a022a56c | 547 | * @param none |
| kenjiArai | 30:4c57a022a56c | 548 | * @return none |
| kenjiArai | 30:4c57a022a56c | 549 | */ |
| kenjiArai | 30:4c57a022a56c | 550 | //@TODO Add support for 40x4 dual controller |
| kenjiArai | 30:4c57a022a56c | 551 | void clrIcon(); |
| kenjiArai | 30:4c57a022a56c | 552 | #endif |
| kenjiArai | 30:4c57a022a56c | 553 | |
| kenjiArai | 30:4c57a022a56c | 554 | #if(LCD_INVERT == 1) |
| kenjiArai | 30:4c57a022a56c | 555 | /** Set Invert |
| kenjiArai | 30:4c57a022a56c | 556 | * setInvert method is supported by some compatible devices (eg KS0073) to swap between black and white |
| kenjiArai | 30:4c57a022a56c | 557 | * |
| kenjiArai | 30:4c57a022a56c | 558 | * @param bool invertOn Invert on/off |
| kenjiArai | 30:4c57a022a56c | 559 | * @return none |
| kenjiArai | 30:4c57a022a56c | 560 | */ |
| kenjiArai | 30:4c57a022a56c | 561 | //@TODO Add support for 40x4 dual controller |
| kenjiArai | 30:4c57a022a56c | 562 | void setInvert(bool invertOn); |
| kenjiArai | 30:4c57a022a56c | 563 | #endif |
| kenjiArai | 30:4c57a022a56c | 564 | |
| simon | 1:ac48b187213c | 565 | protected: |
| wim | 13:24506ba22480 | 566 | |
| wim | 21:9eb628d9e164 | 567 | /** LCD controller select, mainly used for LCD40x4 |
| wim | 21:9eb628d9e164 | 568 | */ |
| wim | 19:c747b9e2e7b8 | 569 | enum _LCDCtrl_Idx { |
| wim | 15:b70ebfffb258 | 570 | _LCDCtrl_0, /*< Primary */ |
| wim | 15:b70ebfffb258 | 571 | _LCDCtrl_1, /*< Secondary */ |
| wim | 15:b70ebfffb258 | 572 | }; |
| wim | 21:9eb628d9e164 | 573 | |
| kenjiArai | 30:4c57a022a56c | 574 | /** LCD Datalength control to select between 4 or 8 bit data/commands, mainly used for native Serial interface */ |
| kenjiArai | 30:4c57a022a56c | 575 | enum _LCDDatalength { |
| kenjiArai | 30:4c57a022a56c | 576 | _LCD_DL_4 = 0x00, /**< Datalength 4 bit */ |
| kenjiArai | 30:4c57a022a56c | 577 | _LCD_DL_8 = 0x10 /**< Datalength 8 bit */ |
| kenjiArai | 30:4c57a022a56c | 578 | }; |
| kenjiArai | 30:4c57a022a56c | 579 | |
| wim | 21:9eb628d9e164 | 580 | /** Create a TextLCD_Base interface |
| wim | 21:9eb628d9e164 | 581 | * @brief Base class, can not be instantiated |
| wim | 21:9eb628d9e164 | 582 | * |
| wim | 21:9eb628d9e164 | 583 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| wim | 21:9eb628d9e164 | 584 | * @param ctrl LCD controller (default = HD44780) |
| wim | 21:9eb628d9e164 | 585 | */ |
| wim | 21:9eb628d9e164 | 586 | TextLCD_Base(LCDType type = LCD16x2, LCDCtrl ctrl = HD44780); |
| wim | 15:b70ebfffb258 | 587 | |
| simon | 1:ac48b187213c | 588 | // Stream implementation functions |
| simon | 1:ac48b187213c | 589 | virtual int _putc(int value); |
| simon | 1:ac48b187213c | 590 | virtual int _getc(); |
| simon | 1:ac48b187213c | 591 | |
| kenjiArai | 30:4c57a022a56c | 592 | /** Medium level initialisation method for LCD controller |
| kenjiArai | 30:4c57a022a56c | 593 | * @param _LCDDatalength dl sets the datalength of data/commands |
| kenjiArai | 30:4c57a022a56c | 594 | * @return none |
| kenjiArai | 30:4c57a022a56c | 595 | */ |
| kenjiArai | 30:4c57a022a56c | 596 | void _init(_LCDDatalength dl = _LCD_DL_4); |
| kenjiArai | 30:4c57a022a56c | 597 | |
| kenjiArai | 30:4c57a022a56c | 598 | /** Low level initialisation method for LCD controller |
| kenjiArai | 30:4c57a022a56c | 599 | * Set number of lines, fonttype, no cursor etc |
| kenjiArai | 30:4c57a022a56c | 600 | * The controller is accessed in 4-bit parallel mode either directly via mbed pins or through I2C or SPI expander. |
| kenjiArai | 30:4c57a022a56c | 601 | * Some controllers also support native I2C or SPI interfaces. |
| kenjiArai | 30:4c57a022a56c | 602 | * |
| kenjiArai | 30:4c57a022a56c | 603 | * @param _LCDDatalength dl sets the 4 or 8 bit datalength of data/commands. Required for some native serial modes. |
| kenjiArai | 30:4c57a022a56c | 604 | * @return none |
| wim | 21:9eb628d9e164 | 605 | */ |
| kenjiArai | 30:4c57a022a56c | 606 | void _initCtrl(_LCDDatalength dl = _LCD_DL_4); |
| kenjiArai | 30:4c57a022a56c | 607 | |
| kenjiArai | 30:4c57a022a56c | 608 | /** Low level character address set method |
| kenjiArai | 30:4c57a022a56c | 609 | */ |
| wim | 13:24506ba22480 | 610 | int _address(int column, int row); |
| kenjiArai | 30:4c57a022a56c | 611 | |
| kenjiArai | 30:4c57a022a56c | 612 | /** Low level cursor enable or disable method |
| kenjiArai | 30:4c57a022a56c | 613 | */ |
| wim | 21:9eb628d9e164 | 614 | void _setCursor(LCDCursor show); |
| kenjiArai | 30:4c57a022a56c | 615 | |
| kenjiArai | 30:4c57a022a56c | 616 | /** Low level method to store user defined characters for current controller |
| kenjiArai | 30:4c57a022a56c | 617 | * |
| kenjiArai | 30:4c57a022a56c | 618 | * @param unsigned char c The Index of the UDC (0..7) for HD44780 clones and (0..15) for some more advanced controllers |
| kenjiArai | 30:4c57a022a56c | 619 | * @param char *udc_data The bitpatterns for the UDC (8 bytes of 5 significant bits) |
| kenjiArai | 30:4c57a022a56c | 620 | */ |
| wim | 17:652ab113bc2e | 621 | void _setUDC(unsigned char c, char *udc_data); |
| kenjiArai | 30:4c57a022a56c | 622 | |
| kenjiArai | 30:4c57a022a56c | 623 | /** Low level method to restore the cursortype and display mode for current controller |
| kenjiArai | 30:4c57a022a56c | 624 | */ |
| wim | 21:9eb628d9e164 | 625 | void _setCursorAndDisplayMode(LCDMode displayMode, LCDCursor cursorType); |
| wim | 13:24506ba22480 | 626 | |
| kenjiArai | 30:4c57a022a56c | 627 | /** Low level nibble write operation to LCD controller (serial or parallel) |
| wim | 21:9eb628d9e164 | 628 | */ |
| wim | 17:652ab113bc2e | 629 | void _writeNibble(int value); |
| kenjiArai | 30:4c57a022a56c | 630 | |
| kenjiArai | 30:4c57a022a56c | 631 | /** Low level command byte write operation to LCD controller. |
| kenjiArai | 30:4c57a022a56c | 632 | * Methods resets the RS bit and provides the required timing for the command. |
| kenjiArai | 30:4c57a022a56c | 633 | */ |
| wim | 15:b70ebfffb258 | 634 | void _writeCommand(int command); |
| kenjiArai | 30:4c57a022a56c | 635 | |
| kenjiArai | 30:4c57a022a56c | 636 | /** Low level data byte write operation to LCD controller (serial or parallel). |
| kenjiArai | 30:4c57a022a56c | 637 | * Methods sets the RS bit and provides the required timing for the data. |
| kenjiArai | 30:4c57a022a56c | 638 | */ |
| wim | 15:b70ebfffb258 | 639 | void _writeData(int data); |
| wim | 15:b70ebfffb258 | 640 | |
| wim | 21:9eb628d9e164 | 641 | /** Pure Virtual Low level writes to LCD Bus (serial or parallel) |
| kenjiArai | 30:4c57a022a56c | 642 | * Set the Enable pin. |
| wim | 21:9eb628d9e164 | 643 | */ |
| wim | 21:9eb628d9e164 | 644 | virtual void _setEnable(bool value) = 0; |
| kenjiArai | 30:4c57a022a56c | 645 | |
| kenjiArai | 30:4c57a022a56c | 646 | /** Pure Virtual Low level writes to LCD Bus (serial or parallel) |
| kenjiArai | 30:4c57a022a56c | 647 | * Set the RS pin ( 0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 648 | */ |
| wim | 21:9eb628d9e164 | 649 | virtual void _setRS(bool value) = 0; |
| kenjiArai | 30:4c57a022a56c | 650 | |
| kenjiArai | 30:4c57a022a56c | 651 | /** Pure Virtual Low level writes to LCD Bus (serial or parallel) |
| kenjiArai | 30:4c57a022a56c | 652 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 653 | */ |
| wim | 21:9eb628d9e164 | 654 | virtual void _setBL(bool value) = 0; |
| kenjiArai | 30:4c57a022a56c | 655 | |
| kenjiArai | 30:4c57a022a56c | 656 | /** Pure Virtual Low level writes to LCD Bus (serial or parallel) |
| kenjiArai | 30:4c57a022a56c | 657 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 658 | */ |
| wim | 21:9eb628d9e164 | 659 | virtual void _setData(int value) = 0; |
| wim | 13:24506ba22480 | 660 | |
| kenjiArai | 30:4c57a022a56c | 661 | /** Low level byte write operation to LCD controller (serial or parallel) |
| kenjiArai | 30:4c57a022a56c | 662 | * Depending on the RS pin this byte will be interpreted as data or command |
| kenjiArai | 30:4c57a022a56c | 663 | */ |
| kenjiArai | 30:4c57a022a56c | 664 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 665 | |
| wim | 13:24506ba22480 | 666 | //Display type |
| kenjiArai | 30:4c57a022a56c | 667 | LCDType _type; // Display type |
| kenjiArai | 30:4c57a022a56c | 668 | int _nr_cols; |
| kenjiArai | 30:4c57a022a56c | 669 | int _nr_rows; |
| kenjiArai | 30:4c57a022a56c | 670 | int _addr_mode; // Addressing mode of LCDType, defines relation between display row,col and controller memory address |
| kenjiArai | 30:4c57a022a56c | 671 | |
| wim | 21:9eb628d9e164 | 672 | //Display mode |
| wim | 17:652ab113bc2e | 673 | LCDMode _currentMode; |
| wim | 17:652ab113bc2e | 674 | |
| wim | 19:c747b9e2e7b8 | 675 | //Controller type |
| kenjiArai | 30:4c57a022a56c | 676 | LCDCtrl _ctrl; // Controller type |
| kenjiArai | 30:4c57a022a56c | 677 | int _font; // ASCII character fonttable |
| kenjiArai | 30:4c57a022a56c | 678 | |
| wim | 15:b70ebfffb258 | 679 | //Controller select, mainly used for LCD40x4 |
| wim | 19:c747b9e2e7b8 | 680 | _LCDCtrl_Idx _ctrl_idx; |
| wim | 15:b70ebfffb258 | 681 | |
| wim | 13:24506ba22480 | 682 | // Cursor |
| simon | 1:ac48b187213c | 683 | int _column; |
| simon | 1:ac48b187213c | 684 | int _row; |
| kenjiArai | 30:4c57a022a56c | 685 | LCDCursor _currentCursor; |
| kenjiArai | 30:4c57a022a56c | 686 | |
| kenjiArai | 30:4c57a022a56c | 687 | // Function modes saved to allow switch between Instruction sets after initialisation time |
| kenjiArai | 30:4c57a022a56c | 688 | int _function, _function_1, _function_x; |
| kenjiArai | 30:4c57a022a56c | 689 | |
| kenjiArai | 30:4c57a022a56c | 690 | // Icon, Booster mode and contrast saved to allow contrast change at later time |
| kenjiArai | 30:4c57a022a56c | 691 | // Only available for controllers with added features |
| kenjiArai | 30:4c57a022a56c | 692 | int _icon_power, _contrast; |
| simon | 1:ac48b187213c | 693 | }; |
| simon | 1:ac48b187213c | 694 | |
| wim | 23:d47f226efb24 | 695 | //--------- End TextLCD_Base ----------- |
| wim | 22:35742ec80c24 | 696 | |
| wim | 22:35742ec80c24 | 697 | |
| wim | 23:d47f226efb24 | 698 | //--------- Start TextLCD Bus ----------- |
| wim | 21:9eb628d9e164 | 699 | |
| wim | 21:9eb628d9e164 | 700 | /** Create a TextLCD interface for using regular mbed pins |
| wim | 21:9eb628d9e164 | 701 | * |
| wim | 21:9eb628d9e164 | 702 | */ |
| wim | 21:9eb628d9e164 | 703 | class TextLCD : public TextLCD_Base { |
| wim | 21:9eb628d9e164 | 704 | public: |
| wim | 21:9eb628d9e164 | 705 | /** Create a TextLCD interface for using regular mbed pins |
| wim | 21:9eb628d9e164 | 706 | * |
| wim | 21:9eb628d9e164 | 707 | * @param rs Instruction/data control line |
| wim | 21:9eb628d9e164 | 708 | * @param e Enable line (clock) |
| wim | 21:9eb628d9e164 | 709 | * @param d4-d7 Data lines for using as a 4-bit interface |
| wim | 21:9eb628d9e164 | 710 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| wim | 21:9eb628d9e164 | 711 | * @param bl Backlight control line (optional, default = NC) |
| wim | 21:9eb628d9e164 | 712 | * @param e2 Enable2 line (clock for second controller, LCD40x4 only) |
| wim | 21:9eb628d9e164 | 713 | * @param ctrl LCD controller (default = HD44780) |
| wim | 21:9eb628d9e164 | 714 | */ |
| wim | 21:9eb628d9e164 | 715 | 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 | 716 | |
| wim | 22:35742ec80c24 | 717 | /** Destruct a TextLCD interface for using regular mbed pins |
| wim | 22:35742ec80c24 | 718 | * |
| wim | 22:35742ec80c24 | 719 | * @param none |
| wim | 22:35742ec80c24 | 720 | * @return none |
| wim | 22:35742ec80c24 | 721 | */ |
| wim | 22:35742ec80c24 | 722 | virtual ~TextLCD(); |
| wim | 22:35742ec80c24 | 723 | |
| wim | 21:9eb628d9e164 | 724 | private: |
| kenjiArai | 30:4c57a022a56c | 725 | |
| kenjiArai | 30:4c57a022a56c | 726 | /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) |
| kenjiArai | 30:4c57a022a56c | 727 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 728 | */ |
| wim | 21:9eb628d9e164 | 729 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 730 | |
| kenjiArai | 30:4c57a022a56c | 731 | /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) |
| kenjiArai | 30:4c57a022a56c | 732 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 733 | */ |
| wim | 21:9eb628d9e164 | 734 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 735 | |
| kenjiArai | 30:4c57a022a56c | 736 | /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) |
| kenjiArai | 30:4c57a022a56c | 737 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 738 | */ |
| wim | 21:9eb628d9e164 | 739 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 740 | |
| kenjiArai | 30:4c57a022a56c | 741 | /** Implementation of pure Virtual Low level writes to LCD Bus (parallel) |
| kenjiArai | 30:4c57a022a56c | 742 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 743 | */ |
| wim | 21:9eb628d9e164 | 744 | virtual void _setData(int value); |
| wim | 21:9eb628d9e164 | 745 | |
| wim | 22:35742ec80c24 | 746 | /** Regular mbed pins bus |
| wim | 22:35742ec80c24 | 747 | */ |
| wim | 22:35742ec80c24 | 748 | DigitalOut _rs, _e; |
| wim | 22:35742ec80c24 | 749 | BusOut _d; |
| wim | 22:35742ec80c24 | 750 | |
| wim | 22:35742ec80c24 | 751 | /** Optional Hardware pins for the Backlight and LCD40x4 device |
| wim | 22:35742ec80c24 | 752 | * Default PinName value is NC, must be used as pointer to avoid issues with mbed lib and DigitalOut pins |
| wim | 22:35742ec80c24 | 753 | */ |
| kenjiArai | 30:4c57a022a56c | 754 | DigitalOut *_bl, *_e2; |
| wim | 21:9eb628d9e164 | 755 | }; |
| wim | 21:9eb628d9e164 | 756 | |
| wim | 23:d47f226efb24 | 757 | //----------- End TextLCD --------------- |
| wim | 21:9eb628d9e164 | 758 | |
| wim | 21:9eb628d9e164 | 759 | |
| wim | 23:d47f226efb24 | 760 | //--------- Start TextLCD_I2C ----------- |
| kenjiArai | 30:4c57a022a56c | 761 | #if(LCD_I2C == 1) /* I2C Expander PCF8574/MCP23008 */ |
| wim | 22:35742ec80c24 | 762 | |
| wim | 26:bd897a001012 | 763 | /** Create a TextLCD interface using an I2C PCF8574 (or PCF8574A) or MCP23008 portexpander |
| wim | 21:9eb628d9e164 | 764 | * |
| wim | 21:9eb628d9e164 | 765 | */ |
| wim | 21:9eb628d9e164 | 766 | class TextLCD_I2C : public TextLCD_Base { |
| wim | 21:9eb628d9e164 | 767 | public: |
| wim | 26:bd897a001012 | 768 | /** Create a TextLCD interface using an I2C PCF8574 (or PCF8574A) or MCP23008 portexpander |
| wim | 21:9eb628d9e164 | 769 | * |
| wim | 21:9eb628d9e164 | 770 | * @param i2c I2C Bus |
| kenjiArai | 30:4c57a022a56c | 771 | * @param deviceAddress I2C slave address (PCF8574 (or PCF8574A) or MCP23008 portexpander, default = PCF8574_SA0 = 0x40) |
| wim | 21:9eb628d9e164 | 772 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| wim | 21:9eb628d9e164 | 773 | * @param ctrl LCD controller (default = HD44780) |
| wim | 21:9eb628d9e164 | 774 | */ |
| wim | 26:bd897a001012 | 775 | TextLCD_I2C(I2C *i2c, char deviceAddress = PCF8574_SA0, LCDType type = LCD16x2, LCDCtrl ctrl = HD44780); |
| wim | 21:9eb628d9e164 | 776 | |
| wim | 21:9eb628d9e164 | 777 | private: |
| kenjiArai | 30:4c57a022a56c | 778 | |
| kenjiArai | 30:4c57a022a56c | 779 | /** Place the Enable bit in the databus shadowvalue |
| kenjiArai | 30:4c57a022a56c | 780 | * Used for mbed I2C portexpander |
| kenjiArai | 30:4c57a022a56c | 781 | * @param value data to write |
| kenjiArai | 30:4c57a022a56c | 782 | * @return none |
| kenjiArai | 30:4c57a022a56c | 783 | */ |
| kenjiArai | 30:4c57a022a56c | 784 | void _setEnableBit(bool value); |
| kenjiArai | 30:4c57a022a56c | 785 | |
| kenjiArai | 30:4c57a022a56c | 786 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 787 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 788 | */ |
| wim | 21:9eb628d9e164 | 789 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 790 | |
| kenjiArai | 30:4c57a022a56c | 791 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 792 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 793 | */ |
| wim | 21:9eb628d9e164 | 794 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 795 | |
| kenjiArai | 30:4c57a022a56c | 796 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 797 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 798 | */ |
| wim | 21:9eb628d9e164 | 799 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 800 | |
| kenjiArai | 30:4c57a022a56c | 801 | /** Place the 4bit data in the databus shadowvalue |
| kenjiArai | 30:4c57a022a56c | 802 | * Used for mbed I2C portexpander |
| kenjiArai | 30:4c57a022a56c | 803 | * @param value data to write |
| kenjiArai | 30:4c57a022a56c | 804 | * @return none |
| kenjiArai | 30:4c57a022a56c | 805 | */ |
| kenjiArai | 30:4c57a022a56c | 806 | void _setDataBits(int value); |
| wim | 26:bd897a001012 | 807 | |
| kenjiArai | 30:4c57a022a56c | 808 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 809 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 810 | */ |
| kenjiArai | 30:4c57a022a56c | 811 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 812 | |
| kenjiArai | 30:4c57a022a56c | 813 | //New optimized |
| kenjiArai | 30:4c57a022a56c | 814 | //Test faster _writeByte 0.11s vs 0.27s for a 20x4 fillscreen (PCF8574) |
| kenjiArai | 30:4c57a022a56c | 815 | //Test faster _writeByte 0.14s vs 0.34s for a 20x4 fillscreen (MCP23008) |
| kenjiArai | 30:4c57a022a56c | 816 | |
| kenjiArai | 30:4c57a022a56c | 817 | /** Low level writes to LCD serial bus expander |
| kenjiArai | 30:4c57a022a56c | 818 | */ |
| kenjiArai | 30:4c57a022a56c | 819 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 820 | |
| kenjiArai | 30:4c57a022a56c | 821 | /** Write data to MCP23008 I2C portexpander |
| kenjiArai | 30:4c57a022a56c | 822 | * @param reg register to write |
| kenjiArai | 30:4c57a022a56c | 823 | * @param value data to write |
| kenjiArai | 30:4c57a022a56c | 824 | * @return none |
| kenjiArai | 30:4c57a022a56c | 825 | */ |
| kenjiArai | 30:4c57a022a56c | 826 | void _writeRegister (int reg, int value); |
| wim | 21:9eb628d9e164 | 827 | |
| wim | 21:9eb628d9e164 | 828 | //I2C bus |
| wim | 21:9eb628d9e164 | 829 | I2C *_i2c; |
| wim | 21:9eb628d9e164 | 830 | char _slaveAddress; |
| wim | 21:9eb628d9e164 | 831 | |
| kenjiArai | 30:4c57a022a56c | 832 | // Internal bus shadow value for serial bus only |
| kenjiArai | 30:4c57a022a56c | 833 | char _lcd_bus; |
| wim | 21:9eb628d9e164 | 834 | }; |
| kenjiArai | 30:4c57a022a56c | 835 | #endif /* I2C Expander PCF8574/MCP23008 */ |
| wim | 21:9eb628d9e164 | 836 | |
| wim | 23:d47f226efb24 | 837 | //---------- End TextLCD_I2C ------------ |
| wim | 22:35742ec80c24 | 838 | |
| wim | 22:35742ec80c24 | 839 | |
| wim | 23:d47f226efb24 | 840 | //--------- Start TextLCD_SPI ----------- |
| kenjiArai | 30:4c57a022a56c | 841 | #if(LCD_SPI == 1) /* SPI Expander SN74595 */ |
| wim | 21:9eb628d9e164 | 842 | |
| wim | 21:9eb628d9e164 | 843 | /** Create a TextLCD interface using an SPI 74595 portexpander |
| wim | 21:9eb628d9e164 | 844 | * |
| wim | 21:9eb628d9e164 | 845 | */ |
| wim | 21:9eb628d9e164 | 846 | class TextLCD_SPI : public TextLCD_Base { |
| wim | 21:9eb628d9e164 | 847 | public: |
| wim | 21:9eb628d9e164 | 848 | /** Create a TextLCD interface using an SPI 74595 portexpander |
| wim | 21:9eb628d9e164 | 849 | * |
| wim | 21:9eb628d9e164 | 850 | * @param spi SPI Bus |
| wim | 21:9eb628d9e164 | 851 | * @param cs chip select pin (active low) |
| wim | 21:9eb628d9e164 | 852 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| wim | 21:9eb628d9e164 | 853 | * @param ctrl LCD controller (default = HD44780) |
| wim | 21:9eb628d9e164 | 854 | */ |
| wim | 21:9eb628d9e164 | 855 | TextLCD_SPI(SPI *spi, PinName cs, LCDType type = LCD16x2, LCDCtrl ctrl = HD44780); |
| wim | 21:9eb628d9e164 | 856 | |
| kenjiArai | 30:4c57a022a56c | 857 | private: |
| wim | 21:9eb628d9e164 | 858 | |
| kenjiArai | 30:4c57a022a56c | 859 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 860 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 861 | */ |
| wim | 21:9eb628d9e164 | 862 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 863 | |
| kenjiArai | 30:4c57a022a56c | 864 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 865 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 866 | */ |
| wim | 21:9eb628d9e164 | 867 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 868 | |
| kenjiArai | 30:4c57a022a56c | 869 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 870 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 871 | */ |
| wim | 21:9eb628d9e164 | 872 | virtual void _setBL(bool value); |
| wim | 21:9eb628d9e164 | 873 | |
| kenjiArai | 30:4c57a022a56c | 874 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial expander) |
| kenjiArai | 30:4c57a022a56c | 875 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 876 | */ |
| kenjiArai | 30:4c57a022a56c | 877 | virtual void _setData(int value); |
| wim | 21:9eb628d9e164 | 878 | |
| wim | 21:9eb628d9e164 | 879 | // SPI bus |
| wim | 21:9eb628d9e164 | 880 | SPI *_spi; |
| wim | 21:9eb628d9e164 | 881 | DigitalOut _cs; |
| wim | 21:9eb628d9e164 | 882 | |
| kenjiArai | 30:4c57a022a56c | 883 | // Internal bus shadow value for serial bus only |
| wim | 21:9eb628d9e164 | 884 | char _lcd_bus; |
| wim | 21:9eb628d9e164 | 885 | }; |
| kenjiArai | 30:4c57a022a56c | 886 | #endif /* SPI Expander SN74595 */ |
| wim | 23:d47f226efb24 | 887 | //---------- End TextLCD_SPI ------------ |
| wim | 21:9eb628d9e164 | 888 | |
| Sissors | 24:fb3399713710 | 889 | |
| wim | 26:bd897a001012 | 890 | //--------- Start TextLCD_I2C_N ----------- |
| kenjiArai | 30:4c57a022a56c | 891 | #if(LCD_I2C_N == 1) /* Native I2C */ |
| wim | 26:bd897a001012 | 892 | |
| wim | 26:bd897a001012 | 893 | /** Create a TextLCD interface using a controller with native I2C interface |
| wim | 26:bd897a001012 | 894 | * |
| wim | 26:bd897a001012 | 895 | */ |
| wim | 26:bd897a001012 | 896 | class TextLCD_I2C_N : public TextLCD_Base { |
| wim | 26:bd897a001012 | 897 | public: |
| wim | 26:bd897a001012 | 898 | /** Create a TextLCD interface using a controller with native I2C interface |
| wim | 26:bd897a001012 | 899 | * |
| wim | 26:bd897a001012 | 900 | * @param i2c I2C Bus |
| wim | 28:30fa94f7341c | 901 | * @param deviceAddress I2C slave address (default = ST7032_SA = 0x7C) |
| wim | 26:bd897a001012 | 902 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| wim | 28:30fa94f7341c | 903 | * @param bl Backlight control line (optional, default = NC) |
| wim | 26:bd897a001012 | 904 | * @param ctrl LCD controller (default = ST7032_3V3) |
| wim | 26:bd897a001012 | 905 | */ |
| wim | 28:30fa94f7341c | 906 | TextLCD_I2C_N(I2C *i2c, char deviceAddress = ST7032_SA, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = ST7032_3V3); |
| kenjiArai | 30:4c57a022a56c | 907 | |
| kenjiArai | 30:4c57a022a56c | 908 | /** Destruct a TextLCD interface using a controller with native I2C interface |
| kenjiArai | 30:4c57a022a56c | 909 | */ |
| wim | 26:bd897a001012 | 910 | virtual ~TextLCD_I2C_N(void); |
| wim | 26:bd897a001012 | 911 | |
| wim | 26:bd897a001012 | 912 | private: |
| kenjiArai | 30:4c57a022a56c | 913 | |
| kenjiArai | 30:4c57a022a56c | 914 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 915 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 916 | */ |
| wim | 26:bd897a001012 | 917 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 918 | |
| kenjiArai | 30:4c57a022a56c | 919 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 920 | * Set the RS pin ( 0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 921 | */ |
| wim | 26:bd897a001012 | 922 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 923 | |
| kenjiArai | 30:4c57a022a56c | 924 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 925 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 926 | */ |
| wim | 26:bd897a001012 | 927 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 928 | |
| kenjiArai | 30:4c57a022a56c | 929 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 930 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 931 | */ |
| wim | 26:bd897a001012 | 932 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 933 | |
| kenjiArai | 30:4c57a022a56c | 934 | /** Low level writes to LCD serial bus only (serial native) |
| kenjiArai | 30:4c57a022a56c | 935 | */ |
| wim | 26:bd897a001012 | 936 | virtual void _writeByte(int value); |
| wim | 26:bd897a001012 | 937 | |
| wim | 26:bd897a001012 | 938 | //I2C bus |
| wim | 26:bd897a001012 | 939 | I2C *_i2c; |
| wim | 26:bd897a001012 | 940 | char _slaveAddress; |
| wim | 26:bd897a001012 | 941 | |
| kenjiArai | 30:4c57a022a56c | 942 | // controlbyte to select between data and command. Internal shadow value for serial bus only |
| kenjiArai | 30:4c57a022a56c | 943 | char _controlbyte; |
| kenjiArai | 30:4c57a022a56c | 944 | |
| kenjiArai | 30:4c57a022a56c | 945 | //Backlight |
| kenjiArai | 30:4c57a022a56c | 946 | DigitalOut *_bl; |
| kenjiArai | 30:4c57a022a56c | 947 | |
| kenjiArai | 30:4c57a022a56c | 948 | }; |
| kenjiArai | 30:4c57a022a56c | 949 | #endif /* Native I2C */ |
| kenjiArai | 30:4c57a022a56c | 950 | //---------- End TextLCD_I2C_N ------------ |
| kenjiArai | 30:4c57a022a56c | 951 | |
| kenjiArai | 30:4c57a022a56c | 952 | |
| kenjiArai | 30:4c57a022a56c | 953 | //--------- Start TextLCD_SPI_N ----------- |
| kenjiArai | 30:4c57a022a56c | 954 | #if(LCD_SPI_N == 1) /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 955 | |
| kenjiArai | 30:4c57a022a56c | 956 | /** Create a TextLCD interface using a controller with native SPI4 interface |
| kenjiArai | 30:4c57a022a56c | 957 | * |
| kenjiArai | 30:4c57a022a56c | 958 | */ |
| kenjiArai | 30:4c57a022a56c | 959 | class TextLCD_SPI_N : public TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 960 | public: |
| kenjiArai | 30:4c57a022a56c | 961 | /** Create a TextLCD interface using a controller with native SPI4 interface |
| kenjiArai | 30:4c57a022a56c | 962 | * |
| kenjiArai | 30:4c57a022a56c | 963 | * @param spi SPI Bus |
| kenjiArai | 30:4c57a022a56c | 964 | * @param cs chip select pin (active low) |
| kenjiArai | 30:4c57a022a56c | 965 | * @param rs Instruction/data control line |
| kenjiArai | 30:4c57a022a56c | 966 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| kenjiArai | 30:4c57a022a56c | 967 | * @param bl Backlight control line (optional, default = NC) |
| kenjiArai | 30:4c57a022a56c | 968 | * @param ctrl LCD controller (default = ST7032_3V3) |
| kenjiArai | 30:4c57a022a56c | 969 | */ |
| kenjiArai | 30:4c57a022a56c | 970 | TextLCD_SPI_N(SPI *spi, PinName cs, PinName rs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = ST7032_3V3); |
| kenjiArai | 30:4c57a022a56c | 971 | |
| kenjiArai | 30:4c57a022a56c | 972 | /** Destruct a TextLCD interface using a controller with native SPI4 interface |
| kenjiArai | 30:4c57a022a56c | 973 | */ |
| kenjiArai | 30:4c57a022a56c | 974 | virtual ~TextLCD_SPI_N(void); |
| kenjiArai | 30:4c57a022a56c | 975 | |
| kenjiArai | 30:4c57a022a56c | 976 | private: |
| kenjiArai | 30:4c57a022a56c | 977 | |
| kenjiArai | 30:4c57a022a56c | 978 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 979 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 980 | */ |
| kenjiArai | 30:4c57a022a56c | 981 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 982 | |
| kenjiArai | 30:4c57a022a56c | 983 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 984 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 985 | */ |
| kenjiArai | 30:4c57a022a56c | 986 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 987 | |
| kenjiArai | 30:4c57a022a56c | 988 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 989 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 990 | */ |
| kenjiArai | 30:4c57a022a56c | 991 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 992 | |
| kenjiArai | 30:4c57a022a56c | 993 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 994 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 995 | */ |
| kenjiArai | 30:4c57a022a56c | 996 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 997 | |
| kenjiArai | 30:4c57a022a56c | 998 | /** Low level writes to LCD serial bus only (serial native) |
| kenjiArai | 30:4c57a022a56c | 999 | */ |
| kenjiArai | 30:4c57a022a56c | 1000 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 1001 | |
| kenjiArai | 30:4c57a022a56c | 1002 | // SPI bus |
| kenjiArai | 30:4c57a022a56c | 1003 | SPI *_spi; |
| kenjiArai | 30:4c57a022a56c | 1004 | DigitalOut _cs; |
| kenjiArai | 30:4c57a022a56c | 1005 | DigitalOut _rs; |
| kenjiArai | 30:4c57a022a56c | 1006 | |
| kenjiArai | 30:4c57a022a56c | 1007 | //Backlight |
| kenjiArai | 30:4c57a022a56c | 1008 | DigitalOut *_bl; |
| kenjiArai | 30:4c57a022a56c | 1009 | }; |
| kenjiArai | 30:4c57a022a56c | 1010 | #endif /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1011 | //---------- End TextLCD_SPI_N ------------ |
| kenjiArai | 30:4c57a022a56c | 1012 | |
| kenjiArai | 30:4c57a022a56c | 1013 | |
| kenjiArai | 30:4c57a022a56c | 1014 | //-------- Start TextLCD_SPI_N_3_8 -------- |
| kenjiArai | 30:4c57a022a56c | 1015 | #if(LCD_SPI_N_3_8 == 1) /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1016 | /** Create a TextLCD interface using a controller with native SPI3 8 bits interface |
| kenjiArai | 30:4c57a022a56c | 1017 | * This mode is supported by ST7070. |
| kenjiArai | 30:4c57a022a56c | 1018 | * |
| kenjiArai | 30:4c57a022a56c | 1019 | */ |
| kenjiArai | 30:4c57a022a56c | 1020 | class TextLCD_SPI_N_3_8 : public TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 1021 | public: |
| kenjiArai | 30:4c57a022a56c | 1022 | /** Create a TextLCD interface using a controller with a native SPI3 8 bits interface |
| kenjiArai | 30:4c57a022a56c | 1023 | * This mode is supported by ST7070. Note that implementation in TexTLCD is not very efficient due to |
| kenjiArai | 30:4c57a022a56c | 1024 | * structure of the TextLCD library: each databyte is written separately and requires a separate 'count command' set to 1 byte. |
| kenjiArai | 30:4c57a022a56c | 1025 | * |
| kenjiArai | 30:4c57a022a56c | 1026 | * @param spi SPI Bus |
| kenjiArai | 30:4c57a022a56c | 1027 | * @param cs chip select pin (active low) |
| kenjiArai | 30:4c57a022a56c | 1028 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| kenjiArai | 30:4c57a022a56c | 1029 | * @param bl Backlight control line (optional, default = NC) |
| kenjiArai | 30:4c57a022a56c | 1030 | * @param ctrl LCD controller (default = ST7070) |
| kenjiArai | 30:4c57a022a56c | 1031 | */ |
| kenjiArai | 30:4c57a022a56c | 1032 | TextLCD_SPI_N_3_8(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = ST7070); |
| kenjiArai | 30:4c57a022a56c | 1033 | |
| kenjiArai | 30:4c57a022a56c | 1034 | /** Destruct a TextLCD interface using a controller with native SPI3_8 interface |
| kenjiArai | 30:4c57a022a56c | 1035 | */ |
| kenjiArai | 30:4c57a022a56c | 1036 | virtual ~TextLCD_SPI_N_3_8(void); |
| kenjiArai | 30:4c57a022a56c | 1037 | |
| kenjiArai | 30:4c57a022a56c | 1038 | private: |
| kenjiArai | 30:4c57a022a56c | 1039 | |
| kenjiArai | 30:4c57a022a56c | 1040 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1041 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 1042 | */ |
| kenjiArai | 30:4c57a022a56c | 1043 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 1044 | |
| kenjiArai | 30:4c57a022a56c | 1045 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1046 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 1047 | */ |
| kenjiArai | 30:4c57a022a56c | 1048 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 1049 | |
| kenjiArai | 30:4c57a022a56c | 1050 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1051 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 1052 | */ |
| kenjiArai | 30:4c57a022a56c | 1053 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 1054 | |
| kenjiArai | 30:4c57a022a56c | 1055 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1056 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 1057 | */ |
| kenjiArai | 30:4c57a022a56c | 1058 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 1059 | |
| kenjiArai | 30:4c57a022a56c | 1060 | /** Low level writes to LCD serial bus only (serial native) |
| kenjiArai | 30:4c57a022a56c | 1061 | */ |
| kenjiArai | 30:4c57a022a56c | 1062 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 1063 | |
| kenjiArai | 30:4c57a022a56c | 1064 | // SPI bus |
| kenjiArai | 30:4c57a022a56c | 1065 | SPI *_spi; |
| kenjiArai | 30:4c57a022a56c | 1066 | DigitalOut _cs; |
| kenjiArai | 30:4c57a022a56c | 1067 | |
| kenjiArai | 30:4c57a022a56c | 1068 | // controlbyte to select between data and command. Internal shadow value for serial bus only |
| wim | 28:30fa94f7341c | 1069 | char _controlbyte; |
| wim | 28:30fa94f7341c | 1070 | |
| kenjiArai | 30:4c57a022a56c | 1071 | //Backlight |
| kenjiArai | 30:4c57a022a56c | 1072 | DigitalOut *_bl; |
| kenjiArai | 30:4c57a022a56c | 1073 | }; |
| kenjiArai | 30:4c57a022a56c | 1074 | |
| kenjiArai | 30:4c57a022a56c | 1075 | #endif /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1076 | //------- End TextLCD_SPI_N_3_8 ----------- |
| kenjiArai | 30:4c57a022a56c | 1077 | |
| kenjiArai | 30:4c57a022a56c | 1078 | |
| kenjiArai | 30:4c57a022a56c | 1079 | //------- Start TextLCD_SPI_N_3_9 --------- |
| kenjiArai | 30:4c57a022a56c | 1080 | #if(LCD_SPI_N_3_9 == 1) /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1081 | //Code checked out on logic analyser. Not yet tested on hardware.. |
| kenjiArai | 30:4c57a022a56c | 1082 | |
| kenjiArai | 30:4c57a022a56c | 1083 | /** Create a TextLCD interface using a controller with native SPI3 9 bits interface |
| kenjiArai | 30:4c57a022a56c | 1084 | * Note: current mbed libs only support SPI 9 bit mode for NXP platforms |
| kenjiArai | 30:4c57a022a56c | 1085 | * |
| kenjiArai | 30:4c57a022a56c | 1086 | */ |
| kenjiArai | 30:4c57a022a56c | 1087 | class TextLCD_SPI_N_3_9 : public TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 1088 | public: |
| kenjiArai | 30:4c57a022a56c | 1089 | /** Create a TextLCD interface using a controller with native SPI3 9 bits interface |
| kenjiArai | 30:4c57a022a56c | 1090 | * Note: current mbed libs only support SPI 9 bit mode for NXP platforms |
| kenjiArai | 30:4c57a022a56c | 1091 | * |
| kenjiArai | 30:4c57a022a56c | 1092 | * @param spi SPI Bus |
| kenjiArai | 30:4c57a022a56c | 1093 | * @param cs chip select pin (active low) |
| kenjiArai | 30:4c57a022a56c | 1094 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| kenjiArai | 30:4c57a022a56c | 1095 | * @param bl Backlight control line (optional, default = NC) |
| kenjiArai | 30:4c57a022a56c | 1096 | * @param ctrl LCD controller (default = AIP31068) |
| kenjiArai | 30:4c57a022a56c | 1097 | */ |
| kenjiArai | 30:4c57a022a56c | 1098 | TextLCD_SPI_N_3_9(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = AIP31068); |
| kenjiArai | 30:4c57a022a56c | 1099 | |
| kenjiArai | 30:4c57a022a56c | 1100 | /** Destruct a TextLCD interface using a controller with native SPI3_9 interface |
| kenjiArai | 30:4c57a022a56c | 1101 | */ |
| kenjiArai | 30:4c57a022a56c | 1102 | virtual ~TextLCD_SPI_N_3_9(void); |
| kenjiArai | 30:4c57a022a56c | 1103 | |
| kenjiArai | 30:4c57a022a56c | 1104 | private: |
| kenjiArai | 30:4c57a022a56c | 1105 | |
| kenjiArai | 30:4c57a022a56c | 1106 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1107 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 1108 | */ |
| kenjiArai | 30:4c57a022a56c | 1109 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 1110 | |
| kenjiArai | 30:4c57a022a56c | 1111 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1112 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 1113 | */ |
| kenjiArai | 30:4c57a022a56c | 1114 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 1115 | |
| kenjiArai | 30:4c57a022a56c | 1116 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1117 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 1118 | */ |
| kenjiArai | 30:4c57a022a56c | 1119 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 1120 | |
| kenjiArai | 30:4c57a022a56c | 1121 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1122 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 1123 | */ |
| kenjiArai | 30:4c57a022a56c | 1124 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 1125 | |
| kenjiArai | 30:4c57a022a56c | 1126 | /** Low level writes to LCD serial bus only (serial native) |
| kenjiArai | 30:4c57a022a56c | 1127 | */ |
| kenjiArai | 30:4c57a022a56c | 1128 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 1129 | |
| kenjiArai | 30:4c57a022a56c | 1130 | // SPI bus |
| kenjiArai | 30:4c57a022a56c | 1131 | SPI *_spi; |
| kenjiArai | 30:4c57a022a56c | 1132 | DigitalOut _cs; |
| kenjiArai | 30:4c57a022a56c | 1133 | |
| kenjiArai | 30:4c57a022a56c | 1134 | // controlbyte to select between data and command. Internal shadow value for serial bus only |
| kenjiArai | 30:4c57a022a56c | 1135 | char _controlbyte; |
| kenjiArai | 30:4c57a022a56c | 1136 | |
| kenjiArai | 30:4c57a022a56c | 1137 | //Backlight |
| kenjiArai | 30:4c57a022a56c | 1138 | DigitalOut *_bl; |
| kenjiArai | 30:4c57a022a56c | 1139 | }; |
| kenjiArai | 30:4c57a022a56c | 1140 | #endif /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1141 | //-------- End TextLCD_SPI_N_3_9 ---------- |
| kenjiArai | 30:4c57a022a56c | 1142 | |
| kenjiArai | 30:4c57a022a56c | 1143 | |
| kenjiArai | 30:4c57a022a56c | 1144 | //------- Start TextLCD_SPI_N_3_10 --------- |
| kenjiArai | 30:4c57a022a56c | 1145 | #if(LCD_SPI_N_3_10 == 1) /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1146 | |
| kenjiArai | 30:4c57a022a56c | 1147 | /** Create a TextLCD interface using a controller with native SPI3 10 bits interface |
| kenjiArai | 30:4c57a022a56c | 1148 | * Note: current mbed libs only support SPI 10 bit mode for NXP platforms |
| kenjiArai | 30:4c57a022a56c | 1149 | * |
| kenjiArai | 30:4c57a022a56c | 1150 | */ |
| kenjiArai | 30:4c57a022a56c | 1151 | class TextLCD_SPI_N_3_10 : public TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 1152 | public: |
| kenjiArai | 30:4c57a022a56c | 1153 | /** Create a TextLCD interface using a controller with native SPI3 10 bits interface |
| kenjiArai | 30:4c57a022a56c | 1154 | * Note: current mbed libs only support SPI 10 bit mode for NXP platforms |
| kenjiArai | 30:4c57a022a56c | 1155 | * |
| kenjiArai | 30:4c57a022a56c | 1156 | * @param spi SPI Bus |
| kenjiArai | 30:4c57a022a56c | 1157 | * @param cs chip select pin (active low) |
| kenjiArai | 30:4c57a022a56c | 1158 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| kenjiArai | 30:4c57a022a56c | 1159 | * @param bl Backlight control line (optional, default = NC) |
| kenjiArai | 30:4c57a022a56c | 1160 | * @param ctrl LCD controller (default = AIP31068) |
| kenjiArai | 30:4c57a022a56c | 1161 | */ |
| kenjiArai | 30:4c57a022a56c | 1162 | TextLCD_SPI_N_3_10(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = AIP31068); |
| kenjiArai | 30:4c57a022a56c | 1163 | |
| kenjiArai | 30:4c57a022a56c | 1164 | /** Destruct a TextLCD interface using a controller with native SPI3_10 interface |
| kenjiArai | 30:4c57a022a56c | 1165 | */ |
| kenjiArai | 30:4c57a022a56c | 1166 | virtual ~TextLCD_SPI_N_3_10(void); |
| kenjiArai | 30:4c57a022a56c | 1167 | |
| kenjiArai | 30:4c57a022a56c | 1168 | private: |
| kenjiArai | 30:4c57a022a56c | 1169 | |
| kenjiArai | 30:4c57a022a56c | 1170 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1171 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 1172 | */ |
| kenjiArai | 30:4c57a022a56c | 1173 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 1174 | |
| kenjiArai | 30:4c57a022a56c | 1175 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1176 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 1177 | */ |
| kenjiArai | 30:4c57a022a56c | 1178 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 1179 | |
| kenjiArai | 30:4c57a022a56c | 1180 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1181 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 1182 | */ |
| kenjiArai | 30:4c57a022a56c | 1183 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 1184 | |
| kenjiArai | 30:4c57a022a56c | 1185 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1186 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 1187 | */ |
| kenjiArai | 30:4c57a022a56c | 1188 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 1189 | |
| kenjiArai | 30:4c57a022a56c | 1190 | /** Low level writes to LCD serial bus only (serial native) |
| kenjiArai | 30:4c57a022a56c | 1191 | */ |
| kenjiArai | 30:4c57a022a56c | 1192 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 1193 | |
| kenjiArai | 30:4c57a022a56c | 1194 | // SPI bus |
| kenjiArai | 30:4c57a022a56c | 1195 | SPI *_spi; |
| kenjiArai | 30:4c57a022a56c | 1196 | DigitalOut _cs; |
| kenjiArai | 30:4c57a022a56c | 1197 | |
| kenjiArai | 30:4c57a022a56c | 1198 | // controlbyte to select between data and command. Internal shadow value for serial bus only |
| kenjiArai | 30:4c57a022a56c | 1199 | char _controlbyte; |
| kenjiArai | 30:4c57a022a56c | 1200 | |
| kenjiArai | 30:4c57a022a56c | 1201 | //Backlight |
| wim | 28:30fa94f7341c | 1202 | DigitalOut *_bl; |
| wim | 26:bd897a001012 | 1203 | }; |
| wim | 26:bd897a001012 | 1204 | |
| kenjiArai | 30:4c57a022a56c | 1205 | #endif /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1206 | //-------- End TextLCD_SPI_N_3_10 ---------- |
| kenjiArai | 30:4c57a022a56c | 1207 | |
| kenjiArai | 30:4c57a022a56c | 1208 | |
| kenjiArai | 30:4c57a022a56c | 1209 | //------- Start TextLCD_SPI_N_3_16 --------- |
| kenjiArai | 30:4c57a022a56c | 1210 | #if(LCD_SPI_N_3_16 == 1) /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1211 | |
| kenjiArai | 30:4c57a022a56c | 1212 | /** Create a TextLCD interface using a controller with native SPI3 16 bits interface |
| kenjiArai | 30:4c57a022a56c | 1213 | * |
| kenjiArai | 30:4c57a022a56c | 1214 | */ |
| kenjiArai | 30:4c57a022a56c | 1215 | class TextLCD_SPI_N_3_16 : public TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 1216 | public: |
| kenjiArai | 30:4c57a022a56c | 1217 | /** Create a TextLCD interface using a controller with native SPI3 16 bits interface |
| kenjiArai | 30:4c57a022a56c | 1218 | * |
| kenjiArai | 30:4c57a022a56c | 1219 | * @param spi SPI Bus |
| kenjiArai | 30:4c57a022a56c | 1220 | * @param cs chip select pin (active low) |
| kenjiArai | 30:4c57a022a56c | 1221 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| kenjiArai | 30:4c57a022a56c | 1222 | * @param bl Backlight control line (optional, default = NC) |
| kenjiArai | 30:4c57a022a56c | 1223 | * @param ctrl LCD controller (default = PT6314) |
| kenjiArai | 30:4c57a022a56c | 1224 | */ |
| kenjiArai | 30:4c57a022a56c | 1225 | TextLCD_SPI_N_3_16(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = PT6314); |
| kenjiArai | 30:4c57a022a56c | 1226 | |
| kenjiArai | 30:4c57a022a56c | 1227 | /** Destruct a TextLCD interface using a controller with native SPI3_16 interface |
| kenjiArai | 30:4c57a022a56c | 1228 | */ |
| kenjiArai | 30:4c57a022a56c | 1229 | virtual ~TextLCD_SPI_N_3_16(void); |
| kenjiArai | 30:4c57a022a56c | 1230 | |
| kenjiArai | 30:4c57a022a56c | 1231 | private: |
| kenjiArai | 30:4c57a022a56c | 1232 | |
| kenjiArai | 30:4c57a022a56c | 1233 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1234 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 1235 | */ |
| kenjiArai | 30:4c57a022a56c | 1236 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 1237 | |
| kenjiArai | 30:4c57a022a56c | 1238 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1239 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 1240 | */ |
| kenjiArai | 30:4c57a022a56c | 1241 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 1242 | |
| kenjiArai | 30:4c57a022a56c | 1243 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1244 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 1245 | */ |
| kenjiArai | 30:4c57a022a56c | 1246 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 1247 | |
| kenjiArai | 30:4c57a022a56c | 1248 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1249 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 1250 | */ |
| kenjiArai | 30:4c57a022a56c | 1251 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 1252 | |
| kenjiArai | 30:4c57a022a56c | 1253 | /** Low level writes to LCD serial bus only (serial native) |
| kenjiArai | 30:4c57a022a56c | 1254 | */ |
| kenjiArai | 30:4c57a022a56c | 1255 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 1256 | |
| kenjiArai | 30:4c57a022a56c | 1257 | // SPI bus |
| kenjiArai | 30:4c57a022a56c | 1258 | SPI *_spi; |
| kenjiArai | 30:4c57a022a56c | 1259 | DigitalOut _cs; |
| kenjiArai | 30:4c57a022a56c | 1260 | |
| kenjiArai | 30:4c57a022a56c | 1261 | // controlbyte to select between data and command. Internal shadow value for serial bus only |
| kenjiArai | 30:4c57a022a56c | 1262 | char _controlbyte; |
| kenjiArai | 30:4c57a022a56c | 1263 | |
| kenjiArai | 30:4c57a022a56c | 1264 | //Backlight |
| kenjiArai | 30:4c57a022a56c | 1265 | DigitalOut *_bl; |
| kenjiArai | 30:4c57a022a56c | 1266 | }; |
| kenjiArai | 30:4c57a022a56c | 1267 | #endif /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1268 | //-------- End TextLCD_SPI_N_3_16 ---------- |
| kenjiArai | 30:4c57a022a56c | 1269 | |
| kenjiArai | 30:4c57a022a56c | 1270 | |
| kenjiArai | 30:4c57a022a56c | 1271 | //------- Start TextLCD_SPI_N_3_24 --------- |
| kenjiArai | 30:4c57a022a56c | 1272 | #if(LCD_SPI_N_3_24 == 1) /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1273 | |
| kenjiArai | 30:4c57a022a56c | 1274 | /** Create a TextLCD interface using a controller with native SPI3 24 bits interface |
| kenjiArai | 30:4c57a022a56c | 1275 | * Note: lib uses SPI 8 bit mode |
| kenjiArai | 30:4c57a022a56c | 1276 | * |
| kenjiArai | 30:4c57a022a56c | 1277 | */ |
| kenjiArai | 30:4c57a022a56c | 1278 | class TextLCD_SPI_N_3_24 : public TextLCD_Base { |
| kenjiArai | 30:4c57a022a56c | 1279 | public: |
| kenjiArai | 30:4c57a022a56c | 1280 | /** Create a TextLCD interface using a controller with native SPI3 24 bits interface |
| kenjiArai | 30:4c57a022a56c | 1281 | * Note: lib uses SPI 8 bit mode |
| kenjiArai | 30:4c57a022a56c | 1282 | * |
| kenjiArai | 30:4c57a022a56c | 1283 | * @param spi SPI Bus |
| kenjiArai | 30:4c57a022a56c | 1284 | * @param cs chip select pin (active low) |
| kenjiArai | 30:4c57a022a56c | 1285 | * @param type Sets the panel size/addressing mode (default = LCD16x2) |
| kenjiArai | 30:4c57a022a56c | 1286 | * @param bl Backlight control line (optional, default = NC) |
| kenjiArai | 30:4c57a022a56c | 1287 | * @param ctrl LCD controller (default = SSD1803) |
| kenjiArai | 30:4c57a022a56c | 1288 | */ |
| kenjiArai | 30:4c57a022a56c | 1289 | TextLCD_SPI_N_3_24(SPI *spi, PinName cs, LCDType type = LCD16x2, PinName bl = NC, LCDCtrl ctrl = SSD1803_3V3); |
| kenjiArai | 30:4c57a022a56c | 1290 | |
| kenjiArai | 30:4c57a022a56c | 1291 | /** Destruct a TextLCD interface using a controller with native SPI3_24 interface |
| kenjiArai | 30:4c57a022a56c | 1292 | */ |
| kenjiArai | 30:4c57a022a56c | 1293 | virtual ~TextLCD_SPI_N_3_24(void); |
| kenjiArai | 30:4c57a022a56c | 1294 | |
| kenjiArai | 30:4c57a022a56c | 1295 | private: |
| kenjiArai | 30:4c57a022a56c | 1296 | |
| kenjiArai | 30:4c57a022a56c | 1297 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1298 | * Set the Enable pin. |
| kenjiArai | 30:4c57a022a56c | 1299 | */ |
| kenjiArai | 30:4c57a022a56c | 1300 | virtual void _setEnable(bool value); |
| kenjiArai | 30:4c57a022a56c | 1301 | |
| kenjiArai | 30:4c57a022a56c | 1302 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1303 | * Set the RS pin (0 = Command, 1 = Data). |
| kenjiArai | 30:4c57a022a56c | 1304 | */ |
| kenjiArai | 30:4c57a022a56c | 1305 | virtual void _setRS(bool value); |
| kenjiArai | 30:4c57a022a56c | 1306 | |
| kenjiArai | 30:4c57a022a56c | 1307 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1308 | * Set the BL pin (0 = Backlight Off, 1 = Backlight On). |
| kenjiArai | 30:4c57a022a56c | 1309 | */ |
| kenjiArai | 30:4c57a022a56c | 1310 | virtual void _setBL(bool value); |
| kenjiArai | 30:4c57a022a56c | 1311 | |
| kenjiArai | 30:4c57a022a56c | 1312 | /** Implementation of pure Virtual Low level writes to LCD Bus (serial native) |
| kenjiArai | 30:4c57a022a56c | 1313 | * Set the databus value (4 bit). |
| kenjiArai | 30:4c57a022a56c | 1314 | */ |
| kenjiArai | 30:4c57a022a56c | 1315 | virtual void _setData(int value); |
| kenjiArai | 30:4c57a022a56c | 1316 | |
| kenjiArai | 30:4c57a022a56c | 1317 | /** Low level writes to LCD serial bus only (serial native) |
| kenjiArai | 30:4c57a022a56c | 1318 | */ |
| kenjiArai | 30:4c57a022a56c | 1319 | virtual void _writeByte(int value); |
| kenjiArai | 30:4c57a022a56c | 1320 | |
| kenjiArai | 30:4c57a022a56c | 1321 | // SPI bus |
| kenjiArai | 30:4c57a022a56c | 1322 | SPI *_spi; |
| kenjiArai | 30:4c57a022a56c | 1323 | DigitalOut _cs; |
| kenjiArai | 30:4c57a022a56c | 1324 | |
| kenjiArai | 30:4c57a022a56c | 1325 | // controlbyte to select between data and command. Internal value for serial bus only |
| kenjiArai | 30:4c57a022a56c | 1326 | char _controlbyte; |
| kenjiArai | 30:4c57a022a56c | 1327 | |
| kenjiArai | 30:4c57a022a56c | 1328 | //Backlight |
| kenjiArai | 30:4c57a022a56c | 1329 | DigitalOut *_bl; |
| kenjiArai | 30:4c57a022a56c | 1330 | }; |
| kenjiArai | 30:4c57a022a56c | 1331 | #endif /* Native SPI bus */ |
| kenjiArai | 30:4c57a022a56c | 1332 | //-------- End TextLCD_SPI_N_3_24 ---------- |
| wim | 26:bd897a001012 | 1333 | |
| wim | 26:bd897a001012 | 1334 | |
| simon | 1:ac48b187213c | 1335 | #endif |