ssd1306.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/lcd/panel>
#include <idfxx/panel_io>
 
#include <cstddef>
#include <cstdint>
 
namespace idfxx::lcd {
 
class ssd1306 : public panel {
public:
    struct config {
        gpio reset_gpio = gpio::nc(); 
        uint32_t height = 64;         
        gpio::level reset_active_level = gpio::level::low; 
    };
 
    [[nodiscard]] static panel_io::i2c_config
    i2c_io_config(uint16_t device_address = 0x3C, freq::hertz scl_speed = freq::hertz{400000}) noexcept;
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    [[nodiscard]] explicit ssd1306(idfxx::panel_io& panel_io, config config);
#endif
 
    [[nodiscard]] static result<ssd1306> make(idfxx::panel_io& panel_io, config config);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    void set_contrast(uint8_t level) { unwrap(try_set_contrast(level)); }
#endif
 
    [[nodiscard]] result<void> try_set_contrast(uint8_t level);
 
    ~ssd1306();
 
    ssd1306(const ssd1306&) = delete;
    ssd1306& operator=(const ssd1306&) = delete;
    ssd1306(ssd1306&& other) noexcept;
    ssd1306& operator=(ssd1306&& other) noexcept;
 
private:
    explicit ssd1306(esp_lcd_panel_io_handle_t io_handle, esp_lcd_panel_handle_t handle, size_t height)
        : panel(128, height)
        , _io_handle(io_handle)
        , _handle(handle) {}
 
    // lcd::panel customization hooks.
    [[nodiscard]] esp_lcd_panel_handle_t do_idf_handle() const override;
 
    esp_lcd_panel_io_handle_t _io_handle = nullptr;
    esp_lcd_panel_handle_t _handle = nullptr;
};
 
} // namespace idfxx::lcd