sh110x.hpp

Go to the documentation of this file.

 
#pragma once
 
// Library includes
 
#include <cstdio>
#include <cstdint>
#include <cstdbool>
#include <span> // C++ 20
#include "display_graphics.hpp"
#include "hardware/i2c.h"
 
class SH110X : public displaylib_graphics  {
  public:
    SH110X(int16_t oledwidth, int16_t oledheight);
    ~SH110X(){};
    
    static constexpr uint8_t SH110X_ADDR = 0x3C; 
    enum OLED_IC_type_e: uint8_t
    {
        SH1106_IC = 0, 
        SH1107_IC  =1  
    };
 
    virtual void drawPixel(int16_t x, int16_t y, uint8_t color) override;
 
    DisplayRet::Ret_Codes_e OLEDSetBufferPtr(uint8_t width, uint8_t height , std::span<uint8_t> buffer);
    DisplayRet::Ret_Codes_e OLEDupdate(void);
    DisplayRet::Ret_Codes_e OLEDclearBuffer(void);
    void OLEDBufferScreen(uint8_t w, uint8_t h, std::span<uint8_t> buffer);
 
 
    void OLEDFillScreen(uint8_t pixel, uint8_t mircodelay);
    void OLEDFillPage(uint8_t page_num, uint8_t pixels,uint8_t delay);
    DisplayRet::Ret_Codes_e OLEDbegin(OLED_IC_type_e OLEDtype = SH1106_IC, int8_t resetPin = -1, uint8_t I2Caddress = 0x3C, 
                    i2c_inst_t* i2c_type = i2c1, uint16_t CLKspeed = 100, uint8_t SDApin = 18, uint8_t SCLKpin = 19);
    void OLEDinit(void);
    void OLEDPowerDown(void);
    void OLEDReset(void);
 
    void OLEDEnable(uint8_t on);
    void OLEDContrast(uint8_t OLEDcontrast);
    void OLEDInvert(bool on);
 
    void OLED_I2C_OFF(void);
    int16_t CheckConnection(void);
    bool GetIsConnected(void);
    void SetIsConnected(bool);
    bool GetDebugMode(void);
    void SetDebugMode(bool);
    uint8_t GetI2CRetryAttemptsNo(void);
    void SetI2CRetryAttemptsNo(uint8_t);
    uint16_t GetI2CRetryDelay(void);
    void SetI2CRetryDelay(uint16_t);
    uint32_t GetI2CTimeout(void);
    void SetI2CTimeout(uint32_t);
 
  private:
 
    void I2CWriteByte(uint8_t value = 0x00, uint8_t DataOrCmd = SH110X_COMMAND_BYTE);
    void SH1106_begin(void);
    void SH1107_begin(void);
 
    // I2C
    uint8_t _I2CRetryAttempts = 3; 
    uint16_t _I2CRetryDelay = 100; 
    uint32_t _TimeoutDelayI2C = 50000; 
    uint8_t _OLEDAddressI2C =  SH110X_ADDR; 
    uint8_t _SDataPin = 18; 
    uint8_t _SClkPin = 19;  
    uint16_t _CLKSpeed = 100; 
    i2c_inst_t * _i2c; 
    // flags for debugging & status
    bool _bIsConnected = false; 
    bool _bSerialDebugFlag = false; 
    uint8_t _OLED_WIDTH=128;      
    uint8_t _OLED_HEIGHT=64;    
    uint8_t _OLED_PAGE_NUM=(_OLED_HEIGHT/8); 
    uint8_t pageStartOffset = 0; 
    std::span<uint8_t> _OLEDbuffer ; 
    OLED_IC_type_e _OLED_IC_type = SH1106_IC;  
    // If reset pin is present on device
    int8_t _Display_RST = -1; 
    //  SH110X register command Set
    static constexpr uint8_t SH110X_MEMORYMODE  = 0x20 ; 
    static constexpr uint8_t SH110X_COLUMNADDR  = 0x21 ; 
    static constexpr uint8_t SH110X_PAGEADDR    = 0x22 ; 
    static constexpr uint8_t SH110X_CHARGEPUMP  = 0x8D ; 
    static constexpr uint8_t SH110X_SETCONTRAST = 0x81 ; 
    static constexpr uint8_t SH110X_SEGREMAP    = 0xA0 ; 
    static constexpr uint8_t SH110X_DISPLAYALLON_RESUME = 0xA4 ; 
    static constexpr uint8_t SH110X_DISPLAYALLON  = 0xA5 ; 
    static constexpr uint8_t SH110X_NORMALDISPLAY = 0xA6 ; 
    static constexpr uint8_t SH110X_INVERTDISPLAY = 0xA7 ; 
    static constexpr uint8_t SH110X_SETMULTIPLEX  = 0xA8 ; 
    static constexpr uint8_t SH110X_DCDC          = 0xAD ; 
    static constexpr uint8_t SH110X_DISPLAYOFF    = 0xAE ; 
    static constexpr uint8_t SH110X_DISPLAYON     = 0xAF ; 
    static constexpr uint8_t SH110X_SETPAGEADDR   = 0xB0 ; 
    static constexpr uint8_t SH110X_COMSCANINC         = 0xC0 ; 
    static constexpr uint8_t SH110X_COMSCANDEC         = 0xC8 ; 
    static constexpr uint8_t SH110X_SETDISPLAYOFFSET   = 0xD3 ; 
    static constexpr uint8_t SH110X_SETDISPLAYCLOCKDIV = 0xD5 ; 
    static constexpr uint8_t SH110X_SETPRECHARGE       = 0xD9 ; 
    static constexpr uint8_t SH110X_SETCOMPINS         = 0xDA ; 
    static constexpr uint8_t SH110X_SETVCOMDETECT      = 0xDB ; 
    static constexpr uint8_t SH110X_SETDISPSTARTLINE   = 0xDC ; 
    static constexpr uint8_t SH110X_SETLOWCOLUMN  = 0x00  ; 
    static constexpr uint8_t SH110X_SETHIGHCOLUMN = 0x10  ; 
    static constexpr uint8_t SH110X_SETSTARTLINE  = 0x40  ; 
    static constexpr uint8_t SH110X_COMMAND_BYTE    =  0x00 ; 
    static constexpr uint8_t SH110X_DATA_BYTE       =  0x40 ; 
};