Sergey Limansky / TextLCD

2

TextLCD.h@9:69b27e45f43b, 2021-03-04 (annotated)

Committer:
serg1958
Date:
Thu Mar 04 17:43:39 2021 +0000
Revision:
9:69b27e45f43b
Parent:
8:308d188a2d3a 
1

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