ERM1_CH1115_OLED_RDL.hpp

Go to the documentation of this file.

 
#pragma once
 
// ** INCLUDES **
#include <lgpio.h>
#include <cstdio>
#include <cstdint>
#include <cstdbool>
#include <cstring>
#include "bicolor_graphics_RDL.hpp"
 
 
// CLASS SECTION 
 
class ERMCH1115 : public bicolor_graphics   {
 
    private:
 
        /* CH1115 Command Set*/
        // Fundamental Commands
        static constexpr uint8_t ERMCH1115_ENTIRE_DISPLAY_ON  = 0xA4; 
        static constexpr uint8_t ERMCH1115_ENTIRE_DISPLAY_OFF  = 0xA5; 
        static constexpr uint8_t ERMCH1115_DISPLAY_ON  = 0xAF; 
        static constexpr uint8_t ERMCH1115_DISPLAY_OFF  = 0xAE; 
        static constexpr uint8_t ERMCH1115_DISPLAY_NORMAL  = 0xA6; 
        static constexpr uint8_t ERMCH1115_DISPLAY_INVERT  = 0xA7; 
        static constexpr uint8_t ERMCH1115_CONTRAST_CONTROL  = 0x81; 
        static constexpr uint8_t ERMCH1115_CONTRAST_DATA_DEFAULT  = 0x80; 
        // Addressing Setting Commands
        static constexpr uint8_t ERMCH1115_SET_PAGEADD  = 0xB0; 
        static constexpr uint8_t ERMCH1115_SET_COLADD_LSB  = 0x00; 
        static constexpr uint8_t ERMCH1115_SET_COLADD_MSB  = 0x10; 
        static constexpr uint8_t ERMCH1115_SET_DISPLAY_START_LINE  = 0x40; 
        // Hardware Configuration Commands
        static constexpr uint8_t ERMCH1115_SET_PUMP_REG  = 0x30; 
        static constexpr uint8_t ERMCH1115_SET_PUMP_SET    = 0x01; 
        static constexpr uint8_t ERMCH1115_IREF_REG  = 0x82; 
        static constexpr uint8_t ERMCH1115_IREF_SET  = 0x00; 
        static constexpr uint8_t ERMCH1115_SEG_SET_REMAP   = 0xA0; 
        static constexpr uint8_t ERMCH1115_SEG_SET_PADS  = 0xA2; 
        static constexpr uint8_t ERMCH1115_MULTIPLEX_MODE_SET  = 0xA8; 
        static constexpr uint8_t ERMCH1115_MULTIPLEX_DATA_SET   = 0x3F; 
        static constexpr uint8_t ERMCH1115_DC_MODE_SET  = 0xAD; 
        static constexpr uint8_t ERMCH1115_DC_ONOFF_SET  = 0x8B; 
        static constexpr uint8_t ERMCH1115_COMMON_SCAN_DIR  = 0xC0; 
        static constexpr uint8_t ERMCH1115_OFFSET_MODE_SET  = 0xD3; 
        static constexpr uint8_t ERMCH1115_OFFSET_DATA_SET  = 0x00; 
        static constexpr uint8_t ERMCH1115_BREATHEFFECT_SET  = 0x23; 
        static constexpr uint8_t ERMCH1115_BREATHEFFECT_DATA  = 0x81; 
        // Timing & Driving Scheme Setting Commands
        static constexpr uint8_t ERMCH1115_OSC_FREQ_MODE_SET   = 0xD5; 
        static constexpr uint8_t ERMCH1115_OSC_FREQ_DATA_SET   = 0xA0; 
        static constexpr uint8_t ERMCH1115_PRECHARGE_MODE_SET  = 0xD9; 
        static constexpr uint8_t ERMCH1115_PRECHARGE_DATA_SET  = 0x22; 
        static constexpr uint8_t ERMCH1115_COM_LEVEL_MODE_SET  = 0xDB; 
        static constexpr uint8_t ERMCH1115_COM_LEVEL_DATA_SET  = 0x40; 
        // HORIZONTAL Scrolling Commands
        static constexpr uint8_t ERMCH1115_HORIZONTAL_A_SCROLL_SETUP  = 0x24; 
        static constexpr uint8_t ERMCH1115_HORIZONTAL_A_SCROLL_SET_SCOL  = 0x00; 
        static constexpr uint8_t ERMCH1115_HORIZONTAL_A_SCROLL_SET_ECOL  = 0x7F; 
        static constexpr uint8_t ERMCH1115_SCROLL_SETUP   = 0x26; 
        static constexpr uint8_t ERMCH1115_SPAGE_ADR_SET  = 0x00; 
        static constexpr uint8_t ERMCH1115_TIME_SET  = 0x00; 
        static constexpr uint8_t ERMCH1115_EPAGE_ADR_SET   = 0x07; 
        static constexpr uint8_t ERMCH1115_SET_SCROLL_MODE  = 0x28; 
        static constexpr uint8_t ERMCH1115_DEACTIVATE_SCROLL   = 0x2E; 
        static constexpr uint8_t ERMCH1115_ACTIVATE_SCROLL    = 0x2F; 
        // Delays
        struct ERMCH1115_Delays_t 
        {
            static constexpr uint16_t INITDELAY =  100;   
            static constexpr uint16_t RST_DELAY1 = 10;    
            static constexpr uint16_t RST_DELAY2 = 100;   
        };
 
        // GPIO related
        int8_t _Display_CS;   
        int8_t _Display_DC;   
        int8_t _Display_RST;  
        int8_t _Display_SCLK; 
        int8_t _Display_SDATA;   
        int _DeviceNumGpioChip = 0; 
        int _GpioHandle = 0; 
        // SPI related 
        int _spiHandle = 0; 
        int _spiDev = 0; 
        int _spiChan = 0; 
        int _spiBaud = 50000;   
        int _spiFlags = 0; 
        uint16_t _OLEDHighFreqDelay = 0; 
        int8_t _OLED_mode = 2; 
        // Display
        uint8_t _OLED_WIDTH = 128; 
        uint8_t _OLED_HEIGHT = 64; 
        uint8_t _OLED_PAGE_NUM = (_OLED_HEIGHT/8); 
        std::span<uint8_t> _OLEDbuffer; 
        bool _sleep = true; 
        uint8_t _OLEDcontrast = ERMCH1115_CONTRAST_DATA_DEFAULT; 
        // methods
        void send_data(uint8_t data);
        void send_command(uint8_t command, uint8_t value);
        int8_t GetCommMode(void);
        void SoftwareSPIShiftOut(uint8_t val);
 
    protected:
 
    public:
 
        // Contructor 1 Software SPI with explicit SCLK and SDIN and DC/cd
        ERMCH1115(int16_t oledwidth, int16_t oledheight , int8_t rst, int8_t dc, int8_t cs,  int8_t sclk, int8_t din);
        // Constructor 2 Hardware SPI
        ERMCH1115(int16_t oledwidth, int16_t oledheight , int8_t rst, int8_t dc);
        ~ERMCH1115(){};
 
        virtual void drawPixel(int16_t x, int16_t y, uint8_t colour) override;
 
        rdlib::Return_Codes_e OLEDSetBufferPtr(uint8_t width, uint8_t height , std::span<uint8_t> buffer);
        rdlib::Return_Codes_e OLEDupdate(void);
        rdlib::Return_Codes_e OLEDclearBuffer(void);
        void OLEDBufferScreen(int16_t x, int16_t y, uint8_t w, uint8_t h, std::span<uint8_t> data);
 
        void OLEDFillScreen(uint8_t pixel);
        void OLEDFillPage(uint8_t page_num, uint8_t pixels);
        void OLEDBitmap(int16_t x, int16_t y, uint8_t w, uint8_t h, const std::span<const uint8_t> data);
 
        rdlib::Return_Codes_e OLEDbegin(uint8_t contrast,  int gpioDev);
        rdlib::Return_Codes_e OLEDbegin(uint8_t contrast, int device, int channel, int speed, int flags, int gpioDev );
        void OLEDinit(void);
        void OLEDReset(void);
 
        void OLEDEnable(uint8_t on);
        void OLEDInvert(uint8_t on);
        void OLEDFlip(uint8_t on);
        void OLEDContrast(uint8_t contrast = ERMCH1115_CONTRAST_DATA_DEFAULT);
        void OLEDscroll(uint8_t bits) ;
        void OLEDscrollSetup(uint8_t Timeinterval= ERMCH1115_TIME_SET, uint8_t Direction=ERMCH1115_SCROLL_SETUP, uint8_t mode=ERMCH1115_SET_SCROLL_MODE) ;
        void OLEDfadeEffect(uint8_t bits = ERMCH1115_BREATHEFFECT_DATA);
        bool OLEDIsSleeping(void);
 
        rdlib::Return_Codes_e  OLEDSPIoff(void);
        void OLEDPowerDown(void);
        uint16_t OLEDHighFreqDelayGet(void);
        void OLEDHighFreqDelaySet(uint16_t);
 
}; // end of class