isf15acp4.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <cstdint>
 
#include "isf15acp4_button_ui.hpp"
#include "isf15acp4_canvas.hpp"
#include "isf15acp4_graphics_context.hpp"
#include "isf15acp4_spi_interface.hpp"
#include "isf15acp4_ssd1331.hpp"
#include "isf15acp4_types.hpp"
#include "isf15acp4_version.h"
 
namespace isf15acp4 {
 
template <typename SpiType>
class SmartDisplay {
public:
    SmartDisplay(SpiType* bus, const SmartDisplayConfig& config) noexcept;
 
    SmartDisplay(SpiType* bus, ProductVariant variant = ProductVariant::Isf15acp4) noexcept;
 
    bool Initialize(bool enable_vcc = true) noexcept;
 
    [[nodiscard]] bool IsInitialized() const noexcept { return initialized_; }
 
    bool Reset(bool enable_vcc = true) noexcept;
 
    bool DisplayOn() noexcept;
 
    bool DisplayOff() noexcept;
 
    bool DisplayDim() noexcept;
 
    bool SetMasterCurrent(uint8_t level) noexcept;
 
    bool SetWindow(const Rect& rect) noexcept;
 
    bool SetFullWindow() noexcept;
 
    bool WritePixels(const uint8_t* data, std::size_t byte_len) noexcept;
 
    bool WriteColors(const Color565* colors, std::size_t count) noexcept;
 
    bool DrawCanvas(const Canvas& canvas) noexcept;
 
    bool Present(const GraphicsContext& gfx) noexcept;
 
    [[nodiscard]] GraphicsContext CreateGraphicsContext() noexcept;
 
    [[nodiscard]] GraphicsContext CreateGraphicsContext() const noexcept;
 
    void ConfigurePresenter(GraphicsContext& gfx) noexcept;
 
    [[nodiscard]] GraphicsBackend GetGraphicsBackend() const noexcept { return config_.graphics; }
 
    [[nodiscard]] const SmartDisplayConfig& GetConfig() const noexcept { return config_; }
 
    bool DrawPixel(uint8_t x, uint8_t y, Color565 color) noexcept;
 
    bool FillScreen(Color565 color) noexcept;
 
    bool DrawLine(const Point& start, const Point& end, Color565 color) noexcept;
 
    bool DrawRectangle(const Rect& rect, Color565 color, bool filled = false) noexcept;
 
    bool ClearWindow(const Rect& rect) noexcept;
 
    [[nodiscard]] bool IsPressed() const noexcept;
 
    bool ConfigureScroll(uint8_t h_offset, uint8_t start_row, uint8_t scroll_rows,
                         uint8_t v_offset, uint8_t interval_code, bool activate) noexcept;
 
    bool StopScroll() noexcept;
 
    bool StopScroll(const GraphicsContext& gfx) noexcept;
 
    [[nodiscard]] uint16_t GetErrorFlags() const noexcept { return error_flags_; }
    [[nodiscard]] bool HasError(Error e) const noexcept {
        return (error_flags_ & static_cast<uint16_t>(e)) != 0;
    }
    void ClearErrorFlags(uint16_t mask = 0xFFFF) noexcept { error_flags_ &= static_cast<uint16_t>(~mask); }
    [[nodiscard]] Error GetLastError() const noexcept { return last_error_; }
 
    [[nodiscard]] const DisplayGeometry& Geometry() const noexcept { return geometry_; }
    [[nodiscard]] ProductVariant Variant() const noexcept { return variant_; }
 
    static constexpr const char* GetDriverVersion() noexcept { return HF_ISF15ACP4_VERSION_STRING; }
    static constexpr uint8_t GetDriverVersionMajor() noexcept { return HF_ISF15ACP4_VERSION_MAJOR; }
    static constexpr uint8_t GetDriverVersionMinor() noexcept { return HF_ISF15ACP4_VERSION_MINOR; }
    static constexpr uint8_t GetDriverVersionPatch() noexcept { return HF_ISF15ACP4_VERSION_PATCH; }
 
private:
    SpiType* bus_;
    SmartDisplayConfig config_;
    ProductVariant variant_;
    DisplayGeometry geometry_;
    Rect window_{};
    bool initialized_{false};
    Error last_error_{Error::None};
    uint16_t error_flags_{0};
 
    void setError(Error e) noexcept;
    bool sendCommand(uint8_t cmd, const uint8_t* data, uint8_t len) noexcept;
    bool sendCommandByte(uint8_t cmd, uint8_t data) noexcept;
    bool sendCommandOnly(uint8_t cmd) noexcept;
    void pulseReset() noexcept;
    bool runInitTable() noexcept;
    static void colorToSsd1331(Color565 color, uint8_t out[3]) noexcept;
    [[nodiscard]] Rect toRam(const Rect& rect) const noexcept;
};
 
inline const char* GetDriverVersion() noexcept { return HF_ISF15ACP4_VERSION_STRING; }
 
}  // namespace isf15acp4
 
#define ISF15ACP4_HEADER_INCLUDED
#include "../src/isf15acp4.ipp"
#undef ISF15ACP4_HEADER_INCLUDED