eka sinambela / LinearAnalogSensors

add LCD

Fork of LinearAnalogSensors by Penn Electric

TextLCD.h@3:15afa310c137, 2016-06-14 (annotated)

Committer:
ekasinambela
Date:
Tue Jun 14 09:24:02 2016 +0000
Revision:
3:15afa310c137
add LCD

Who changed what in which revision?

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