Diff: TextLCD.h

Revision:

1:19be52262a2d

Parent:

0:ec079a141883

diff -r ec079a141883 -r 19be52262a2d TextLCD.h
--- a/TextLCD.h	Fri Jul 27 15:06:59 2012 +0000
+++ b/TextLCD.h	Fri Jul 26 03:30:12 2019 +0000
@@ -1,109 +1,111 @@
-/* mbed TextLCD Library
- * Copyright (c) 2007-2009 sford
- * Released under the MIT License: http://mbed.org/license/mit
+/* mbed TextLCD Library, for a 4-bit LCD based on HD44780
+ * Copyright (c) 2007-2010, sford, http://mbed.org
+ *
+ * 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_TEXTLCD_H
 #define MBED_TEXTLCD_H
 
-#include "Stream.h"
-#include "DigitalOut.h"
-#include "BusOut.h"
-
-namespace mbed {
+#include "mbed.h"
 
-/* Class: TextLCD
- * A 16x2 Text LCD controller
+/**  A TextLCD interface for driving 4-bit HD44780-based LCDs
  *
- * Allows you to print to a Text LCD screen, and locate/cls. Could be
- * turned in to a more generic libray.
+ * Currently supports 16x2, 20x2 and 20x4 panels
  *
- * If you are connecting multiple displays, you can connect them all in
- * parallel except for the enable (e) pin, which must be unique for each
- * display.
- *
- * Example:
- * > #include "mbed.h"
- * > #include "TextLCD.h"
- * >
- * > TextLCD lcd(p24, p25, p26, p27, p28, p29, p30); // rs, rw, e, d0, d1, d2, d3
- * >
- * > int main() {
- * >     lcd.printf("Hello World!");
- * > }
+ * @code
+ * #include "mbed.h"
+ * #include "TextLCD.h"
+ * 
+ * TextLCD lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7
+ * 
+ * int main() {
+ *     lcd.printf("Hello World!\n");
+ * }
+ * @endcode
  */
 class TextLCD : public Stream {
+public:
 
-public:
-    /* Constructor: TextLCD
-     * Create a TextLCD object, connected to the specified pins
-     *
-     * All signals must be connected to DigitalIn compatible pins. 
+    /** 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
      *
-     * Variables:
-     *  rs -  Used to specify data or command
-     *  rw - Used to determine read or write
-     *  e - enable
-     *  d0..d3 - The data lines
+     * @param rs    Instruction/data control line
+     * @param e     Enable line (clock)
+     * @param d4-d7 Data lines for using as a 4-bit interface
+     * @param type  Sets the panel size/addressing mode (default = LCD16x2)
      */
-	TextLCD(PinName rs, PinName rw, PinName e, PinName d0, PinName d1, 
-		PinName d2, PinName d3, int columns = 16, int rows = 2);
+    TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2);
 
-#if 0 // Inhereted from Stream, for documentation only
-    /* Function: putc
-     *  Write a character
+#if DOXYGEN_ONLY
+    /** Write a character to the LCD
      *
-     * Variables:
-     *  c - The character to write to the serial port
+     * @param c The character to write to the display
      */
     int putc(int c);
 
-    /* Function: printf
-     *  Write a formated string
+    /** Write a formated string to the LCD
      *
-     * Variables:
-     *  format - A printf-style format string, followed by the
-     *      variables to use in formating the string.
+     * @param format A printf-style format string, followed by the
+     *               variables to use in formating the string.
      */
     int printf(const char* format, ...);
 #endif
-        
-    /* Function: locate
-     * Locate to a certian position
+
+    /** Locate to a screen column and row
      *
-     * Variables:
-     *  column - the column to locate to, from 0..15
-     *  row - the row to locate to, from 0..1
+     * @param column  The horizontal position from the left, indexed from 0
+     * @param row     The vertical position from the top, indexed from 0
      */
-	virtual void locate(int column, int row);
-    
-    /* Function: cls
-     * Clear the screen, and locate to 0,0
-     */
-	virtual void cls();	
-    
-	virtual void reset();
-		
+    void locate(int column, int row);
+
+    /** Clear the screen and locate to 0,0 */
+    void cls();
+
+    int rows();
+    int columns();
+
 protected:
 
-	void clock();
-	void writeData(int data);
-	void writeCommand(int command);
-	void writeByte(int value);
-	void writeNibble(int value);
-	virtual int _putc(int c);		
-	virtual int _getc();
-	virtual void newline();				
-			
-	int _row;
-	int _column;	
-	DigitalOut _rw, _rs, _e;
-	BusOut _d;
-	int _columns;
-	int _rows;
+    // 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