Gabriel Scodiero / Mbed 2 deprecated Onda_lcd1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

TextLCD.h@1:0ada46075897, 2019-05-21 (annotated)

Committer:
Gabiuas
Date:
Tue May 21 00:51:20 2019 +0000
Revision:
1:0ada46075897
Ondas

Who changed what in which revision?

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