ssd1306.hpp

Go to the documentation of this file.

 
#pragma once
 
// Library includes
#include <cstdbool>
#include <span> // C++ 20
#include "display_graphics.hpp"
#include "hardware/i2c.h"
 
class SSD1306 : public displaylib_graphics  {
  public:
    SSD1306(int16_t , int16_t );
    ~SSD1306(){};
 
    static constexpr uint8_t SSD1306_ADDR  = 0x3C;  
    DisplayRet::Ret_Codes_e OLEDSetBufferPtr(uint8_t width, uint8_t height , std::span<uint8_t> buffer);
    virtual void drawPixel(int16_t x, int16_t y, uint8_t color) override;
    DisplayRet::Ret_Codes_e OLEDupdate(void);
    DisplayRet::Ret_Codes_e OLEDclearBuffer(void);
    void OLEDBuffer(int16_t x, int16_t y, uint8_t w, uint8_t h, std::span<uint8_t> data);
    void OLEDFillScreen(uint8_t pixel, uint8_t mircodelay);
    void OLEDFillPage(uint8_t page_num, uint8_t pixels,uint8_t delay);
    DisplayRet::Ret_Codes_e OLEDBitmap(int16_t x, int16_t y, int16_t w, int16_t h, std::span<const uint8_t> bitmap, bool invert);
    DisplayRet::Ret_Codes_e OLEDbegin(uint8_t I2c_address= SSD1306_ADDR , i2c_inst_t* i2c_type = i2c1 , uint16_t CLKspeed = 100, uint8_t SDApin = 18, uint8_t SCLKpin = 19);
    void OLEDinit();
    void OLEDdeI2CInit(void);
    void OLEDPowerDown(void);
    
    void OLEDEnable(uint8_t on);
    void OLEDContrast(uint8_t OLEDcontrast);
    void OLEDInvert(bool on);
    
    void OLEDStartScrollRight(uint8_t start, uint8_t stop); 
    void OLEDStartScrollLeft(uint8_t start, uint8_t stop) ;
    void OLEDStartScrollDiagRight(uint8_t start, uint8_t stop) ;
    void OLEDStartScrollDiagLeft(uint8_t start, uint8_t stop) ;
    void OLEDStopScroll(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 =  SSD1306_COMMAND);
  //  === SSD1306 Command Set  ===
    // Fundamental Commands
    static constexpr uint8_t SSD1306_SET_CONTRAST_CONTROL = 0x81;
    static constexpr uint8_t SSD1306_DISPLAY_ALL_ON_RESUME = 0xA4;
    static constexpr uint8_t SSD1306_DISPLAY_ALL_ON = 0xA5;
    static constexpr uint8_t SSD1306_NORMAL_DISPLAY = 0xA6;
    static constexpr uint8_t SSD1306_INVERT_DISPLAY = 0xA7;
    static constexpr uint8_t SSD1306_DISPLAY_OFF = 0xAE;
    static constexpr uint8_t SSD1306_DISPLAY_ON = 0xAF;
    static constexpr uint8_t SSD1306_NOP = 0xE3;
 
    // Scrolling Commands
    static constexpr uint8_t SSD1306_RIGHT_HORIZONTAL_SCROLL = 0x26;
    static constexpr uint8_t SSD1306_LEFT_HORIZONTAL_SCROLL = 0x27;
    static constexpr uint8_t SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL = 0x29;
    static constexpr uint8_t SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL = 0x2A;
    static constexpr uint8_t SSD1306_DEACTIVATE_SCROLL = 0x2E;
    static constexpr uint8_t SSD1306_ACTIVATE_SCROLL = 0x2F;
    static constexpr uint8_t SSD1306_SET_VERTICAL_SCROLL_AREA = 0xA3;
 
    // Addressing Setting Commands
    static constexpr uint8_t SSD1306_SET_LOWER_COLUMN = 0x00;
    static constexpr uint8_t SSD1306_SET_HIGHER_COLUMN = 0x10;
    static constexpr uint8_t SSD1306_MEMORY_ADDR_MODE = 0x20;
    static constexpr uint8_t SSD1306_SET_COLUMN_ADDR = 0x21;
    static constexpr uint8_t SSD1306_SET_PAGE_ADDR = 0x22;
 
    // Hardware Configuration Commands
    static constexpr uint8_t SSD1306_SET_START_LINE = 0x40;
    static constexpr uint8_t SSD1306_SET_SEGMENT_REMAP = 0xA0;
    static constexpr uint8_t SSD1306_SET_MULTIPLEX_RATIO = 0xA8;
    static constexpr uint8_t SSD1306_COM_SCAN_DIR_INC = 0xC0;
    static constexpr uint8_t SSD1306_COM_SCAN_DIR_DEC = 0xC8;
    static constexpr uint8_t SSD1306_SET_DISPLAY_OFFSET = 0xD3;
    static constexpr uint8_t SSD1306_SET_COM_PINS = 0xDA;
    static constexpr uint8_t SSD1306_CHARGE_PUMP = 0x8D;
 
    // Timing & Driving Scheme Setting Commands
    static constexpr uint8_t SSD1306_SET_DISPLAY_CLOCK_DIV_RATIO = 0xD5;
    static constexpr uint8_t SSD1306_SET_PRECHARGE_PERIOD = 0xD9;
    static constexpr uint8_t SSD1306_SET_VCOM_DESELECT = 0xDB;
 
    // I2C related
    static constexpr uint8_t SSD1306_COMMAND        = 0x00;
    static constexpr uint8_t SSD1306_DATA           = 0xC0;
    static constexpr uint8_t SSD1306_DATA_CONTINUE  = 0x40;
    //  === SSD1306 Command Set END ===
    
    // I2C
    uint8_t _I2CRetryAttempts = 3; 
    uint16_t _I2CRetryDelay = 100; 
    uint32_t _TimeoutDelayI2C = 50000; 
    uint8_t _OLEDAddressI2C =  SSD1306_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; 
    // Screen related 
    uint8_t _OLED_WIDTH=128;      
    uint8_t _OLED_HEIGHT=64;    
    uint8_t _OLED_PAGE_NUM=(_OLED_HEIGHT/8); 
    std::span<uint8_t> _OLEDbuffer; 
};