---

title: >: Comprehensive guides and reference documentation

---

>: Comprehensive guides and reference documentation

• • Detailed Comments: Extended sections with implementation guidance

Module Organization

• • The OLED subsystem is organized into the following modules:

OLED - Main Display Driver

• • Location: oled.h
• • Purpose: Generic OLED interface and device operations
• • Contents:
• • CFBD_OLED device structure
• • CFBD_OLEDOperations virtual operation table
• • CFBD_OLEDDriverType transport enumeration
• • CFBD_GetOLEDHandle() factory function

OLED_Device - Device Interface

• • Location: device_interface.h, ssd1306.h, ssd1309.h
• • Purpose: Device-specific configurations and factories
• • Contents:
• • CFBD_OLED_DeviceSpecific structure
• • getSSD1306Specific() factory function
• • getSSD1309Specific() factory function
• • SSD1309_DRIVER_ADDRESS constant

OLED_Backend - Transport Backends

• • Location: oled_iic.h (and potentially future spi backends)
• • Purpose: Transport-specific implementations
• • Contents:
• • CFBD_OLED_IICInit() I2C initialization
• • Backend parameter structures
• • Transport configuration

New Documentation Files

• • Three comprehensive documentation files have been created:

OLED_UsageGuide.md (@page OLED_UsageGuide)

• • Purpose: Comprehensive user guide for OLED driver usage
• • Contents:
• • Architecture overview
• • Getting started instructions (steps 1-4)
• • Common operations guide
• • Complete working example
• • Performance considerations
• • Troubleshooting guide
• • Target Audience: Application developers

OLED_Examples.md (@page OLED_Examples)

• • Purpose: Collection of practical code examples
• • Contents:
• • 10+ complete, runnable examples
• • Basic initialization
• • Display clearing and updating
• • Pixel and area drawing
• • Device property queries
• • Multi-display management
• • Error handling patterns
• • Deferred initialization
• • Target Audience: Developers learning by example

OLED_Namespace.md (@page OLED Namespace)

• • Purpose: Namespace organization documentation
• • Contents:
• • CFBD namespace overview
• • CFBD::OLED sub-namespace
• • Component organization
• • Target Audience: Architecture documentation readers

Enhanced Inline Documentation

• • All header files have received extensive documentation improvements:

oled.h Enhancements

• • Enumerations:
• • CFBD_OLEDDriverType: Expanded with detailed transport descriptions
• • Type Definitions:
• • AreaOperations: Enhanced with usage examples
• • FrameOperation: Detailed operation semantics
• • OLEDSelfOperation: Lifecycle management documentation
• • OLED_QueryOperation: Property query protocol and examples
• • CFBDOLED_Params_Inits: Transport-specific parameter abstraction
• • Structures:
• • CFBD_OLEDOperations: Complete operation table with:
• • Field-by-field documentation
• • Usage examples
• • Supported operation types
• • CFBD_OLED: Device object with:
• • Member descriptions
• • Usage patterns
• • Lifecycle documentation
• • Functions:
• • CFBD_GetOLEDHandle(): Extended documentation with:
• • Multiple usage examples
• • Transport-specific parameter guidelines
• • Error handling guidance
• • Two complete code examples

device_interface.h Enhancements

• • **New

---

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