LCD I2C
Dependents: proyectoRTOS proyectoRTOS2 proyectoRTOS proyectoRTOSp ... more
TextLCD.h
- Committer:
- wim
- Date:
- 2013-03-09
- Revision:
- 18:bd65dc10f27f
- Parent:
- 17:652ab113bc2e
- Child:
- 19:c747b9e2e7b8
File content as of revision 18:bd65dc10f27f:
/* mbed TextLCD Library, for a 4-bit LCD based on HD44780 * Copyright (c) 2007-2010, sford, http://mbed.org * 2013, v01: WH, Added LCD types, fixed LCD address issues, added Cursor and UDCs * 2013, v02: WH, Added I2C and SPI bus interfaces * 2013, v03: WH, Added support for LCD40x4 which uses 2 controllers * 2013, v04: WH, Added support for Display On/Off, improved 4bit bootprocess * 2013, v05: WH, Added support for 8x2B, added some UDCs * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ #ifndef MBED_TEXTLCD_H #define MBED_TEXTLCD_H #include "mbed.h" /** A TextLCD interface for driving 4-bit HD44780-based LCDs * * Currently supports 8x1, 8x2, 12x4, 16x1, 16x2, 16x4, 20x2, 20x4, 24x2, 24x4, 40x2 and 40x4 panels * Interface options include direct mbed pins, I2C portexpander (PCF8474) or SPI bus shiftregister (74595) * * @code * #include "mbed.h" * #include "TextLCD.h" * * // I2C Communication * I2C i2c_lcd(p28,p27); // SDA, SCL * * // SPI Communication * SPI spi_lcd(p5, NC, p7); // MOSI, MISO, SCLK * * TextLCD lcd(p15, p16, p17, p18, p19, p20); // RS, E, D4-D7, LCDType=LCD16x2 * //TextLCD lcd(&spi_lcd, p8, TextLCD::LCD40x4); // SPI bus, CS pin, LCD Type * //TextLCD lcd(&i2c_lcd, 0x42, TextLCD::LCD20x4); // I2C bus, PCF8574 Slaveaddress, LCD Type * * int main() { * lcd.printf("Hello World!\n"); * } * @endcode */ //Pin Defines for I2C PCF8574 and SPI 74595 Bus interfaces //LCD and serial portexpanders should be wired accordingly //Note: LCD RW pin must be connected to GND // E2 is used for LCD40x4 (second controller) // BL may be used for future expansion to control backlight // #define D_LCD_PIN_D4 0 #define D_LCD_PIN_D5 1 #define D_LCD_PIN_D6 2 #define D_LCD_PIN_D7 3 #define D_LCD_PIN_RS 4 #define D_LCD_PIN_E 5 #define D_LCD_PIN_E2 6 #define D_LCD_PIN_BL 7 #define D_LCD_BUS_MSK 0x0F #define D_LCD_BUS_DEF 0x00 //Bitpattern Defines for I2C PCF8574 and SPI 74595 Bus // #define D_LCD_D4 (1<<D_LCD_PIN_D4) #define D_LCD_D5 (1<<D_LCD_PIN_D5) #define D_LCD_D6 (1<<D_LCD_PIN_D6) #define D_LCD_D7 (1<<D_LCD_PIN_D7) #define D_LCD_RS (1<<D_LCD_PIN_RS) #define D_LCD_E (1<<D_LCD_PIN_E) #define D_LCD_E2 (1<<D_LCD_PIN_E2) #define D_LCD_BL (1<<D_LCD_PIN_BL) /** Some sample User Defined Chars 5x7 dots */ const char udc_ae[] = {0x00, 0x00, 0x1B, 0x05, 0x1F, 0x14, 0x1F, 0x00}; //æ const char udc_0e[] = {0x00, 0x00, 0x0E, 0x13, 0x15, 0x19, 0x0E, 0x00}; //ø const char udc_ao[] = {0x0E, 0x0A, 0x0E, 0x01, 0x0F, 0x11, 0x0F, 0x00}; //å const char udc_AE[] = {0x0F, 0x14, 0x14, 0x1F, 0x14, 0x14, 0x17, 0x00}; //Æ const char udc_0E[] = {0x0E, 0x13, 0x15, 0x15, 0x15, 0x19, 0x0E, 0x00}; //Ø const char udc_Ao[] = {0x0E, 0x0A, 0x0E, 0x11, 0x1F, 0x11, 0x11, 0x00}; //Å const char udc_PO[] = {0x04, 0x0A, 0x0A, 0x1F, 0x1B, 0x1B, 0x1F, 0x00}; //Padlock Open const char udc_PC[] = {0x1C, 0x10, 0x08, 0x1F, 0x1B, 0x1B, 0x1F, 0x00}; //Padlock Closed const char udc_0[] = {0x18, 0x14, 0x12, 0x11, 0x12, 0x14, 0x18, 0x00}; // |> const char udc_1[] = {0x03, 0x05, 0x09, 0x11, 0x09, 0x05, 0x03, 0x00}; // <| const char udc_2[] = {0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x00}; // | const char udc_3[] = {0x14, 0x14, 0x14, 0x14, 0x14, 0x14, 0x14, 0x00}; // || const char udc_4[] = {0x15, 0x15, 0x15, 0x15, 0x15, 0x15, 0x15, 0x00}; // ||| const char udc_5[] = {0x00, 0x1f, 0x00, 0x1f, 0x00, 0x1f, 0x00, 0x00}; // = const char udc_6[] = {0x15, 0x0a, 0x15, 0x0a, 0x15, 0x0a, 0x15, 0x00}; // checkerboard const char udc_7[] = {0x10, 0x08, 0x04, 0x02, 0x01, 0x00, 0x10, 0x00}; // \ const char udc_degr[] = {0x06, 0x09, 0x09, 0x06, 0x00, 0x00, 0x00, 0x00}; // Degree symbol const char udc_TM_T[] = {0x1F, 0x04, 0x04, 0x04, 0x00, 0x00, 0x00, 0x00}; // Trademark T const char udc_TM_M[] = {0x11, 0x1B, 0x15, 0x11, 0x00, 0x00, 0x00, 0x00}; // Trademark M //const char udc_Bat_Hi[] = {0x0E, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Full //const char udc_Bat_Ha[] = {0x0E, 0x11, 0x13, 0x17, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Half //const char udc_Bat_Lo[] = {0x0E, 0x11, 0x11, 0x11, 0x11, 0x11, 0x1F, 0x00}; // Battery Low const char udc_Bat_Hi[] = {0x0E, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Full const char udc_Bat_Ha[] = {0x0E, 0x11, 0x11, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Battery Half const char udc_Bat_Lo[] = {0x0E, 0x11, 0x11, 0x11, 0x11, 0x1F, 0x1F, 0x00}; // Battery Low const char udc_AC[] = {0x0A, 0x0A, 0x1F, 0x11, 0x0E, 0x04, 0x04, 0x00}; // AC Power //const char udc_smiley[] = {0x00, 0x0A, 0x00, 0x04, 0x11, 0x0E, 0x00, 0x00}; // Smiley //const char udc_droopy[] = {0x00, 0x0A, 0x00, 0x04, 0x00, 0x0E, 0x11, 0x00}; // Droopey //const char udc_note[] = {0x01, 0x03, 0x05, 0x09, 0x0B, 0x1B, 0x18, 0x00}; // Note //const char udc_bar_1[] = {0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x00}; // Bar 1 //const char udc_bar_2[] = {0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x18, 0x00}; // Bar 11 //const char udc_bar_3[] = {0x1C, 0x1C, 0x1C, 0x1C, 0x1C, 0x1C, 0x1C, 0x00}; // Bar 111 //const char udc_bar_4[] = {0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x00}; // Bar 1111 //const char udc_bar_5[] = {0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x1F, 0x00}; // Bar 11111 /** A TextLCD interface for driving 4-bit HD44780-based LCDs * * Currently supports 8x1, 8x2, 12x2, 12x4, 16x1, 16x2, 16x4, 20x2, 20x4, 24x2, 24x4, 40x2 and 40x4 panels * */ class TextLCD : public Stream { public: /** LCD panel format */ enum LCDType { LCD8x1, /**< 8x1 LCD panel */ LCD8x2, /**< 8x2 LCD panel */ LCD8x2B, /**< 8x2 LCD panel (actually 16x1) */ LCD12x2, /**< 12x2 LCD panel */ LCD12x4, /**< 12x4 LCD panel */ LCD16x1, /**< 16x1 LCD panel (actually 8x2) */ LCD16x2, /**< 16x2 LCD panel (default) */ LCD16x2B, /**< 16x2 LCD panel alternate addressing */ LCD16x4, /**< 16x4 LCD panel */ LCD20x2, /**< 20x2 LCD panel */ LCD20x4, /**< 20x4 LCD panel */ LCD24x2, /**< 24x2 LCD panel */ LCD24x4, /**< 24x4 LCD panel, special mode KS0078 */ LCD40x2, /**< 40x2 LCD panel */ LCD40x4 /**< 40x4 LCD panel, Two controller version */ }; /** LCD Cursor control */ enum LCDCursor { CurOff_BlkOff = 0x00, /**< Cursor Off, Blinking Char Off */ CurOn_BlkOff = 0x02, /**< Cursor On, Blinking Char Off */ CurOff_BlkOn = 0x01, /**< Cursor Off, Blinking Char On */ CurOn_BlkOn = 0x03 /**< Cursor On, Blinking Char On */ }; /** LCD Display control */ enum LCDMode { DispOff = 0x00, /**< Display Off */ DispOn = 0x04 /**< Display On */ }; /** Create a TextLCD interface for using regular mbed pins * * @param rs Instruction/data control line * @param e Enable line (clock) * @param d4-d7 Data lines for using as a 4-bit interface * @param type Sets the panel size/addressing mode (default = LCD16x2) * @param e2 Enable2 line (clock for second controller, LCD40x4 only) */ TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2, PinName e2 = NC); /** Create a TextLCD interface using an I2C PC8574 portexpander * * @param i2c I2C Bus * @param deviceAddress I2C slave address (PCF8574) * @param type Sets the panel size/addressing mode (default = LCD16x2) */ TextLCD(I2C *i2c, char deviceAddress, LCDType type = LCD16x2); /** Create a TextLCD interface using an SPI 74595 portexpander * * @param spi SPI Bus * @param cs chip select pin (active low) * @param type Sets the panel size/addressing mode (default = LCD16x2) */ TextLCD(SPI *spi, PinName cs, LCDType type = LCD16x2); #if DOXYGEN_ONLY /** Write a character to the LCD * * @param c The character to write to the display */ int putc(int c); /** Write a formated string to the LCD * * @param format A printf-style format string, followed by the * variables to use in formating the string. */ int printf(const char* format, ...); #endif /** Locate to a screen column and row * * @param column The horizontal position from the left, indexed from 0 * @param row The vertical position from the top, indexed from 0 */ void locate(int column, int row); /** Return the memoryaddress of screen column and row location * * @param column The horizontal position from the left, indexed from 0 * @param row The vertical position from the top, indexed from 0 * @param return The memoryaddress of screen column and row location */ int getAddress(int column, int row); /** Set the memoryaddress of screen column and row location * * @param column The horizontal position from the left, indexed from 0 * @param row The vertical position from the top, indexed from 0 */ void setAddress(int column, int row); /** Clear the screen and locate to 0,0 */ void cls(); /** Return the number of rows * * @param return The number of rows */ int rows(); /** Return the number of columns * * @param return The number of columns */ int columns(); /** Set the Cursormode * * @param cursorMode The Cursor mode (CurOff_BlkOff, CurOn_BlkOff, CurOff_BlkOn, CurOn_BlkOn) */ void setCursor(LCDCursor cursorMode); /** Set the Displaymode * * @param displayMode The Display mode (DispOff, DispOn) */ void setMode(TextLCD::LCDMode displayMode); /** Set User Defined Characters * * @param unsigned char c The Index of the UDC (0..7) * @param char *udc_data The bitpatterns for the UDC (8 bytes of 5 significant bits) */ void setUDC(unsigned char c, char *udc_data); protected: /* LCD Bus control */ enum _LCDBus { _PinBus, /*< Regular mbed pins */ _I2CBus, /*< I2C PCF8574 Portexpander */ _SPIBus /*< SPI 74595 Shiftregister */ }; /* LCD controller select, mainly used for LCD40x4 */ enum _LCDCtrl { _LCDCtrl_0, /*< Primary */ _LCDCtrl_1, /*< Secondary */ }; // Stream implementation functions virtual int _putc(int value); virtual int _getc(); //Low level methods for LCD controller void _init(); void _initCtrl(); int _address(int column, int row); void _setCursor(TextLCD::LCDCursor show); void _setUDC(unsigned char c, char *udc_data); void _setCursorAndDisplayMode(TextLCD::LCDMode displayMode, TextLCD::LCDCursor cursorType); //Low level write operations to LCD controller void _writeNibble(int value); void _writeByte(int value); void _writeCommand(int command); void _writeData(int data); //Low level writes to LCD Bus (serial or parallel) void _setEnable(bool value); void _setRS(bool value); void _setData(int value); void _setCS(bool value); //Low level writes to LCD serial bus only void _writeBus(); // Regular mbed pins bus DigitalOut _rs, _e, _e2; BusOut _d; // I2C bus I2C *_i2c; unsigned char _slaveAddress; // SPI bus SPI *_spi; DigitalOut _cs; //Bus Interface type _LCDBus _busType; // Internal bus mirror value for serial bus only char _lcd_bus; //Display type LCDType _type; //Display type LCDMode _currentMode; //Controller select, mainly used for LCD40x4 _LCDCtrl _ctrl; // Cursor int _column; int _row; LCDCursor _currentCursor; }; #endif