dispDrvBase.h

/*!
 * @file src/components/display/drivers/dispDrvBase.h
 *
 * Abstract base class for display drivers.
 *
 * Adafruit invests time and resources providing this open source code,
 * please support Adafruit and open-source hardware by purchasing
 * products from Adafruit!
 *
 * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
 *
 * BSD license, all text here must be included in any redistribution.
 *
 */
#ifndef WS_DISP_DRV_BASE_H
#define WS_DISP_DRV_BASE_H
#ifndef ARDUINO_ARCH_ESP8266
#include "../assets/icons.h"
#include "../assets/splash.h"
#endif // ARDUINO_ARCH_ESP8266
#include "Adafruit_ThinkInk.h"
#include "Wippersnapper.h"

/*!
    @brief  Abstract base class for display drivers.
            This class provides a common interface for all display drivers,
            allowing them to be used interchangeably.
*/
class dispDrvBase {
public:
  /*!
      @brief  Constructor for the base display driver for E-Ink displays.
      @param  dc
              Data/Command pin for the display.
      @param  rst
              Reset pin for the display.
      @param  cs
              Chip Select pin for the display.
      @param  sram_cs
              Optional SRAM Chip Select pin for E-Ink displays that support it.
      @param  busy
              Optional Busy pin for the display.
  */
  dispDrvBase(int16_t dc, int16_t rst, int16_t cs, int16_t sram_cs = -1,
              int16_t busy = -1)
      : _pin_dc(dc), _pin_rst(rst), _pin_cs(cs), _pin_sram_cs(sram_cs),
        _pin_busy(busy) {}

  /*!
      @brief  Constructor for the base display driver for SPI TFT displays.
      @param  cs
              Chip Select pin for the display.
      @param  dc
              Data/Command pin for the display.
      @param  mosi
              MOSI pin for the display.
      @param  sck
              SCK pin for the display.
      @param  rst
              Optional Reset pin for the display.
      @param  miso
              Optional MISO pin for the display.
  */
  dispDrvBase(int8_t cs, int8_t dc, int8_t mosi, int8_t sck, int8_t rst = -1,
              int8_t miso = -1)
      : _pin_cs(cs), _pin_dc(dc), _pin_mosi(mosi), _pin_sck(sck), _pin_rst(rst),
        _pin_miso(miso) {}

  /*!
      @brief  Destructor for the base display driver.
              This destructor is virtual to allow derived classes to clean up
              resources properly.
  */
  virtual ~dispDrvBase() {}

  /*!
      @brief  Attempts to initialize a ThinkInk EPD driver.
      @param  mode
              The ThinkInk mode to use for the display.
      @param  reset
              Whether to reset the display before initialization.
      @return True if the display was initialized successfully, false otherwise.
  */
  virtual bool begin(thinkinkmode_t mode, bool reset = true) { return false; }

  /*!
      @brief  Attempts to initialize a SPI TFT driver.
      @return True if the display was initialized successfully, false otherwise.
  */
  virtual bool begin() { return false; }

  /*!
      @brief  Writes a message to the display.
      @param  message
              The message to write to the display.
      @note   MUST be implemented by derived classes.
  */
  virtual void writeMessage(const char *message) = 0;

  /*!
      @brief  Sets the width of the display.
      @param  w
              The width of the display in pixels.
  */
  void setWidth(int16_t w) { _width = w; }

  /*!
      @brief  Sets the height of the display.
      @param  h
              The height of the display in pixels.
  */
  void setHeight(int16_t h) { _height = h; }

  /*!
      @brief  Sets the rotation of the display.
      @param  r
              The rotation of the display (0-3).
  */
  void setRotation(uint8_t r) { _rotation = r; }

  /*!
      @brief  Sets the text size for the display.
      @param  s
              The text size to set.
      @note   This method can be overridden by derived classes to provide
              specific functionality.
  */
  virtual void setTextSize(uint8_t s) { _text_sz = s; }

  /*!
      @brief  Displays a splash screen on the display.
      @note   This method can be overridden by derived classes to provide
              specific functionality.
  */
  virtual void showSplash() { // No-op for base class
  }

  /*!
    @brief  Draws a status bar at the top of the display.
    @param io_username
            The username to display on the status bar.
    @note   This method can be overridden by derived classes to provide
            specific functionality.
  */
  virtual void drawStatusBar(const char *io_username) {
    // No-op for base class
  }

  /*!
    @brief  Updates the status bar with current information (battery level,
    connectivity status, etc).
    @param  rssi
            The current WiFi RSSI (signal strength) in dB.
    @param  bat
            The current battery level as a percentage (0-100).
    @param  mqtt_status
            The current MQTT connection status.
    @note   This method can be overridden by derived classes to provide
            specific functionality.
  */
  virtual void updateStatusBar(int8_t rssi, uint8_t bat, bool mqtt_status) {
    // No-op for base class
  }

protected:
  int16_t _pin_dc;      ///< Data/Command pin
  int16_t _pin_rst;     ///< Reset pin
  int16_t _pin_cs;      ///< Chip Select pin
  int16_t _pin_busy;    ///< Optional Busy pin
  int16_t _pin_sram_cs; ///< Optional EPD SRAM chip select pin
  uint16_t _pin_mosi;   ///< Optional MOSI pin for SPI TFT displays
  uint16_t _pin_miso;   ///< Optional MISO pin for SPI TFT displays
  uint16_t _pin_sck;    ///< Optional SCK pin for SPI TFT displays
  uint8_t _text_sz = 1; ///< Text size for displaying a message
  int16_t _height;      ///< Height of the display
  int16_t _width;       ///< Width of the display
  uint8_t _rotation;    ///< Rotation of the display
  // statusbar properties
  int _statusbar_icons_y;        ///< Y position of status bar icons
  int _statusbar_icon_battery_x; ///< X position of battery icon
  int _statusbar_icon_wifi_x;    ///< X position of WiFi icon
  int _statusbar_icon_cloud_x;   ///< X position of cloud icon
  int8_t _statusbar_rssi;        ///< RSSI value for status bar
  uint8_t
      _statusbar_bat; ///< Battery level, as a percentage, for the status bar
  bool _statusbar_mqtt_connected; ///< MQTT connection status for the status bar
};

#endif // WS_DISP_DRV_BASE_H