File content as of revision 0:ef7b6dec773f:

/* mbed TextLCD Library, for a 4-bit LCD based on Optrex  DCM20481 NY-LY-ABE
* Copyright (c) 2007-2010, sford modified by E.Sjoukes
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
 
#ifndef MBED_OptrexLCD_H
#define MBED_OptrexLCD_H
 
#include "mbed.h"
 
/** A TextLCD interface for driving 4-bit HD44780-based LCDs
*
* Currently supports 16x2, 20x2 and 20x4 panels
*
* @code
* #include "mbed.h"
* #include "OptrexLCD.h"
* 
* TextLCD lcd(p10, p12, p15, p16, p17, p18 ); // rs, e, d0-d3
* 
* int main() {
*     lcd.printf("Hello World!\n");
* }
* @endcode
*/
class TextLCD : public Stream 
{
public:
     /** LCD panel format */
     enum LCDType 
     {
         LCD16x2,   /**< 16x2 LCD panel (default) */
         LCD16x2B,  /**< 16x2 LCD panel alternate addressing */
         LCD20x2,   /**< 20x2 LCD panel */
         LCD20x4    /**< 20x4 LCD panel */
     };
 
     /** Create a TextLCD interface
       * @param rs    Instruction/data control line
       * @param e     Enable line (clock)
       * @param d0-d3 Data lines
       * @param type  Sets the panel size/addressing mode (default = LCD16x2)
     */
     TextLCD(PinName rs, PinName e, PinName d0, PinName d1, PinName d2, PinName d3, LCDType type = LCD16x2);
 
#if DOXYGEN_ONLY
     /** Write a character to the LCD
       * @param c The character to write to the display
     */
     int putc(int c);
 
     /** Write a formated string to the LCD
       * @param format A printf-style format string, followed by the variables to use in formating the string.            
      */
     int printf(const char* format, ...);
#endif
 
     /** Locate to a screen column and row
       * @param column  The horizontal position from the left, indexed from 0
       * @param row     The vertical position from the top, indexed from 0
      */
     void locate(int column, int row);
 
     /** Clear the screen and locate to 0,0 */
     void cls();
     int rows();
     int columns();
 
protected:
    // Stream implementation functions
    virtual int _putc(int value);
    virtual int _getc();
 
    int address(int column, int row);
    void character(int column, int row, int c);
    void writeByte(int value);
    void writeCommand(int command);
    void writeData(int data);

    DigitalOut _rs, _e;
    BusOut _d;
    LCDType _type;
 
    int _column;
    int _row;
};

#endif