han back / Mbed OS CLEO_CDS

SMART CLEO CDS

TextLCD/TextLCD.h@0:2d4f287f9900, 2017-09-28 (annotated)

Committer:
SMART_CLEO
Date:
Thu Sep 28 02:10:35 2017 +0000
Revision:
0:2d4f287f9900
SMART_CLEO

Who changed what in which revision?

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