/home/runner/work/EX-Display/EX-Display/TFT_eSPIDisplay.h

Go to the documentation of this file.

/*
 *  © 2024 Peter Cole
 *
 *  This is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  It is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this code.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef TFT_ESPIDISPLAY_H
#define TFT_ESPIDISPLAY_H
 
// Do not load when testing, TFT_eSPI library is incompatible and will cause failures.
#ifndef PIO_UNIT_TESTING
 
#include "Defines.h"
#include "DisplayInterface.h"
#include <SPI.h>
#include <TFT_eSPI.h>
 
// Define the standard fonts available for this display type
#define FONT_TFT_ESPI_SMALL &FreeMono9pt7b
#define FONT_TFT_ESPI_MEDIUM &FreeMono12pt7b
#define FONT_TFT_ESPI_LARGE &FreeMono18pt7b
#define FONT_TFT_ESPI_XLARGE &FreeMono24pt7b
#define FONT_TFT_ESPI_SMALL_SANS &FreeSans9pt7b
#define FONT_TFT_ESPI_MEDIUM_SANS &FreeSans12pt7b
#define FONT_TFT_ESPI_LARGE_SANS &FreeSans18pt7b
#define FONT_TFT_ESPI_XLARGE_SANS &FreeSans24pt7b
#define FONT_TFT_ESPI_MEDIUM_BOLD &FreeMonoBold12pt7b
#define FONT_TFT_ESPI_SERIF_BOLD_ITALIC &FreeSerifBoldItalic12pt7b
 
// If not overridden by myConfig.h, set the font
#ifndef TEXT_FONT
#define TEXT_FONT FONT_TFT_ESPI_MEDIUM_BOLD
#endif
 
// #define LOCAL_FONT FONT_TFT
class TFT_eSPIDisplay : public DisplayInterface {
public:
  TFT_eSPIDisplay(uint8_t rotation, const GFXfont *textFont, uint16_t textColour, uint16_t backgroundColour);
 
  TFT_eSPIDisplay(uint8_t rotation, const GFXfont *textFont, uint16_t textColour, uint16_t backgroundColour, int csPin);
 
  void begin() override;
 
  void clearScreen() override;
 
  void displayScreen(Screen *screen) override;
 
  void clearRow(uint8_t row);
 
  void displayStartupInfo(const char *version) override;
 
  virtual void displayFormattedRow(uint8_t row, uint8_t column, RowAttributes attributes, const char *text,
                                   bool append) override;
 
  TFT_eSPI *getTFT_eSPIInstance();
 
  bool tftInitialised();
 
  static TFT_eSPIDisplay *create(uint8_t rotation, const GFXfont *textFont, uint16_t textColour,
                                 uint16_t backgroundColour);
 
  static TFT_eSPIDisplay *create(uint8_t rotation, const GFXfont *textFont, uint16_t textColour,
                                 uint16_t backgroundColour, int csPin);
 
  ~TFT_eSPIDisplay() override;
 
private:
  static TFT_eSPI *_tft;
  const GFXfont *_gfxFont;
  static bool _tftInitialised;
 
  void _getRowPosition(uint8_t row, uint8_t column, int32_t &x, int32_t &y);
};
 
#endif // PIO_UNIT_TESTING
 
#endif // TFT_ESPIDISPLAY_H