4180 / Mbed 2 deprecated Ipod

adfdafa

Dependencies:   4DGL-uLCD-SE PinDetect SDFileSystem mbed wave_player

TextLCD/TextLCD.h@0:5369e93c00ed, 2016-04-11 (annotated)

Committer:
agamemaker
Date:
Mon Apr 11 16:50:37 2016 +0000
Revision:
0:5369e93c00ed
afdsad

Who changed what in which revision?

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