YX ZHANG / Mbed 2 deprecated Ex_TCS3200

TCS3200 color sensor

Dependencies:   TCS3200 mbed

Fork of my_example_TCS3200 by liang brain

TextLCD.h@1:1550b3529045, 2018-03-21 (annotated)

Committer:
zhangyx
Date:
Wed Mar 21 05:01:18 2018 +0000
Revision:
1:1550b3529045
example with LCD

Who changed what in which revision?

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