Revision 0:7a19be4cc166, committed 2016-09-20

Comitter:

aracosta

Date:

Tue Sep 20 23:04:16 2016 +0000

Commit message:

First working version

Changed in this revision

diff -r 000000000000 -r 7a19be4cc166 pcf2119.cpp
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/pcf2119.cpp	Tue Sep 20 23:04:16 2016 +0000
@@ -0,0 +1,173 @@
+/* mbed CD Library, for a i2c LCD based on PCF2119
+ * Copyright (c) 2016, aracosta, http://mbed.org
+ * 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.
+ */
+
+#include "pcf2119.h"
+#include "mbed.h"
+
+extern Serial pc;
+
+TextLCD::TextLCD(void) : _i2c(NC, NC), _reset(NC)
+{
+    return;
+}
+
+TextLCD::TextLCD(PinName pSDA, PinName pSCL, PinName pReset, LCDType type) : _i2c(pSDA, pSCL), _reset(pReset), _type(type) {  
+    if (_type != LCDuser)
+        setLCDparam(_type); // otherwise rows, colums, comdelay, adresses must be set before
+
+
+    _reset = 1;
+    wait(0.05f);
+    _reset = 0;
+    wait(0.05f);
+    _reset = 1;
+    wait(0.05f);
+    _reset = 0;
+    
+    wait(0.2f);       // Wait 200ms to ensure powered up
+  
+    writeCommand(0x24); // Function set 4 Bit, 2Line, 5*7
+    cls();              // clear display, reset _column and _row
+    writeCommand(0x0c); // Display on
+    writeCommand(0x06); // cursor right, Display is not shifted
+}
+
+void TextLCD::character(int column, int row, int c) {
+    int a = 0x80 | (LCDparam.addresses[row & 3] + column);
+    writeCommand(a);    // set cursor address
+    writeData(c + 0x80);       // write char
+}
+
+void TextLCD::cls() {
+    writeCommand(0x08); // Display on
+    int a = 0x80 | (LCDparam.addresses[0 & 3] + 0);
+    writeCommand(a);    // set cursor address
+    writeCommand(0x80); // set cursor address
+    for( int i=0;i<LCDparam.columns;i++) {
+        writeData(' ' + 0x80);       // write char
+    }
+    a = 0x80 | (LCDparam.addresses[1 & 3] + 0);
+    writeCommand(a);    // set cursor address
+    for( int i=0;i<LCDparam.columns;i++) {
+        writeData(' ' + 0x80);       // write char
+    }
+    locate(0, 0);       // set internal position
+    writeCommand(0x0c); // Display on
+    wait_us(45 * LCDparam.delay);   // CLS need much time
+}
+
+void TextLCD::locate(int column, int row) {
+    _column = column;   // set position for next char
+    _row = row;         // note: cursor is not set yet
+}
+
+int TextLCD::_putc(int value) {
+    if (value == '\n') {
+        _column = 0;
+        _row++;
+        if (_row >= LCDparam.rows) {
+            _row = 0;
+        }
+    } else {
+        character(_column, _row, value);
+        _column++;
+        if (_column >= LCDparam.columns) {
+            _column = 0;
+            _row++;
+            if (_row >= LCDparam.rows) {
+                _row = 0;
+            }
+        }
+    }
+    return value;
+}
+
+// Dummy function - read not supported
+int TextLCD::_getc() {
+    return -1;
+}
+
+void TextLCD::writeCommand(int command) {
+    _i2cbuffer[0] = 0x00;
+    _i2cbuffer[1] = command;
+    _i2c.write(LCDparam.i2c_address, _i2cbuffer, 2, false);
+    wait_us(LCDparam.delay);
+}
+
+
+void TextLCD::writeData(int data) {
+    _i2cbuffer[0] = 0x40;
+    _i2cbuffer[1] = data;
+    _i2c.write(LCDparam.i2c_address, _i2cbuffer, 2, false);
+    wait_us(LCDparam.delay);
+}
+
+
+// set user defined char 
+void  TextLCD::writeCGRAM(int address, int pattern[8]){
+    int i;
+    address = address & 7;  //max 8 char
+    for(i=0;i<8;i++){
+        writeCommand(0x40 | (address * 8) + i);
+        writeData(pattern[i]);
+    }
+}   
+
+void TextLCD::setLCDparam(LCDType _type){
+    switch (_type) {
+        case LCD16x2:
+        case LCD16x2B:
+            LCDparam.columns = 16;
+            break;
+        case LCD20x2:
+        case LCD20x4:
+            LCDparam.columns = 20;
+            break;
+        case LCD24x2:
+            LCDparam.columns = 24;
+            break;
+    }
+    if (_type == LCD20x4) 
+        LCDparam.rows = 4;
+    else 
+        LCDparam.rows = 2;
+        
+    LCDparam.addresses[0] = 0;
+    
+    if (_type == LCD16x2B)
+        LCDparam.addresses[1] = 40;
+    else
+        LCDparam.addresses[1] = 0x40;
+        
+    if (_type == LCD20x4) {
+        LCDparam.addresses[2] = 0x14;
+        LCDparam.addresses[3] = 0x54;}
+    else {
+        LCDparam.addresses[2] = 0;
+        LCDparam.addresses[3] = 0;}
+        
+    LCDparam.delay = 50;            // 50 us delays as default       
+    
+    LCDparam.i2c_address = 0x76;       
+}
+        

diff -r 000000000000 -r 7a19be4cc166 pcf2119.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/pcf2119.h	Tue Sep 20 23:04:16 2016 +0000
@@ -0,0 +1,161 @@
+/* mbed CD Library, for a i2c LCD based on PCF2119
+ * Copyright (c) 2016, aracosta, http://mbed.org
+ * 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_PCF2119_H
+#define MBED_PCF2119_H
+
+#include "mbed.h"
+
+/** A TextLCD interface for driving  PCF2119-based LCDs
+ *
+ * Currently supports 16x2, 20x2 and 20x4 panels
+ *
+ * @code
+ * #include "mbed.h"
+ * #include "NewTextLCD.h"
+ * 
+ * TextLCD lcd(p10, p12, p13, p15, p16, p29, p30); // rs, e, d0-d3
+ * 
+ * int main() {
+ *     lcd.printf("Hello mbed\n");
+ *
+ * //define user chars
+ *  int pattern[8];
+ *  int pattern1[8];
+ *  pattern[0] = 1;              //     *
+ *  pattern[1] = 3;              //    **
+ *  pattern[2] = 5;              //   * *
+ *  pattern[3] = 9;              //  *  *
+ *  pattern[4] = 0x11;           // *   *     
+ *  pattern[5] = 0x19;           // **  * 
+ *  pattern[6] = 0x1d;           // *** *
+ *  pattern[7] = 0x1f;           // *****
+ *  
+ *  pattern1[0] = 0x10;          // *
+ *  pattern1[1] = 0x18;          // **
+ *  pattern1[2] = 0x14;          // * *
+ *  pattern1[3] = 0x12;          // *  *
+ *  pattern1[4] = 0x11;          // *   *
+ *  pattern1[5] = 0x13;          // *  **
+ *  pattern1[6] = 0x17;          // * ***
+ *  pattern1[7] = 0x1f;          // *****
+ * 
+ *  lcd.writeCGRAM(0, pattern);
+ *  lcd.writeCGRAM(1, pattern1);
+ *  
+ *  lcd.locate(15,0);
+ *  lcd.putc(0);   // user pattern 0
+ *  lcd.putc(1);   // user pattern 1   
+ * }
+ * @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 */
+        , LCD24x2   /**< 24x2 LCD panel */
+        , LCDuser   /** User defined LCD, rows/columns must be set */
+    };
+    
+    TextLCD(void);
+    /** Create a TextLCD interface
+     *
+     * @param rs    Instruction/data control line
+     * @param e     Enable line (clock)
+     * @param d4-d7 Data lines
+     * @param type  Sets the panel size/addressing mode (default = LCD16x2)
+     */
+    TextLCD(PinName pSDA, PinName pSCL, PinName pReset, 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();
+    
+    struct LCDparam {
+      char i2c_address;
+      int rows;           // number of lines //
+      int columns;        // number of columns //
+      int delay;          // delay for commands microseconds //
+      int addresses[4];   // start adresses for 4 lines //
+    } LCDparam;
+    
+    /** write a user defined char
+     *
+     * @param address  The user defined char (0-7)
+     * @param pattern[8] bit pattern 5*8 of char
+     */ 
+    void writeCGRAM(int address, int pattern[8]);
+    
+    /** Get the char at the current position
+     * 
+     * int getc() 
+     */
+     void writeCommand(int command);
+   
+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 writeData(int data);
+    void setLCDparam(LCDType _type);
+    
+    I2C _i2c;
+    DigitalOut _reset;
+    char _i2cbuffer[4];    // i2c data buffer 
+    LCDType _type;
+
+    int _column;
+    int _row;
+};
+
+#endif