SSD1331_OLED_RDL.hpp

Go to the documentation of this file.

 
#pragma once
 
// Section Libraries
#include "color16_graphics_RDL.hpp"
 
 
class SSD1331_OLED : public color16_graphics
{
 
public:
 
    enum scroll_time_interval_e : uint8_t{
        SCROLL_FRAME_6,     
        SCROLL_FRAME_10,    
        SCROLL_FRAME_100,   
        SCROLL_FRAME_200    
    };
    enum scroll_control_e: uint8_t{
        SCROLL_ACTIVATE, 
        SCROLL_DEACTIVE  
    };
    enum color_order_e: uint8_t{
        COLORORDER_RGB = 0x72, 
        COLORORDER_BGR = 0x76  
     };
    enum display_mode_e: uint8_t{
        DISPLAY_INVERSE,
        DISPLAY_NORMAL, 
        DISPLAY_ALL_ON, 
        DISPLAY_ALL_OFF 
     };
    struct Constrast_values_t {
        uint8_t ContrastColorA = 0x7D; 
        uint8_t ContrastColorB = 0x7D; 
        uint8_t ContrastColorC = 0x7D; 
    };
    struct Dim_Constrast_values_t {
        uint8_t Dim_ContrastColorA = 0x1E; 
        uint8_t Dim_ContrastColorB = 0x1E; 
        uint8_t Dim_ContrastColorC = 0x1E; 
    };
 
    SSD1331_OLED(color_order_e, const Constrast_values_t& contrast, const Dim_Constrast_values_t& dimContrast);
    ~SSD1331_OLED(){};
 
    // Functions
    // From graphics virtual
    virtual void setAddrWindow(uint16_t, uint16_t, uint16_t, uint16_t) override;
    //Setup related
    void OLEDSetupGPIO(int8_t, int8_t, int8_t, int8_t, int8_t); //SW SPI
    void OLEDSetupGPIO(int8_t, int8_t); // HW SPI
    void OLEDInitScreenSize(uint16_t w, uint16_t h);
    rdlib::Return_Codes_e OLEDInitSPI(uint16_t CommDelay, int gpioDev ); // SW SPI
    rdlib::Return_Codes_e OLEDInitSPI(int device, int channel, int speed, int flags, int gpioDev); // HW SPI
    rdlib::Return_Codes_e OLEDResetPin(void);
 
    // SPI related
    uint16_t HighFreqDelayGet(void);
    void HighFreqDelaySet(uint16_t);
    rdlib::Return_Codes_e  OLEDPowerDown(void);
 
    // Screen related
    void OLEDsetRotation(display_rotate_e r);
    void OLEDchangeDisplayMode(display_mode_e);
    void OLEDDimDisplay(void);
    void OLEDenableDisplay(void);
    void OLEDsleepDisplay(void);
    void OLEDClearWindowCmd(uint8_t c1, uint8_t r1, uint8_t c2 , uint8_t r2);
    void OLEDCopyWindowCmd(uint8_t c1, uint8_t r1, uint8_t c2 , uint8_t r2,uint8_t c3 , uint8_t r3);
    void OLEDDimWindowCmd(uint8_t c1, uint8_t r1, uint8_t c2 , uint8_t r2);
    void OLEDDrawLineCmd(uint8_t c1, uint8_t r1, uint8_t c2, uint8_t r2, uint16_t color);
    void OLEDDrawRectCmd(uint8_t c1, uint8_t r1, uint8_t  c2, uint8_t r2, uint16_t color, bool fill);
    void OLEDScroll(scroll_control_e) ;
    void OLEDScrollSetup(uint8_t ,uint8_t , uint8_t , uint8_t , scroll_time_interval_e );
 
private:
 
    void OLEDConfigueDimMode(void);
    void OLEDConfigueContrast(void);
    rdlib::Return_Codes_e OLEDDataCommandPin(void);
    rdlib::Return_Codes_e OLEDClock_Data_ChipSelect_Pins(void);
    rdlib::Return_Codes_e OLEDSSD1331Initialize(void);
    void cmdBegin(void);
    void WriteColor16(uint16_t colorWrite);
 
    // Screen
    uint16_t _widthStartOLED = 96;  
    uint16_t _heightStartOLED = 64; 
    color_order_e _colorOrder = COLORORDER_RGB; 
    display_rotate_e _displayRotate = Degrees_0; 
    Constrast_values_t ContrastValues  = { 0x7D, 0x7D, 0x7D }; 
    Dim_Constrast_values_t DimContrastValues{ 0x1E, 0x1E, 0x1E }; 
    // SPI related
    int _spiDev = 0;      
    int _spiChan = 0;     
    int _spiBaud = 50000; 
    int _spiFlags = 0;    
    // SSD1331 Commands & registers
    static constexpr uint8_t  _CMD_DRAWLINE = 0x21       ; 
    static constexpr uint8_t  _CMD_DRAWRECT = 0x22       ; 
    static constexpr uint8_t  _CMD_COPY_WINDOW = 0x23    ; 
    static constexpr uint8_t  _CMD_DIM_WINDOW = 0x24     ; 
    static constexpr uint8_t  _CMD_CLEAR_WINDOW = 0x25   ; 
    static constexpr uint8_t  _CMD_FILL = 0x26           ; 
    static constexpr uint8_t  _CMD_DISABLE_FILL = 0x00   ; 
    static constexpr uint8_t  _CMD_ENABLE_FILL  = 0x01   ; 
    static constexpr uint8_t  _CMD_CONT_SCROLL_SET =0x27 ; 
    static constexpr uint8_t  _CMD_DEACTIVE_SCROLL = 0x2E; 
    static constexpr uint8_t  _CMD_ACTIVE_SCROLL = 0x2F  ; 
    static constexpr uint8_t  _CMD_SETCOLUMN = 0x15      ; 
    static constexpr uint8_t  _CMD_SETROW = 0x75         ; 
    static constexpr uint8_t  _CMD_CONTRASTA = 0x81      ; 
    static constexpr uint8_t  _CMD_CONTRASTB = 0x82      ; 
    static constexpr uint8_t  _CMD_CONTRASTC = 0x83      ; 
    static constexpr uint8_t  _CMD_MASTERCURRENT = 0x87  ; 
    static constexpr uint8_t  _CMD_PRECHARGEA = 0x8A     ; 
    static constexpr uint8_t  _CMD_PRECHARGEB = 0x8B     ; 
    static constexpr uint8_t  _CMD_PRECHARGEC = 0x8C     ; 
    static constexpr uint8_t  _CMD_SETREMAP = 0xA0       ; 
    static constexpr uint8_t  _CMD_STARTLINE = 0xA1      ; 
    static constexpr uint8_t  _CMD_DISPLAYOFFSET = 0xA2  ; 
    static constexpr uint8_t  _CMD_NORMALDISPLAY = 0xA4  ; 
    static constexpr uint8_t  _CMD_DISPLAYALLON = 0xA5   ; 
    static constexpr uint8_t  _CMD_DISPLAYALLOFF = 0xA6  ; 
    static constexpr uint8_t  _CMD_INVERTDISPLAY = 0xA7  ; 
    static constexpr uint8_t  _CMD_SETMULTIPLEX = 0xA8   ; 
    static constexpr uint8_t  _CMD_DIM_MODE_SET =0xAB    ; 
    static constexpr uint8_t  _CMD_DIM_MODE_ON = 0xAC    ; 
    static constexpr uint8_t  _CMD_SETMASTER = 0xAD      ; 
    static constexpr uint8_t  _CMD_DISPLAYOFF = 0xAE     ; 
    static constexpr uint8_t  _CMD_DISPLAYON = 0xAF      ; 
    static constexpr uint8_t  _CMD_POWERMODE = 0xB0      ; 
    static constexpr uint8_t  _CMD_PRECHARGE = 0xB1      ; 
    static constexpr uint8_t  _CMD_CLOCKDIV  = 0xB3      ; 
    static constexpr uint8_t  _CMD_SET_GRAYSCALE = 0xB8  ; 
    static constexpr uint8_t  _CMD_ENABLE_GRAYSCALE =0xB9; 
    static constexpr uint8_t  _CMD_PRECHARGE_VOLT = 0xBB ; 
    static constexpr uint8_t  _CMD_V_VOLTAGE   = 0xBE    ; 
}; //end of SSD1331_OLED  class
 
// ********************** EOF *********************