BDD / TextLCD

finally

Dependents:   PROGETTO_FINALE

TextLCD.h@0:a39dc05bdde8, 2016-12-17 (annotated)

Committer:
DrMirko
Date:
Sat Dec 17 12:34:34 2016 +0000
Revision:
0:a39dc05bdde8
aa

Who changed what in which revision?

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