HD44780_LCD_RDL.hpp

Go to the documentation of this file.

 
#include <lgpio.h>
#include "common_data_RDL.hpp"
#include "print_data_RDL.hpp"
 
#pragma once
 
 
// Section: Class's
 
class HD44780PCF8574LCD : 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  
    }; 
    
    
    HD44780PCF8574LCD(uint8_t NumRow, uint8_t NumCol, int I2Cdevice, int I2Caddress, int I2Cflags);
    ~HD44780PCF8574LCD(){};
    
    void LCDInit(LCDCursorType_e);
    void LCDDisplayON(bool);
    void LCDResetScreen(LCDCursorType_e);
    
    void LCDBackLightSet(bool);
    bool LCDBackLightGet(void);
    
    rdlib::Return_Codes_e LCD_I2C_ON(void);
    rdlib::Return_Codes_e LCD_I2C_OFF(void);
    int LCDCheckConnection(void);
    int LCDI2CErrorGet(void);
    uint16_t LCDI2CErrorTimeoutGet(void);
    void LCDI2CErrorTimeoutSet(uint16_t);
    uint8_t LCDI2CErrorRetryNumGet(void);
    void LCDI2CErrorRetryNumSet(uint8_t);
 
    rdlib::Return_Codes_e LCDSendString (char *str);
    void LCDSendChar (char data);
    virtual size_t write(uint8_t);
    rdlib::Return_Codes_e  LCDCreateCustomChar(uint8_t location, uint8_t* charmap);
    void LCDPrintCustomChar(uint8_t location);
    
    void LCDMoveCursor(LCDDirectionType_e, uint8_t moveSize);
    void LCDScroll(LCDDirectionType_e, uint8_t ScrollSize);
    void LCDGOTO(LCDLineNumber_e  lineNo, uint8_t  col);
    void LCDClearLine (LCDLineNumber_e lineNo);
    rdlib::Return_Codes_e  LCDClearScreen(void);
    void LCDClearScreenCmd(void);
    void LCDHome(void);
    void LCDChangeEntryMode(LCDEntryMode_e mode);
 
  private:
    void LCDSendCmd (unsigned char cmd);
    void LCDSendData (unsigned char data);
    
    // Private Enums
    enum LCDAddress_e : uint8_t {
        LCDLineAddressOne =  0x80,  
        LCDLineAddressTwo =  0xC0, 
        LCDLineAddress3Col20 = 0x94, 
        LCDLineAddress4Col20 = 0xD4, 
        LCDLineAddress3Col16  = 0x90, 
        LCDLineAddress4Col16  = 0xD0 
    }; 
 
    enum LCDCmdBytesGeneral_e : uint8_t {
        LCDCmdModeFourBit = 0x28, 
        LCDCmdHomePosition  = 0x02, 
        LCDCmdDisplayOn = 0x0C,  
        LCDCmdDisplayOff = 0x08, 
        LCDCmdClearScreen = 0x01 
    };
    
    enum  LCDBackLight_e _LCDBackLight= LCDBackLightOnMask;  
    int _LCDI2CAddress = 0x27 ; 
    int _LCDI2CDevice = 1; 
    int _LCDI2CFlags =  0;   
    int _LCDI2CHandle = 0;  
    uint16_t _I2C_ErrorDelay = 100; 
    uint8_t _I2C_ErrorRetryNum = 3; 
    int _I2C_ErrorFlag = 0; 
    uint8_t _NumRowsLCD = 2; 
    uint8_t _NumColsLCD = 16; 
  }; // end of HD44780PCF8574LCD class