Anders Markland / TextLCD

Initial commit

Fork of TextLCD by Wim Huiskamp

TextLCD.h@10:dd9b3a696acd, 2013-02-04 (annotated)

Committer:
wim
Date:
Mon Feb 04 21:48:24 2013 +0000
Revision:
10:dd9b3a696acd
Parent:
9:0893d986e717
Child:
11:9ec02df863a1
Added support for 24x4 LCDs using KS0078 controller; Added Cursor On/Off

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon 1:ac48b187213c 1 /* mbed TextLCD Library, for a 4-bit LCD based on HD44780
simon 6:e4cb7ddee0d3 2 * Copyright (c) 2007-2010, sford, http://mbed.org
wim 8:03116f75b66e 3 * 2013, WH, Updated LCD types and fixed lcd address issues
simon 1:ac48b187213c 4 *
simon 1:ac48b187213c 5 * Permission is hereby granted, free of charge, to any person obtaining a copy
simon 1:ac48b187213c 6 * of this software and associated documentation files (the "Software"), to deal
simon 1:ac48b187213c 7 * in the Software without restriction, including without limitation the rights
simon 1:ac48b187213c 8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
simon 1:ac48b187213c 9 * copies of the Software, and to permit persons to whom the Software is
simon 1:ac48b187213c 10 * furnished to do so, subject to the following conditions:
simon 2:227356c7d12c 11 *
simon 1:ac48b187213c 12 * The above copyright notice and this permission notice shall be included in
simon 1:ac48b187213c 13 * all copies or substantial portions of the Software.
simon 2:227356c7d12c 14 *
simon 1:ac48b187213c 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
simon 1:ac48b187213c 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
simon 1:ac48b187213c 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
simon 1:ac48b187213c 18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
simon 1:ac48b187213c 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
simon 1:ac48b187213c 20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
simon 1:ac48b187213c 21 * THE SOFTWARE.
simon 1:ac48b187213c 22 */
simon 1:ac48b187213c 23
simon 1:ac48b187213c 24 #ifndef MBED_TEXTLCD_H
simon 1:ac48b187213c 25 #define MBED_TEXTLCD_H
simon 1:ac48b187213c 26
simon 1:ac48b187213c 27 #include "mbed.h"
simon 2:227356c7d12c 28
simon 5:a53b3e2d6f1e 29 /** A TextLCD interface for driving 4-bit HD44780-based LCDs
simon 2:227356c7d12c 30 *
wim 10:dd9b3a696acd 31 * Currently supports 8x1, 8x2, 16x2, 16x4, 20x2, 20x4, 24x2, 24x4 and 40x2 panels
simon 2:227356c7d12c 32 *
simon 2:227356c7d12c 33 * @code
simon 2:227356c7d12c 34 * #include "mbed.h"
simon 2:227356c7d12c 35 * #include "TextLCD.h"
simon 5:a53b3e2d6f1e 36 *
simon 7:44f34c09bd37 37 * TextLCD lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7
simon 5:a53b3e2d6f1e 38 *
simon 2:227356c7d12c 39 * int main() {
simon 2:227356c7d12c 40 * lcd.printf("Hello World!\n");
simon 2:227356c7d12c 41 * }
simon 2:227356c7d12c 42 * @endcode
simon 2:227356c7d12c 43 */
wim 8:03116f75b66e 44
wim 10:dd9b3a696acd 45
simon 1:ac48b187213c 46 class TextLCD : public Stream {
simon 1:ac48b187213c 47 public:
simon 1:ac48b187213c 48
simon 2:227356c7d12c 49 /** LCD panel format */
simon 1:ac48b187213c 50 enum LCDType {
wim 8:03116f75b66e 51 LCD8x1, /**< 8x1 LCD panel */
wim 8:03116f75b66e 52 LCD8x2, /**< 8x2 LCD panel */
wim 8:03116f75b66e 53 LCD16x2, /**< 16x2 LCD panel (default) */
wim 8:03116f75b66e 54 LCD16x2B, /**< 16x2 LCD panel alternate addressing */
wim 8:03116f75b66e 55 LCD16x4, /**< 16x4 LCD panel */
wim 8:03116f75b66e 56 LCD20x2, /**< 20x2 LCD panel */
wim 8:03116f75b66e 57 LCD20x4, /**< 20x4 LCD panel */
wim 9:0893d986e717 58 LCD24x2, /**< 24x2 LCD panel */
wim 10:dd9b3a696acd 59 LCD24x4, /**< 24x4 LCD panel, special mode KS0078 */
wim 9:0893d986e717 60 LCD40x2 /**< 40x2 LCD panel */
simon 1:ac48b187213c 61 };
simon 1:ac48b187213c 62
wim 10:dd9b3a696acd 63 /** LCD Cursor control */
wim 10:dd9b3a696acd 64 enum LCDCursor {
wim 10:dd9b3a696acd 65 CurOn,
wim 10:dd9b3a696acd 66 CurOff
wim 10:dd9b3a696acd 67 };
wim 10:dd9b3a696acd 68
wim 10:dd9b3a696acd 69
simon 2:227356c7d12c 70 /** Create a TextLCD interface
simon 2:227356c7d12c 71 *
simon 2:227356c7d12c 72 * @param rs Instruction/data control line
simon 2:227356c7d12c 73 * @param e Enable line (clock)
simon 7:44f34c09bd37 74 * @param d4-d7 Data lines for using as a 4-bit interface
simon 2:227356c7d12c 75 * @param type Sets the panel size/addressing mode (default = LCD16x2)
simon 2:227356c7d12c 76 */
simon 7:44f34c09bd37 77 TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2);
simon 2:227356c7d12c 78
simon 2:227356c7d12c 79 #if DOXYGEN_ONLY
simon 2:227356c7d12c 80 /** Write a character to the LCD
simon 2:227356c7d12c 81 *
simon 2:227356c7d12c 82 * @param c The character to write to the display
simon 2:227356c7d12c 83 */
simon 2:227356c7d12c 84 int putc(int c);
simon 2:227356c7d12c 85
simon 2:227356c7d12c 86 /** Write a formated string to the LCD
simon 2:227356c7d12c 87 *
simon 2:227356c7d12c 88 * @param format A printf-style format string, followed by the
simon 2:227356c7d12c 89 * variables to use in formating the string.
simon 2:227356c7d12c 90 */
simon 2:227356c7d12c 91 int printf(const char* format, ...);
simon 2:227356c7d12c 92 #endif
simon 2:227356c7d12c 93
simon 2:227356c7d12c 94 /** Locate to a screen column and row
simon 2:227356c7d12c 95 *
simon 2:227356c7d12c 96 * @param column The horizontal position from the left, indexed from 0
simon 2:227356c7d12c 97 * @param row The vertical position from the top, indexed from 0
simon 2:227356c7d12c 98 */
simon 1:ac48b187213c 99 void locate(int column, int row);
simon 2:227356c7d12c 100
wim 10:dd9b3a696acd 101
wim 10:dd9b3a696acd 102 /** Return the memoryaddress of screen column and row location
wim 10:dd9b3a696acd 103 *
wim 10:dd9b3a696acd 104 * @param column The horizontal position from the left, indexed from 0
wim 10:dd9b3a696acd 105 * @param row The vertical position from the top, indexed from 0
wim 10:dd9b3a696acd 106 * @param return The memoryaddress of screen column and row location
wim 10:dd9b3a696acd 107 */
wim 9:0893d986e717 108 int getAddress(int column, int row);
wim 10:dd9b3a696acd 109
wim 10:dd9b3a696acd 110
wim 10:dd9b3a696acd 111 /** Set the memoryaddress of screen column and row location
wim 10:dd9b3a696acd 112 *
wim 10:dd9b3a696acd 113 * @param column The horizontal position from the left, indexed from 0
wim 10:dd9b3a696acd 114 * @param row The vertical position from the top, indexed from 0
wim 10:dd9b3a696acd 115 */
wim 9:0893d986e717 116 void setAddress(int column, int row);
wim 9:0893d986e717 117
wim 10:dd9b3a696acd 118 /** Set the Cursormode
wim 10:dd9b3a696acd 119 *
wim 10:dd9b3a696acd 120 * @param show The Cursor mode (CurOn or CurOff)
wim 10:dd9b3a696acd 121 * @param return The current Cursor mode
wim 10:dd9b3a696acd 122 */
wim 10:dd9b3a696acd 123 LCDCursor cursor(LCDCursor show);
wim 10:dd9b3a696acd 124
simon 2:227356c7d12c 125 /** Clear the screen and locate to 0,0 */
simon 1:ac48b187213c 126 void cls();
simon 2:227356c7d12c 127
wim 10:dd9b3a696acd 128 /** Return the number of rows
wim 10:dd9b3a696acd 129 *
wim 10:dd9b3a696acd 130 * @param return The number of rows
wim 10:dd9b3a696acd 131 */
simon 1:ac48b187213c 132 int rows();
wim 10:dd9b3a696acd 133
wim 10:dd9b3a696acd 134 /** Return the number of columns
wim 10:dd9b3a696acd 135 *
wim 10:dd9b3a696acd 136 * @param return The number of columns
wim 10:dd9b3a696acd 137 */
wim 10:dd9b3a696acd 138 int columns();
simon 2:227356c7d12c 139
simon 1:ac48b187213c 140 protected:
simon 1:ac48b187213c 141 // Stream implementation functions
simon 1:ac48b187213c 142 virtual int _putc(int value);
simon 1:ac48b187213c 143 virtual int _getc();
simon 1:ac48b187213c 144
wim 8:03116f75b66e 145 int address(int column, int row);
simon 2:227356c7d12c 146 void character(int column, int row, int c);
simon 1:ac48b187213c 147 void writeByte(int value);
simon 1:ac48b187213c 148 void writeCommand(int command);
simon 1:ac48b187213c 149 void writeData(int data);
simon 1:ac48b187213c 150
simon 1:ac48b187213c 151 DigitalOut _rs, _e;
simon 1:ac48b187213c 152 BusOut _d;
simon 1:ac48b187213c 153 LCDType _type;
simon 1:ac48b187213c 154
simon 1:ac48b187213c 155 int _column;
simon 1:ac48b187213c 156 int _row;
wim 10:dd9b3a696acd 157 LCDCursor _cursor;
simon 1:ac48b187213c 158 };
simon 1:ac48b187213c 159
simon 1:ac48b187213c 160 #endif