lcd_ssd1306.h

Go to the documentation of this file.

/*
    MIT License

    Copyright 2019-2022 (C) Alexey Dynda

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
*/
/* !!! THIS FILE IS AUTO GENERATED !!! */
#pragma once

#include "lcd_hal/io.h"
#include "v2/lcd/lcd_common.h"
#include "v2/lcd/base/display.h"

template <typename I> class InterfaceSSD1306: public I
{
public:
    template <typename... Args>
    InterfaceSSD1306(NanoDisplayBase<InterfaceSSD1306<I>> &base, int8_t dc, Args &&... data)
        : I(data...)
        , m_dc(dc)
        , m_base(base)
    {
    }

    void startBlock(lcduint_t x, lcduint_t y, lcduint_t w);

    void nextBlock();

    void endBlock();

    void setDataMode(uint8_t mode);

    void commandStart();

    void setStartLine(uint8_t line);

    uint8_t getStartLine();

    void normalMode();

    void invertMode();

    void setContrast(uint8_t contrast);

    void displayOff();

    void displayOn();

    void flipHorizontal(uint8_t mode);

    void flipVertical(uint8_t mode);

private:
    int8_t m_dc = -1;                             
    NanoDisplayBase<InterfaceSSD1306<I>> &m_base; 
    uint8_t m_startLine = 0;
};
template <typename I> class DisplaySSD1306: public NanoDisplayOps<NanoDisplayOps1<I>, I>
{
public:
    DisplaySSD1306(I &intf, int8_t rstPin)
        : NanoDisplayOps<NanoDisplayOps1<I>, I>(intf)
        , m_rstPin(rstPin)
    {
    }

protected:
    int8_t m_rstPin; 

    void beginDisplay();

    void endDisplay();
};

template <typename I> class DisplaySSD1306_64x32: public DisplaySSD1306<I>
{
public:
    DisplaySSD1306_64x32(I &intf, int8_t rstPin)
        : DisplaySSD1306<I>(intf, rstPin)
    {
    }

protected:
    void beginController();

    void endController();
};
#ifdef CONFIG_LCDGFX_PLATFORM_SPI

class DisplaySSD1306_64x32_SPI: public DisplaySSD1306_64x32<InterfaceSSD1306<PlatformSpi>>
{
public:
    explicit DisplaySSD1306_64x32_SPI(int8_t rstPin, const SPlatformSpiConfig &config = {-1, {-1}, -1, 0U, -1, -1})
        : DisplaySSD1306_64x32(m_spi, rstPin)
        , m_spi(*this, config.dc,
                SPlatformSpiConfig{
                    config.busId, {config.cs}, config.dc, config.frequency ?: static_cast<uint32_t>(10000000), config.scl, config.sda})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformSpi> m_spi;
};
#endif

template <typename I> class DisplaySSD1306_64x32_CustomSPI: public DisplaySSD1306_64x32<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_64x32_CustomSPI(int8_t rstPin, int8_t dcPin, Args &&... data)
        : DisplaySSD1306_64x32<InterfaceSSD1306<I>>(m_spi, rstPin)
        , m_spi(*this, dcPin, data...)
    {
    }

    void begin() override
    {
        m_spi.begin();
        DisplaySSD1306_64x32<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_64x32<InterfaceSSD1306<I>>::endController();
        m_spi.end();
    }

private:
    InterfaceSSD1306<I> m_spi;
};
#ifdef CONFIG_LCDGFX_PLATFORM_I2C

class DisplaySSD1306_64x32_I2C: public DisplaySSD1306_64x32<InterfaceSSD1306<PlatformI2c>>
{
public:
    explicit DisplaySSD1306_64x32_I2C(int8_t rstPin, const SPlatformI2cConfig &config = {-1, 0x3C, -1, -1, 0U})
        : DisplaySSD1306_64x32(m_i2c, rstPin)
        , m_i2c(*this, -1,
                SPlatformI2cConfig{config.busId, static_cast<uint8_t>(config.addr ?: 0x3C), config.scl, config.sda,
                                   config.frequency ?: 400000U})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformI2c> m_i2c;
};
#endif

template <typename I> class DisplaySSD1306_64x32_CustomI2C: public DisplaySSD1306_64x32<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_64x32_CustomI2C(int8_t rstPin, Args &&... data)
        : DisplaySSD1306_64x32<InterfaceSSD1306<I>>(m_i2c, rstPin)
        , m_i2c(*this, -1, data...)
    {
    }

    void begin() override
    {
        m_i2c.begin();
        DisplaySSD1306_64x32<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_64x32<InterfaceSSD1306<I>>::endController();
        m_i2c.end();
    }

private:
    InterfaceSSD1306<I> m_i2c;
};
template <typename I> class DisplaySSD1306_64x32_Custom: public DisplaySSD1306_64x32<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_64x32_Custom(int8_t rstPin, int8_t dcPin, uint32_t frequency, Args &&... data)
        : DisplaySSD1306_64x32<InterfaceSSD1306<I>>(m_custom, rstPin)
        , m_custom(*this, dcPin, frequency = frequency ? frequency : 3000000, data...)
    {
    }

    void begin() override
    {
        m_custom.begin();
        DisplaySSD1306_64x32<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_64x32<InterfaceSSD1306<I>>::endController();
        m_custom.end();
    }

private:
    InterfaceSSD1306<I> m_custom;
};
template <typename I> class DisplaySSD1306_64x48: public DisplaySSD1306<I>
{
public:
    DisplaySSD1306_64x48(I &intf, int8_t rstPin)
        : DisplaySSD1306<I>(intf, rstPin)
    {
    }

protected:
    void beginController();

    void endController();
};
#ifdef CONFIG_LCDGFX_PLATFORM_SPI

class DisplaySSD1306_64x48_SPI: public DisplaySSD1306_64x48<InterfaceSSD1306<PlatformSpi>>
{
public:
    explicit DisplaySSD1306_64x48_SPI(int8_t rstPin, const SPlatformSpiConfig &config = {-1, {-1}, -1, 0U, -1, -1})
        : DisplaySSD1306_64x48(m_spi, rstPin)
        , m_spi(*this, config.dc,
                SPlatformSpiConfig{
                    config.busId, {config.cs}, config.dc, config.frequency ?: static_cast<uint32_t>(10000000), config.scl, config.sda})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformSpi> m_spi;
};
#endif

template <typename I> class DisplaySSD1306_64x48_CustomSPI: public DisplaySSD1306_64x48<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_64x48_CustomSPI(int8_t rstPin, int8_t dcPin, Args &&... data)
        : DisplaySSD1306_64x48<InterfaceSSD1306<I>>(m_spi, rstPin)
        , m_spi(*this, dcPin, data...)
    {
    }

    void begin() override
    {
        m_spi.begin();
        DisplaySSD1306_64x48<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_64x48<InterfaceSSD1306<I>>::endController();
        m_spi.end();
    }

private:
    InterfaceSSD1306<I> m_spi;
};
#ifdef CONFIG_LCDGFX_PLATFORM_I2C

class DisplaySSD1306_64x48_I2C: public DisplaySSD1306_64x48<InterfaceSSD1306<PlatformI2c>>
{
public:
    explicit DisplaySSD1306_64x48_I2C(int8_t rstPin, const SPlatformI2cConfig &config = {-1, 0x3C, -1, -1, 0U})
        : DisplaySSD1306_64x48(m_i2c, rstPin)
        , m_i2c(*this, -1,
                SPlatformI2cConfig{config.busId, static_cast<uint8_t>(config.addr ?: 0x3C), config.scl, config.sda,
                                   config.frequency ?: 400000U})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformI2c> m_i2c;
};
#endif

template <typename I> class DisplaySSD1306_64x48_CustomI2C: public DisplaySSD1306_64x48<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_64x48_CustomI2C(int8_t rstPin, Args &&... data)
        : DisplaySSD1306_64x48<InterfaceSSD1306<I>>(m_i2c, rstPin)
        , m_i2c(*this, -1, data...)
    {
    }

    void begin() override
    {
        m_i2c.begin();
        DisplaySSD1306_64x48<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_64x48<InterfaceSSD1306<I>>::endController();
        m_i2c.end();
    }

private:
    InterfaceSSD1306<I> m_i2c;
};
template <typename I> class DisplaySSD1306_64x48_Custom: public DisplaySSD1306_64x48<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_64x48_Custom(int8_t rstPin, int8_t dcPin, uint32_t frequency, Args &&... data)
        : DisplaySSD1306_64x48<InterfaceSSD1306<I>>(m_custom, rstPin)
        , m_custom(*this, dcPin, frequency = frequency ? frequency : 3000000, data...)
    {
    }

    void begin() override
    {
        m_custom.begin();
        DisplaySSD1306_64x48<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_64x48<InterfaceSSD1306<I>>::endController();
        m_custom.end();
    }

private:
    InterfaceSSD1306<I> m_custom;
};
template <typename I> class DisplaySSD1306_128x32: public DisplaySSD1306<I>
{
public:
    DisplaySSD1306_128x32(I &intf, int8_t rstPin)
        : DisplaySSD1306<I>(intf, rstPin)
    {
    }

protected:
    void beginController();

    void endController();
};
#ifdef CONFIG_LCDGFX_PLATFORM_SPI

class DisplaySSD1306_128x32_SPI: public DisplaySSD1306_128x32<InterfaceSSD1306<PlatformSpi>>
{
public:
    explicit DisplaySSD1306_128x32_SPI(int8_t rstPin, const SPlatformSpiConfig &config = {-1, {-1}, -1, 0U, -1, -1})
        : DisplaySSD1306_128x32(m_spi, rstPin)
        , m_spi(*this, config.dc,
                SPlatformSpiConfig{
                    config.busId, {config.cs}, config.dc, config.frequency ?: static_cast<uint32_t>(10000000), config.scl, config.sda})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformSpi> m_spi;
};
#endif

template <typename I> class DisplaySSD1306_128x32_CustomSPI: public DisplaySSD1306_128x32<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_128x32_CustomSPI(int8_t rstPin, int8_t dcPin, Args &&... data)
        : DisplaySSD1306_128x32<InterfaceSSD1306<I>>(m_spi, rstPin)
        , m_spi(*this, dcPin, data...)
    {
    }

    void begin() override
    {
        m_spi.begin();
        DisplaySSD1306_128x32<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_128x32<InterfaceSSD1306<I>>::endController();
        m_spi.end();
    }

private:
    InterfaceSSD1306<I> m_spi;
};
#ifdef CONFIG_LCDGFX_PLATFORM_I2C

class DisplaySSD1306_128x32_I2C: public DisplaySSD1306_128x32<InterfaceSSD1306<PlatformI2c>>
{
public:
    explicit DisplaySSD1306_128x32_I2C(int8_t rstPin, const SPlatformI2cConfig &config = {-1, 0x3C, -1, -1, 0U})
        : DisplaySSD1306_128x32(m_i2c, rstPin)
        , m_i2c(*this, -1,
                SPlatformI2cConfig{config.busId, static_cast<uint8_t>(config.addr ?: 0x3C), config.scl, config.sda,
                                   config.frequency ?: 400000U})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformI2c> m_i2c;
};
#endif

template <typename I> class DisplaySSD1306_128x32_CustomI2C: public DisplaySSD1306_128x32<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_128x32_CustomI2C(int8_t rstPin, Args &&... data)
        : DisplaySSD1306_128x32<InterfaceSSD1306<I>>(m_i2c, rstPin)
        , m_i2c(*this, -1, data...)
    {
    }

    void begin() override
    {
        m_i2c.begin();
        DisplaySSD1306_128x32<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_128x32<InterfaceSSD1306<I>>::endController();
        m_i2c.end();
    }

private:
    InterfaceSSD1306<I> m_i2c;
};
template <typename I> class DisplaySSD1306_128x32_Custom: public DisplaySSD1306_128x32<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_128x32_Custom(int8_t rstPin, int8_t dcPin, uint32_t frequency, Args &&... data)
        : DisplaySSD1306_128x32<InterfaceSSD1306<I>>(m_custom, rstPin)
        , m_custom(*this, dcPin, frequency = frequency ? frequency : 3000000, data...)
    {
    }

    void begin() override
    {
        m_custom.begin();
        DisplaySSD1306_128x32<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_128x32<InterfaceSSD1306<I>>::endController();
        m_custom.end();
    }

private:
    InterfaceSSD1306<I> m_custom;
};
template <typename I> class DisplaySSD1306_128x64: public DisplaySSD1306<I>
{
public:
    DisplaySSD1306_128x64(I &intf, int8_t rstPin)
        : DisplaySSD1306<I>(intf, rstPin)
    {
    }

protected:
    void beginController();

    void endController();
};
#ifdef CONFIG_LCDGFX_PLATFORM_SPI

class DisplaySSD1306_128x64_SPI: public DisplaySSD1306_128x64<InterfaceSSD1306<PlatformSpi>>
{
public:
    explicit DisplaySSD1306_128x64_SPI(int8_t rstPin, const SPlatformSpiConfig &config = {-1, {-1}, -1, 0U, -1, -1})
        : DisplaySSD1306_128x64(m_spi, rstPin)
        , m_spi(*this, config.dc,
                SPlatformSpiConfig{
                    config.busId, {config.cs}, config.dc, config.frequency ?: static_cast<uint32_t>(10000000), config.scl, config.sda})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformSpi> m_spi;
};
#endif

template <typename I> class DisplaySSD1306_128x64_CustomSPI: public DisplaySSD1306_128x64<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_128x64_CustomSPI(int8_t rstPin, int8_t dcPin, Args &&... data)
        : DisplaySSD1306_128x64<InterfaceSSD1306<I>>(m_spi, rstPin)
        , m_spi(*this, dcPin, data...)
    {
    }

    void begin() override
    {
        m_spi.begin();
        DisplaySSD1306_128x64<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_128x64<InterfaceSSD1306<I>>::endController();
        m_spi.end();
    }

private:
    InterfaceSSD1306<I> m_spi;
};
#ifdef CONFIG_LCDGFX_PLATFORM_I2C

class DisplaySSD1306_128x64_I2C: public DisplaySSD1306_128x64<InterfaceSSD1306<PlatformI2c>>
{
public:
    explicit DisplaySSD1306_128x64_I2C(int8_t rstPin, const SPlatformI2cConfig &config = {-1, 0x3C, -1, -1, 0U})
        : DisplaySSD1306_128x64(m_i2c, rstPin)
        , m_i2c(*this, -1,
                SPlatformI2cConfig{config.busId, static_cast<uint8_t>(config.addr ?: 0x3C), config.scl, config.sda,
                                   config.frequency ?: 400000U})
    {
    }

    void begin() override;

    void end() override;

private:
    InterfaceSSD1306<PlatformI2c> m_i2c;
};
#endif

template <typename I> class DisplaySSD1306_128x64_CustomI2C: public DisplaySSD1306_128x64<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_128x64_CustomI2C(int8_t rstPin, Args &&... data)
        : DisplaySSD1306_128x64<InterfaceSSD1306<I>>(m_i2c, rstPin)
        , m_i2c(*this, -1, data...)
    {
    }

    void begin() override
    {
        m_i2c.begin();
        DisplaySSD1306_128x64<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_128x64<InterfaceSSD1306<I>>::endController();
        m_i2c.end();
    }

private:
    InterfaceSSD1306<I> m_i2c;
};
template <typename I> class DisplaySSD1306_128x64_Custom: public DisplaySSD1306_128x64<InterfaceSSD1306<I>>
{
public:
    template <typename... Args>
    DisplaySSD1306_128x64_Custom(int8_t rstPin, int8_t dcPin, uint32_t frequency, Args &&... data)
        : DisplaySSD1306_128x64<InterfaceSSD1306<I>>(m_custom, rstPin)
        , m_custom(*this, dcPin, frequency = frequency ? frequency : 3000000, data...)
    {
    }

    void begin() override
    {
        m_custom.begin();
        DisplaySSD1306_128x64<InterfaceSSD1306<I>>::beginController();
    }

    void end() override
    {
        DisplaySSD1306_128x64<InterfaceSSD1306<I>>::endController();
        m_custom.end();
    }

private:
    InterfaceSSD1306<I> m_custom;
};
#include "lcd_ssd1306.inl"