libepaper 2.0.0
A C++23 library for controlling Waveshare e-paper displays on Raspberry Pi, featuring transparent sleep/wake management and a fluent builder API.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
epaper::MockDriver Class Reference

#include <mock_driver.hpp>

Public Member Functions

 MockDriver (Device &device, std::size_t width=600, std::size_t height=300, bool save_images=true) noexcept
 Construct MockDriver using Linux Device with custom dimensions.
 
 ~MockDriver ()=default
 
auto init (DisplayMode mode) -> std::expected< void, Error >
 
auto clear () -> std::expected< void, Error >
 
auto display (std::span< const std::byte > buffer) -> std::expected< void, Error >
 
auto display_planes (std::span< const std::span< const std::byte > > planes) -> std::expected< void, Error >
 
auto sleep () -> std::expected< void, Error >
 
auto wake () -> std::expected< void, Error >
 
auto power_off () -> std::expected< void, Error >
 
auto power_on () -> std::expected< void, Error >
 
auto width () const noexcept -> std::size_t
 
auto height () const noexcept -> std::size_t
 
auto mode () const noexcept -> DisplayMode
 
auto buffer_size () const noexcept -> std::size_t
 
auto supports_partial_refresh () const noexcept -> bool
 
auto supports_power_control () const noexcept -> bool
 
auto supports_wake () const noexcept -> bool
 
auto configure_init_failure (bool should_fail) noexcept -> void
 
auto configure_display_failure (bool should_fail) noexcept -> void
 
auto configure_sleep_failure (bool should_fail) noexcept -> void
 
auto configure_wake_failure (bool should_fail) noexcept -> void
 
auto init_called () const noexcept -> bool
 
auto display_called () const noexcept -> bool
 
auto sleep_called () const noexcept -> bool
 
auto wake_called () const noexcept -> bool
 
auto clear_called () const noexcept -> bool
 
auto init_count () const noexcept -> std::size_t
 
auto display_count () const noexcept -> std::size_t
 
auto sleep_count () const noexcept -> std::size_t
 
auto wake_count () const noexcept -> std::size_t
 
auto clear_count () const noexcept -> std::size_t
 
auto is_asleep () const noexcept -> bool
 
auto is_initialized () const noexcept -> bool
 
auto last_buffer () const noexcept -> const std::vector< std::byte > &
 
auto reset_counts () noexcept -> void
 
auto set_output_directory (std::string_view dir) -> void
 
auto enable_image_saving (bool enable) -> void
 

Constructor & Destructor Documentation

◆ MockDriver()

epaper::MockDriver::MockDriver ( Device device,
std::size_t  width = 600,
std::size_t  height = 300,
bool  save_images = true 
)
inlineexplicitnoexcept

Construct MockDriver using Linux Device with custom dimensions.

Parameters
deviceInitialized Linux device
widthDisplay width in pixels (default: 600)
heightDisplay height in pixels (default: 300)
save_imagesWhether to automatically save PNG images on refresh (default: true)

◆ ~MockDriver()

epaper::MockDriver::~MockDriver ( )
default

Member Function Documentation

◆ buffer_size()

auto epaper::MockDriver::buffer_size ( ) const -> std::size_t
inlinenoexcept
Examples
/mnt/nas/libepaper/include/epaper/drivers/mock_driver.hpp.
Here is the call graph for this function:

◆ clear()

auto epaper::MockDriver::clear ( ) -> std::expected<void, Error>
inline

◆ clear_called()

auto epaper::MockDriver::clear_called ( ) const -> bool
inlinenoexcept

◆ clear_count()

auto epaper::MockDriver::clear_count ( ) const -> std::size_t
inlinenoexcept

◆ configure_display_failure()

auto epaper::MockDriver::configure_display_failure ( bool  should_fail) -> void
inlinenoexcept

◆ configure_init_failure()

auto epaper::MockDriver::configure_init_failure ( bool  should_fail) -> void
inlinenoexcept

◆ configure_sleep_failure()

auto epaper::MockDriver::configure_sleep_failure ( bool  should_fail) -> void
inlinenoexcept

◆ configure_wake_failure()

auto epaper::MockDriver::configure_wake_failure ( bool  should_fail) -> void
inlinenoexcept

◆ display()

auto epaper::MockDriver::display ( std::span< const std::byte >  buffer) -> std::expected<void, Error>
inline
Examples
/mnt/nas/libepaper/include/epaper/drivers/mock_driver.hpp.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ display_called()

auto epaper::MockDriver::display_called ( ) const -> bool
inlinenoexcept

◆ display_count()

auto epaper::MockDriver::display_count ( ) const -> std::size_t
inlinenoexcept

◆ display_planes()

auto epaper::MockDriver::display_planes ( std::span< const std::span< const std::byte > >  planes) -> std::expected<void, Error>
inline
Examples
/mnt/nas/libepaper/include/epaper/drivers/mock_driver.hpp.
Here is the call graph for this function:

◆ enable_image_saving()

auto epaper::MockDriver::enable_image_saving ( bool  enable) -> void
inline

◆ height()

auto epaper::MockDriver::height ( ) const -> std::size_t
inlinenoexcept

◆ init()

auto epaper::MockDriver::init ( DisplayMode  mode) -> std::expected<void, Error>
inline
Examples
/mnt/nas/libepaper/include/epaper/drivers/mock_driver.hpp.
Here is the call graph for this function:

◆ init_called()

auto epaper::MockDriver::init_called ( ) const -> bool
inlinenoexcept

◆ init_count()

auto epaper::MockDriver::init_count ( ) const -> std::size_t
inlinenoexcept

◆ is_asleep()

auto epaper::MockDriver::is_asleep ( ) const -> bool
inlinenoexcept

◆ is_initialized()

auto epaper::MockDriver::is_initialized ( ) const -> bool
inlinenoexcept

◆ last_buffer()

auto epaper::MockDriver::last_buffer ( ) const -> const std::vector<std::byte> &
inlinenoexcept

◆ mode()

auto epaper::MockDriver::mode ( ) const -> DisplayMode
inlinenoexcept
Examples
/mnt/nas/libepaper/include/epaper/drivers/mock_driver.hpp.
Here is the caller graph for this function:

◆ power_off()

auto epaper::MockDriver::power_off ( ) -> std::expected<void, Error>
inline

◆ power_on()

auto epaper::MockDriver::power_on ( ) -> std::expected<void, Error>
inline

◆ reset_counts()

auto epaper::MockDriver::reset_counts ( ) -> void
inlinenoexcept

◆ set_output_directory()

auto epaper::MockDriver::set_output_directory ( std::string_view  dir) -> void
inline

◆ sleep()

auto epaper::MockDriver::sleep ( ) -> std::expected<void, Error>
inline

◆ sleep_called()

auto epaper::MockDriver::sleep_called ( ) const -> bool
inlinenoexcept

◆ sleep_count()

auto epaper::MockDriver::sleep_count ( ) const -> std::size_t
inlinenoexcept

◆ supports_partial_refresh()

auto epaper::MockDriver::supports_partial_refresh ( ) const -> bool
inlinenoexcept

◆ supports_power_control()

auto epaper::MockDriver::supports_power_control ( ) const -> bool
inlinenoexcept

◆ supports_wake()

auto epaper::MockDriver::supports_wake ( ) const -> bool
inlinenoexcept

◆ wake()

auto epaper::MockDriver::wake ( ) -> std::expected<void, Error>
inline
Examples
/mnt/nas/libepaper/include/epaper/drivers/mock_driver.hpp.
Here is the caller graph for this function:

◆ wake_called()

auto epaper::MockDriver::wake_called ( ) const -> bool
inlinenoexcept

◆ wake_count()

auto epaper::MockDriver::wake_count ( ) const -> std::size_t
inlinenoexcept

◆ width()

auto epaper::MockDriver::width ( ) const -> std::size_t
inlinenoexcept

The documentation for this class was generated from the following file: