OLED Backend Implementations

Module: OLED Display Driver

Backend transport implementations (I2C, SPI) for OLED drivers. More...

Functions

	Name
void	CFBD_OLED_IIC130XInit(CFBD_OLED * handle, CFBD_OLED_IICInitsParams * pvt_handle)
void	CFBD_OLED_IIC132XInit(CFBD_OLED * handle, CFBD_OLED_IICInitsParams * pvt_handle)

Detailed Description

Backend transport implementations (I2C, SPI) for OLED drivers.

This group contains transport-specific implementations for communicating with OLED devices. Each backend (I2C, SPI) provides initialization routines to wire transport parameters with the generic OLED driver.

Backends must handle:

• Device address/chip-select configuration
• Transport handle binding
• Asynchronous transaction notifications
• Error handling and retry logic
  • • Backend implementation organization
  • • Transport abstraction documentation
  • • Function Documentation:
  • • CFBD_OLED_IICInit(): Complete I2C initialization with:
  • • Parameter descriptions
  • • Step-by-step initialization flow
  • • Complete working example
  • • Thread-safety notes

Example: Supported Property Queries

• • The documentation now clearly specifies all supported property queries:
• • cpp
• // Query display width
• uint16_t width = 0;
• oled->ops->self_consult(oled, "width", NULL, &width);
• ``
• // Query display height <br>
• uint16_t height = 0;
• oled->ops->self_consult(oled, "height", NULL, &height);
• ``
• // Query RGB color support
• CFBD_bool is_rgb = CFBD_FALSE;
• oled->ops->self_consult(oled, "rgb", NULL, &is_rgb); *

Expected Doxygen Generation

• • When Doxygen processes these enhanced comments, it will generate:
• • Modules Tab:
• • OLED - OLED Display Driver (main group)
• • OLED_Device - OLED Device Interface
• • OLED_Backend - OLED Backend Implementations
• • Examples Tab:
• • Multiple code examples from

Functions Documentation

function CFBD_OLED_IIC130XInit

void CFBD_OLED_IIC130XInit(
    CFBD_OLED * handle,
    CFBD_OLED_IICInitsParams * pvt_handle
)

function CFBD_OLED_IIC132XInit

void CFBD_OLED_IIC132XInit(
    CFBD_OLED * handle,
    CFBD_OLED_IICInitsParams * pvt_handle
)

---

Updated on 2026-02-03 at 13:21:55 +0000