Hyeonjong Lee / TextLCD_CGRAM

CGRAM code in TextLCD

TextLCD.h@0:40112ed34e69, 2014-04-24 (annotated)

Committer:
leejong87
Date:
Thu Apr 24 03:53:46 2014 +0000
Revision:
0:40112ed34e69
CGRAM code in TextLCD

Who changed what in which revision?

UserRevisionLine numberNew contents of line
leejong87 0:40112ed34e69 1 /* mbed TextLCD Library, for a 4-bit LCD based on HD44780
leejong87 0:40112ed34e69 2 * Copyright (c) 2007-2010, sford, http://mbed.org
leejong87 0:40112ed34e69 3 *
leejong87 0:40112ed34e69 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
leejong87 0:40112ed34e69 5 * of this software and associated documentation files (the "Software"), to deal
leejong87 0:40112ed34e69 6 * in the Software without restriction, including without limitation the rights
leejong87 0:40112ed34e69 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
leejong87 0:40112ed34e69 8 * copies of the Software, and to permit persons to whom the Software is
leejong87 0:40112ed34e69 9 * furnished to do so, subject to the following conditions:
leejong87 0:40112ed34e69 10 *
leejong87 0:40112ed34e69 11 * The above copyright notice and this permission notice shall be included in
leejong87 0:40112ed34e69 12 * all copies or substantial portions of the Software.
leejong87 0:40112ed34e69 13 *
leejong87 0:40112ed34e69 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
leejong87 0:40112ed34e69 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
leejong87 0:40112ed34e69 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
leejong87 0:40112ed34e69 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
leejong87 0:40112ed34e69 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
leejong87 0:40112ed34e69 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
leejong87 0:40112ed34e69 20 * THE SOFTWARE.
leejong87 0:40112ed34e69 21 */
leejong87 0:40112ed34e69 22
leejong87 0:40112ed34e69 23 #ifndef MBED_TEXTLCD_H
leejong87 0:40112ed34e69 24 #define MBED_TEXTLCD_H
leejong87 0:40112ed34e69 25
leejong87 0:40112ed34e69 26 #include "mbed.h"
leejong87 0:40112ed34e69 27
leejong87 0:40112ed34e69 28 /** A TextLCD interface for driving 4-bit HD44780-based LCDs
leejong87 0:40112ed34e69 29 *
leejong87 0:40112ed34e69 30 * Currently supports 16x2, 20x2 and 20x4 panels
leejong87 0:40112ed34e69 31 *
leejong87 0:40112ed34e69 32 * @code
leejong87 0:40112ed34e69 33 * #include "mbed.h"
leejong87 0:40112ed34e69 34 * #include "TextLCD.h"
leejong87 0:40112ed34e69 35 *
leejong87 0:40112ed34e69 36 * TextLCD lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7
leejong87 0:40112ed34e69 37 *
leejong87 0:40112ed34e69 38 * int main() {
leejong87 0:40112ed34e69 39 * lcd.printf("Hello World!\n");
leejong87 0:40112ed34e69 40 * }
leejong87 0:40112ed34e69 41 * @endcode
leejong87 0:40112ed34e69 42 */
leejong87 0:40112ed34e69 43 class TextLCD : public Stream {
leejong87 0:40112ed34e69 44 public:
leejong87 0:40112ed34e69 45
leejong87 0:40112ed34e69 46 /** LCD panel format */
leejong87 0:40112ed34e69 47 enum LCDType {
leejong87 0:40112ed34e69 48 LCD16x2 /**< 16x2 LCD panel (default) */
leejong87 0:40112ed34e69 49 , LCD16x2B /**< 16x2 LCD panel alternate addressing */
leejong87 0:40112ed34e69 50 , LCD20x2 /**< 20x2 LCD panel */
leejong87 0:40112ed34e69 51 , LCD20x4 /**< 20x4 LCD panel */
leejong87 0:40112ed34e69 52 };
leejong87 0:40112ed34e69 53
leejong87 0:40112ed34e69 54 /** Create a TextLCD interface
leejong87 0:40112ed34e69 55 *
leejong87 0:40112ed34e69 56 * @param rs Instruction/data control line
leejong87 0:40112ed34e69 57 * @param e Enable line (clock)
leejong87 0:40112ed34e69 58 * @param d4-d7 Data lines for using as a 4-bit interface
leejong87 0:40112ed34e69 59 * @param type Sets the panel size/addressing mode (default = LCD16x2)
leejong87 0:40112ed34e69 60 */
leejong87 0:40112ed34e69 61 TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2);
leejong87 0:40112ed34e69 62
leejong87 0:40112ed34e69 63 #if DOXYGEN_ONLY
leejong87 0:40112ed34e69 64 /** Write a character to the LCD
leejong87 0:40112ed34e69 65 *
leejong87 0:40112ed34e69 66 * @param c The character to write to the display
leejong87 0:40112ed34e69 67 */
leejong87 0:40112ed34e69 68 int putc(int c);
leejong87 0:40112ed34e69 69
leejong87 0:40112ed34e69 70 /** Write a formated string to the LCD
leejong87 0:40112ed34e69 71 *
leejong87 0:40112ed34e69 72 * @param format A printf-style format string, followed by the
leejong87 0:40112ed34e69 73 * variables to use in formating the string.
leejong87 0:40112ed34e69 74 */
leejong87 0:40112ed34e69 75 int printf(const char* format, ...);
leejong87 0:40112ed34e69 76 #endif
leejong87 0:40112ed34e69 77 void WriteCGRAM(int cgramloc, char *data);
leejong87 0:40112ed34e69 78
leejong87 0:40112ed34e69 79 /** Locate to a screen column and row
leejong87 0:40112ed34e69 80 *
leejong87 0:40112ed34e69 81 * @param column The horizontal position from the left, indexed from 0
leejong87 0:40112ed34e69 82 * @param row The vertical position from the top, indexed from 0
leejong87 0:40112ed34e69 83 */
leejong87 0:40112ed34e69 84 void locate(int column, int row);
leejong87 0:40112ed34e69 85
leejong87 0:40112ed34e69 86 /** Clear the screen and locate to 0,0 */
leejong87 0:40112ed34e69 87 void cls();
leejong87 0:40112ed34e69 88
leejong87 0:40112ed34e69 89 int rows();
leejong87 0:40112ed34e69 90 int columns();
leejong87 0:40112ed34e69 91
leejong87 0:40112ed34e69 92 protected:
leejong87 0:40112ed34e69 93
leejong87 0:40112ed34e69 94 // Stream implementation functions
leejong87 0:40112ed34e69 95 virtual int _putc(int value);
leejong87 0:40112ed34e69 96 virtual int _getc();
leejong87 0:40112ed34e69 97
leejong87 0:40112ed34e69 98 int address(int column, int row);
leejong87 0:40112ed34e69 99 void character(int column, int row, int c);
leejong87 0:40112ed34e69 100 void writeByte(int value);
leejong87 0:40112ed34e69 101 void writeCommand(int command);
leejong87 0:40112ed34e69 102 void writeData(int data);
leejong87 0:40112ed34e69 103
leejong87 0:40112ed34e69 104 DigitalOut _rs, _e;
leejong87 0:40112ed34e69 105 BusOut _d;
leejong87 0:40112ed34e69 106 LCDType _type;
leejong87 0:40112ed34e69 107
leejong87 0:40112ed34e69 108 int _column;
leejong87 0:40112ed34e69 109 int _row;
leejong87 0:40112ed34e69 110 };
leejong87 0:40112ed34e69 111
leejong87 0:40112ed34e69 112 #endif