shaunrd0/klips
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Move display into a separate component WIP.

Browse Source 
Compiles, but does not work correctly yet.
This commit is contained in:
Shaun Reed
2025-11-02 12:00:36 -05:00
parent d0ca65cb62
commit 2f385e9ed3
27 changed files with 895 additions and 1163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
esp/cpp/components/ssd1306/CMakeLists.txt
View File

@@ -1,2 +1,4 @@
idf_component_register(SRCS "ssd1306.c"
INCLUDE_DIRS "include")
idf_component_register(
SRCS "ssd1306.c"
INCLUDE_DIRS "include"
)

8
esp/cpp/components/ssd1306/idf_component.yml
View File

@@ -2,4 +2,10 @@ version: "0.0.1"
description: ESP SSD1306 display helper component
url: https://git.shaunreed.com/shaunrd0/klips/tree/master/esp/cpp/components/ssd1306
dependencies:
idf: ">=5.3"
idf: ">=5.3"
lvgl/lvgl: 9.2.0
espressif/esp_lcd_sh1107: ==1.0.0
i2c:
path: ../../components/i2c
lcd:
path: ../../components/lcd

126
esp/cpp/components/ssd1306/include/ssd1306.h
View File

@@ -5,92 +5,102 @@
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#ifndef SSD1306_H
#define SSD1306_H
#include "panel_device.h"
#include <esp_lcd_panel_ssd1306.h>
#include <lcd.h>
// According to specific display hardware.
// https://www.digikey.com/en/products/detail/winstar-display/WEA012864DWPP3N00003/20533255
#define SCREEN_WIDTH 128 // OLED display width, in pixels.
#define SCREEN_HEIGHT 64 // OLED display height, in pixels.
#define SCREEN_WIDTH 128 // OLED display width, in pixels.
#define SCREEN_HEIGHT 64 // OLED display height, in pixels.
// According to SSD1306 datasheet.
// https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf
#define I2C_HW_ADDR 0x3C
#define LCD_PIXEL_CLOCK_HZ (400 * 1000)
#define I2C_HW_ADDR 0x3C
#define LCD_PIXEL_CLOCK_HZ (400 * 1000)
// Bit number used to represent command and parameter
#define LCD_CMD_BITS 8
#define LCD_PARAM_BITS 8
#define LCD_CMD_BITS 8
#define LCD_PARAM_BITS 8
/**
* Example of implementing the IPanelDevice interface for SSD1306 LCD device.
*/
struct SSD1306 {
/// SSD1306 configuration structure.
esp_lcd_panel_ssd1306_config_t ssd1306_config_;
struct SSD1306
{
/// SSD1306 configuration structure.
esp_lcd_panel_ssd1306_config_t ssd1306_config_;
};
/// Initializes the ESP LCD panel handle for the SSD1306 device.
void SSD1306_init_panel(esp_lcd_panel_dev_config_t &config,
esp_lcd_panel_io_handle_t io,
esp_lcd_panel_handle_t &panel) override
static void SSD1306_init_panel_cb(esp_lcd_panel_dev_config_t* config,
esp_lcd_panel_io_handle_t io,
esp_lcd_panel_handle_t* panel)
{
ESP_ERROR_CHECK(esp_lcd_new_panel_ssd1306(io, &config, &panel));
ESP_LOGI(LCD_TAG, "Initializing SSD1306 panel");
ESP_ERROR_CHECK(esp_lcd_new_panel_ssd1306(io, config, panel));
}
/**
* Construct a new SSD1306 device.
*
* @param i2c I2C master bus to manage this device.
*/
void SSD1306_init(i2c_master_bus_handle_t &i2c) {
SSD1306_config_init(i2c, {.height = SCREEN_HEIGHT}, SCREEN_WIDTH, SCREEN_HEIGHT)
}
/**
* Construct a new SSD1306 device given a specific SSD1306 configuration.
*
* @param i2c I2C master bus to manage this device.
* @param vendor_config SSD1306 vendor configuration.
* @param width Width of the device screen in pixels.
* @param height Height of the device screen in pixels.
*/
SSD1306_config_init(//TODO: panel_device_t* device,
i2c_master_bus_handle_t &i2c,
esp_lcd_panel_ssd1306_config_t vendor_config,
int width,
int height
) {
/* TODO:
device->init_panel(
i2c,
vendor_config,
(esp_lcd_panel_io_i2c_config_t) {
.dev_addr = I2C_HW_ADDR,
// User data to pass to the LVGL flush_ready callback.
// See IPanelDevice::lvgl_flush_ready_cb
.user_ctx = nullptr,
.control_phase_bytes = 1,
.dc_bit_offset = 6,
.lcd_cmd_bits = LCD_CMD_BITS,
.lcd_param_bits = LCD_PARAM_BITS,
.scl_speed_hz = LCD_PIXEL_CLOCK_HZ,
},
width,
height
)
*/
}
static esp_lcd_panel_ssd1306_config_t SSD1306_config = {
.height = SCREEN_HEIGHT,
};
/**
* Provides the SSD1306 vendor configuration to IPanelDevice consumers.
*
* @return Address of the SSD1306 vendor configuration structure.
*/
void *SSD1306_vendor_config() override
static void* SSD1306_vendor_config_cb()
{
return &ssd1306_config_;
ESP_LOGI(LCD_TAG, "Fetching global SSD1306 config");
return &SSD1306_config;
}
/**
* Construct a new SSD1306 device given a specific SSD1306 configuration.
*
* @param vendor_config SSD1306 vendor configuration.
* @param width Width of the device screen in pixels.
* @param height Height of the device screen in pixels.
*/
static struct IPanelDevice
SSD1306_config_new(esp_lcd_panel_ssd1306_config_t vendor_config, int width,
int height)
{
// TODO: Make it not global; There could be multiple SSD1306 displays.
ESP_LOGI(LCD_TAG, "Setting global SSD1306 configuration");
SSD1306_config = vendor_config;
// Must initialize device with LCD_new_panel to use default LVGL callbacks.
struct IPanelDevice device = LCD_new_panel();
device.width_ = width, device.height_ = height;
device.esp_io_config_ = (esp_lcd_panel_io_i2c_config_t){
.dev_addr = I2C_HW_ADDR,
// User data to pass to the LVGL flush_ready callback.
// See IPanelDevice::lvgl_flush_ready_cb
.user_ctx = NULL,
.control_phase_bytes = 1,
.dc_bit_offset = 6,
.lcd_cmd_bits = LCD_CMD_BITS,
.lcd_param_bits = LCD_PARAM_BITS,
.scl_speed_hz = LCD_PIXEL_CLOCK_HZ,
};
device.init_panel_cb = SSD1306_init_panel_cb;
device.vendor_config_cb = SSD1306_vendor_config_cb;
return device;
}
/**
* Construct a new SSD1306 device.
*/
static struct IPanelDevice SSD1306_new()
{
return SSD1306_config_new(
(esp_lcd_panel_ssd1306_config_t){.height = SCREEN_HEIGHT}, SCREEN_WIDTH,
SCREEN_HEIGHT);
}
#endif // SSD1306_H

9
esp/cpp/components/ssd1306/ssd1306.c
View File

@@ -1,2 +1,9 @@
#include <stdio.h>
/*#############################################################################
## Author: Shaun Reed ##
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
## ##
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
##############################################################################
*/
#include "ssd1306.h"