TextLCD.h

00001 /*
00002  * Changed by www.emcu.it for running on NUCLEO-L152RE. May 2014
00003  *
00004  * 
00005  * mbed TextLCD Library, for a 4-bit LCD based on HD44780
00006  * Copyright (c) 2007-2010, sford, http://mbed.org
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  *
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  */
00026 
00027 #ifndef MBED_TEXTLCD_H
00028 #define MBED_TEXTLCD_H
00029 
00030 #include "mbed.h"
00031 
00032 /**  A TextLCD interface for driving 4-bit HD44780-based LCDs
00033  *
00034  * Currently supports 16x2, 20x2 and 20x4 panels
00035  *
00036  * @code
00037  * #include "mbed.h"
00038  * #include "TextLCD.h"
00039  * 
00040  * TextLCD lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7
00041  * 
00042  * int main() {
00043  *     lcd.printf("Hello World!\n");
00044  * }
00045  * @endcode
00046  */
00047 class TextLCD : public Stream {
00048 public:
00049 
00050     /** LCD panel format */
00051     enum LCDType {
00052         LCD16x2     /**< 16x2 LCD panel (default) */
00053         , LCD16x2B  /**< 16x2 LCD panel alternate addressing */
00054         , LCD20x2   /**< 20x2 LCD panel */
00055         , LCD20x4   /**< 20x4 LCD panel */
00056     };
00057 
00058     /** Create a TextLCD interface
00059      *
00060      * @param rs    Instruction/data control line
00061      * @param e     Enable line (clock)
00062      * @param d4-d7 Data lines for using as a 4-bit interface
00063      * @param type  Sets the panel size/addressing mode (default = LCD16x2)
00064      */
00065     TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2);
00066 
00067 #if DOXYGEN_ONLY
00068     /** Write a character to the LCD
00069      *
00070      * @param c The character to write to the display
00071      */
00072     int putc(int c);
00073 
00074     /** Write a formated string to the LCD
00075      *
00076      * @param format A printf-style format string, followed by the
00077      *               variables to use in formating the string.
00078      */
00079     int printf(const char* format, ...);
00080 #endif
00081 
00082     /** Locate to a screen column and row
00083      *
00084      * @param column  The horizontal position from the left, indexed from 0
00085      * @param row     The vertical position from the top, indexed from 0
00086      */
00087     void locate(int column, int row);
00088 
00089     /** Clear the screen and locate to 0,0 */
00090     void cls();
00091 
00092     int rows();
00093     int columns();
00094 
00095 protected:
00096 
00097     // Stream implementation functions
00098     virtual int _putc(int value);
00099     virtual int _getc();
00100 
00101     int address(int column, int row);
00102     void character(int column, int row, int c);
00103     void writeByte(int value);
00104     void writeCommand(int command);
00105     void writeData(int data);
00106 
00107     DigitalOut _rs, _e;
00108     BusOut _d;
00109     LCDType _type;
00110 
00111     int _column;
00112     int _row;
00113 };
00114 
00115 #endif