HD44780_LCD_PCF8574.h

Go to the documentation of this file.

 
#if ARDUINO >= 100
 #include "Arduino.h"
 #include "Print.h"
#else
 #include "WProgram.h"
#endif
 
#include "Wire.h"
 
#ifndef LCD_HD44780_H
#define LCD_HD44780_H
 
//#define LCD_SERIAL_DEBUG  // Comment in for serial debug I2C errors, set baud  rate externally.
 
class HD44780LCD : public Print{
public:
 
    // public enums
    
    enum LCDBackLight_e : uint8_t{
        LCDBackLightOnMask = 0x0F, 
        LCDBackLightOffMask = 0x07 
    }; 
    
    enum LCDEntryMode_e : uint8_t{
        LCDEntryModeOne = 0x04, 
        LCDEntryModeTwo = 0x05, 
        LCDEntryModeThree = 0x06, 
        LCDEntryModeFour = 0x07 
    }; 
 
    enum LCDCursorType_e : uint8_t {
        LCDCursorTypeOff= 0x0C, 
        LCDCursorTypeBlink = 0x0D, 
        LCDCursorTypeOn = 0x0E,  
        LCDCursorTypeOnBlink  = 0x0F 
    }; 
    
    enum LCDDirectionType_e : uint8_t {
        LCDMoveRight= 1, 
        LCDMoveLeft = 2   
    }; 
 
    enum LCDLineNumber_e : uint8_t{
        LCDLineNumberOne = 1,   
        LCDLineNumberTwo = 2,   
        LCDLineNumberThree = 3, 
        LCDLineNumberFour = 4  
    }; 
    
    
    // Constructor's
    HD44780LCD(uint8_t NumRow, uint8_t NumCol, uint8_t I2Caddress,TwoWire *twi );
    ~HD44780LCD(){};
    
    // public methods
    void PCF8574_LCDInit (LCDCursorType_e);
    void PCF8574_LCDDisplayON(bool );
    void PCF8574_LCDResetScreen(LCDCursorType_e);
    
    void PCF8574_LCDBackLightSet(bool);
    bool PCF8574_LCDBackLightGet(void);
    
    void PCF8574_LCDSendString (char *str);
    void PCF8574_LCDSendChar (char data);
    void PCF8574_LCDCreateCustomChar(uint8_t location, uint8_t* charmap);
    void PCF8574_LCDPrintCustomChar(uint8_t location);
 
    void PCF8574_LCDMoveCursor(LCDDirectionType_e, uint8_t moveSize);
    void PCF8574_LCDScroll(LCDDirectionType_e, uint8_t ScrollSize);
    void PCF8574_LCDGOTO(LCDLineNumber_e  lineNo, uint8_t  col);
    void PCF8574_LCDClearLine (LCDLineNumber_e lineNo);
    void PCF8574_LCDClearScreen(void);
    void PCF8574_LCDClearScreenCmd(void);
    void PCF8574_LCDHome(void);
    void PCF8574_LCDChangeEntryMode(LCDEntryMode_e mode);
 
#if ARDUINO >= 100
        virtual size_t write(uint8_t);
#else
        virtual void   write(uint8_t);
#endif
 
private:
 
    // Private internal enums
    
    enum LCDAddress_e : uint8_t {
        LCDLineAddressOne =  0x80,  
        LCDLineAddressTwo =  0xC0, 
        LCDLineAddress3Col20 = 0x94, 
        LCDLineAddress4Col20 = 0xD4, 
        LCDLineAddress3Col16  = 0x90, 
        LCDLineAddress4Col16  = 0xD0 
    }; 
 
    enum LCDCmdBytesGeneral_e : uint8_t {
        LCDModeFourBit = 0x28, 
        LCDHomePosition  = 0x02, 
        LCDDisplayOn = 0x0C,  
        LCDDisplayOff = 0x08, 
        LCDClearScreen = 0x01 
    };
 
    
    enum  LCDBackLight_e _LCDBackLight= LCDBackLightOnMask;  
    // Private Data
    uint8_t _LCDSlaveAddresI2C = 0x27 ; 
    uint8_t _NumRowsLCD = 2; 
    uint8_t _NumColsLCD = 16; 
    TwoWire *wire;  
    // private methods
    void PCF8574_LCDSendCmd (unsigned char cmd);
    void PCF8574_LCDSendData (unsigned char data);
    bool PCF8574_LCD_I2C_ON(void);
    
}; // end of HD44780LCD class
 
#endif // guard header ending