ssd1306.h

Go to the documentation of this file.

#pragma once
 
#include "commands_SSD1306.h"
#include "pico/stdlib.h"
#include "hw/i2c/rtos_hw_i2c.h"
#include "sw/display_device/display_device.h"
 
// Time_frame_interval
#define _2_FRAMES 0b111
#define _3_FRAMES 0b100
#define _4_FRAMES 0b101
#define _5_FRAMES 0b000
#define _25_FRAMES 0b110
#define _64_FRAMES 0b001
#define _128_FRAMES 0b010
#define _256_FRAMES 0b011
 
// addressing mode
#define HORIZONTAL_ADDRESSING_MODE 0
#define VERTICAL_ADDRESSING_MODE 1
#define PAGE_ADDRESSING_MODE 2

struct struct_ConfigSSD1306
 
{
    uint8_t i2c_address = 0x3C;
    uint8_t mux_ratio_value = 64;
    uint8_t vertical_offset = 0;
    uint8_t GDDRAM_start_line = 0;
    bool scan_SEG_inverse_direction = false;
    bool scan_COM_inverse_direction = false;
    bool sequential_COM = false;
    bool enable_COM_L_R_remap = false;
    uint8_t contrast = 127;
    uint8_t frequency_divider = 1;
    uint8_t frequency_factor = 0;
};

struct struct_ConfigScrollSSD1306
{
    bool scroll_H_to_right = true;
    bool scroll_V_and_H_to_right = true;
    uint8_t scroll_H_start_page = 0;
    uint8_t time_frame_interval = _2_FRAMES;
    uint8_t scroll_H_end_page = 7;
    uint8_t vertical_scrolling_offset = 5;
};

struct struct_RenderArea
{
    uint8_t start_col{0};
    uint8_t end_col{SSD1306_WIDTH - 1};
    uint8_t start_page{0};
    uint8_t end_page{SSD1306_NUM_PAGES - 1};
    size_t width{SSD1306_WIDTH};
    size_t height{SSD1306_HEIGHT};
    size_t buflen{SSD1306_BUF_LEN};
};

class SSD1306 : public GraphicDisplayDevice
{
protected:
    HW_I2C_Master *i2c_master;
    struct_ConfigSSD1306 device_config;

    void init();
    void init_MUX_ratio(uint8_t value);
    void init_display_vertical_shift(uint8_t value);
    void init_RAM_start_line(uint8_t value);
    void init_SEG_scan_inverse_direction(bool inverse);
    void init_COM_scan_inverse_direction(bool inverse);
    void init_COM_cfg(bool sequentialCOM, bool enableCOMLRremap);
    void init_clock_frequency(uint8_t divide_ratio, uint8_t frequency_factor);
    void init_charge_pump_enabled(bool enabled);
    void send_cmd(uint8_t cmd);
    void send_cmd_list(uint8_t *cmd_list, int num);
    // /// @brief refer to SSD1306 data sheet for more details
    // /// @param buf refer to SSD1306 data sheet for more details
    // /// @param buflen refer to SSD1306 data sheet for more details
    // virtual void send_buf(uint8_t buf[], size_t buflen);
 
public:
    void check_display_device_compatibility(struct_ConfigGraphicWidget framebuffer_cfg, CanvasFormat canvas_format);

    SSD1306(HW_I2C_Master *master, struct_ConfigSSD1306 device_config);
 
    virtual ~SSD1306();
    static struct_RenderArea compute_render_area(uint8_t start_col, uint8_t end_col, uint8_t start_line, uint8_t end_line);

    void show(Canvas *canvas, const uint8_t anchor_x, const uint8_t anchor_y);

    virtual void show_render_area(uint8_t *data_buffer, struct_RenderArea screen_area, uint8_t addressing_mode = HORIZONTAL_ADDRESSING_MODE);
    virtual void fill_pattern_and_show_GDDRAM(uint8_t pattern, struct_RenderArea area);
    void clear_device_screen_buffer();
    void set_contrast(uint8_t value);
    void set_display_from_RAM();
    void set_all_pixel_ON();
    void set_inverse_color(bool inverse);
    void set_display_OFF();
    void set_display_ON();
    void horizontal_scroll(bool on, struct_ConfigScrollSSD1306 scroll_data);
    void vertical_scroll(bool on, struct_ConfigScrollSSD1306 scroll_data);
};

class rtos_SSD1306 : public SSD1306
{
private:
public:
    rtos_SSD1306(rtos_HW_I2C_Master *master, struct_ConfigSSD1306 device_config);
    ~rtos_SSD1306();

    void clear_device_screen_buffer(uint8_t addressing_mode = HORIZONTAL_ADDRESSING_MODE);

    void send_clear_device_command(QueueHandle_t display_queue, SemaphoreHandle_t sending_done);

    void show_from_display_queue(struct_DataToShow data_to_show);
 
    void show_render_area(uint8_t *data_buffer, struct_RenderArea display_area, uint8_t addressing_mode = HORIZONTAL_ADDRESSING_MODE);

    void fill_GDDRAM_with_pattern(uint8_t pattern, struct_RenderArea area, uint8_t addressing_mode = HORIZONTAL_ADDRESSING_MODE);
 
};