184 lines
9 KiB
C
184 lines
9 KiB
C
// USER DEFINED SETTINGS
|
|
// Set driver type, fonts to be loaded, pins used and SPI control method etc
|
|
//
|
|
// See the User_Setup_Select.h file if you wish to be able to define multiple
|
|
// setups and then easily select which setup file is used by the compiler.
|
|
//
|
|
// If this file is edited correctly then all the library example sketches should
|
|
// run without the need to make any more changes for a particular hardware setup!
|
|
// Note that some sketches are designed for a particular TFT pixel width/height
|
|
|
|
// User defined information reported by "Read_User_Setup" test & diagnostics example
|
|
#define USER_SETUP_INFO "User_Setup"
|
|
|
|
// Define to disable all #warnings in library (can be put in User_Setup_Select.h)
|
|
//#define DISABLE_ALL_LIBRARY_WARNINGS
|
|
|
|
// ##################################################################################
|
|
//
|
|
// Section 1. Call up the right driver file and any options for it
|
|
//
|
|
// ##################################################################################
|
|
|
|
// Only define one driver, the other ones must be commented out
|
|
#define ILI9341_DRIVER // Generic driver for common displays
|
|
//#define ILI9341_2_DRIVER // Alternative ILI9341 driver, see https://github.com/Bodmer/TFT_eSPI/issues/1172
|
|
//#define ST7735_DRIVER // Define additional parameters below for this display
|
|
//#define ILI9163_DRIVER // Define additional parameters below for this display
|
|
//#define S6D02A1_DRIVER
|
|
//#define RPI_ILI9486_DRIVER // 20MHz maximum SPI
|
|
//#define HX8357D_DRIVER
|
|
//#define ILI9481_DRIVER
|
|
//#define ILI9486_DRIVER
|
|
//#define ILI9488_DRIVER // WARNING: Do not connect ILI9488 display SDO to MISO if other devices share the SPI bus (TFT SDO does NOT tristate when CS is high)
|
|
//#define ST7789_DRIVER // Full configuration option, define additional parameters below for this display
|
|
//#define ST7789_2_DRIVER // Minimal configuration option, define additional parameters below for this display
|
|
//#define R61581_DRIVER
|
|
//#define RM68140_DRIVER
|
|
//#define ST7796_DRIVER
|
|
//#define SSD1351_DRIVER
|
|
//#define SSD1963_480_DRIVER
|
|
//#define SSD1963_800_DRIVER
|
|
//#define SSD1963_800ALT_DRIVER
|
|
//#define ILI9225_DRIVER
|
|
//#define GC9A01_DRIVER
|
|
|
|
// For ST7789, ST7735, ILI9163 and GC9A01 ONLY, define the pixel width and height in portrait orientation
|
|
// #define TFT_WIDTH 80
|
|
// #define TFT_WIDTH 128
|
|
// #define TFT_WIDTH 172 // ST7789 172 x 320
|
|
// #define TFT_WIDTH 170 // ST7789 170 x 320
|
|
#define TFT_WIDTH 320 // ST7789 240 x 240 and 240 x 320
|
|
// #define TFT_HEIGHT 160
|
|
// #define TFT_HEIGHT 128
|
|
// #define TFT_HEIGHT 240 // ST7789 240 x 240
|
|
#define TFT_HEIGHT 240 // ST7789 240 x 320
|
|
// #define TFT_HEIGHT 240 // GC9A01 240 x 240
|
|
|
|
// If colours are inverted (white shows as black) then uncomment one of the next
|
|
// 2 lines try both options, one of the options should correct the inversion.
|
|
|
|
// #define TFT_INVERSION_ON
|
|
// #define TFT_INVERSION_OFF
|
|
|
|
|
|
// ##################################################################################
|
|
//
|
|
// Section 2. Define the pins that are used to interface with the display here
|
|
//
|
|
// ##################################################################################
|
|
|
|
// If a backlight control signal is available then define the TFT_BL pin in Section 2
|
|
// below. The backlight will be turned ON when tft.begin() is called, but the library
|
|
// needs to know if the LEDs are ON with the pin HIGH or LOW. If the LEDs are to be
|
|
// driven with a PWM signal or turned OFF/ON then this must be handled by the user
|
|
// sketch. e.g. with digitalWrite(TFT_BL, LOW);
|
|
|
|
// #define TFT_BL 32 // LED back-light control pin
|
|
#define TFT_BACKLIGHT_ON HIGH // Level to turn ON back-light (HIGH or LOW)
|
|
|
|
// ###### EDIT THE PIN NUMBERS IN THE LINES FOLLOWING TO SUIT YOUR ESP32 SETUP ######
|
|
|
|
// For ESP32 Dev board (only tested with ILI9341 display)
|
|
// The hardware SPI can be mapped to any pins
|
|
|
|
#define TFT_MISO 19
|
|
#define TFT_MOSI 23
|
|
#define TFT_SCLK 18
|
|
#define TFT_CS 5 // Chip select control pin
|
|
#define TFT_DC 16 // Data Command control pin
|
|
#define TFT_RST 22 // Reset pin (could connect to RST pin)
|
|
//#define TFT_RST -1 // Set TFT_RST to -1 if display RESET is connected to ESP32 board RST
|
|
#define TFT_BL 4 // LED back-light
|
|
|
|
// ##################################################################################
|
|
//
|
|
// Section 3. Define the fonts that are to be used here
|
|
//
|
|
// ##################################################################################
|
|
|
|
// Comment out the #defines below with // to stop that font being loaded
|
|
// The ESP8366 and ESP32 have plenty of memory so commenting out fonts is not
|
|
// normally necessary. If all fonts are loaded the extra FLASH space required is
|
|
// about 17Kbytes. To save FLASH space only enable the fonts you need!
|
|
|
|
#define LOAD_GLCD // Font 1. Original Adafruit 8 pixel font needs ~1820 bytes in FLASH
|
|
#define LOAD_FONT2 // Font 2. Small 16 pixel high font, needs ~3534 bytes in FLASH, 96 characters
|
|
#define LOAD_FONT4 // Font 4. Medium 26 pixel high font, needs ~5848 bytes in FLASH, 96 characters
|
|
#define LOAD_FONT6 // Font 6. Large 48 pixel font, needs ~2666 bytes in FLASH, only characters 1234567890:-.apm
|
|
#define LOAD_FONT7 // Font 7. 7 segment 48 pixel font, needs ~2438 bytes in FLASH, only characters 1234567890:-.
|
|
#define LOAD_FONT8 // Font 8. Large 75 pixel font needs ~3256 bytes in FLASH, only characters 1234567890:-.
|
|
//#define LOAD_FONT8N // Font 8. Alternative to Font 8 above, slightly narrower, so 3 digits fit a 160 pixel TFT
|
|
#define LOAD_GFXFF // FreeFonts. Include access to the 48 Adafruit_GFX free fonts FF1 to FF48 and custom fonts
|
|
|
|
// Comment out the #define below to stop the SPIFFS filing system and smooth font code being loaded
|
|
// this will save ~20kbytes of FLASH
|
|
#define SMOOTH_FONT
|
|
|
|
|
|
// ##################################################################################
|
|
//
|
|
// Section 4. Other options
|
|
//
|
|
// ##################################################################################
|
|
|
|
// For RP2040 processor and SPI displays, uncomment the following line to use the PIO interface.
|
|
//#define RP2040_PIO_SPI // Leave commented out to use standard RP2040 SPI port interface
|
|
|
|
// For RP2040 processor and 8 or 16 bit parallel displays:
|
|
// The parallel interface write cycle period is derived from a division of the CPU clock
|
|
// speed so scales with the processor clock. This means that the divider ratio may need
|
|
// to be increased when overclocking. It may also need to be adjusted dependant on the
|
|
// display controller type (ILI94341, HX8357C etc). If RP2040_PIO_CLK_DIV is not defined
|
|
// the library will set default values which may not suit your display.
|
|
// The display controller data sheet will specify the minimum write cycle period. The
|
|
// controllers often work reliably for shorter periods, however if the period is too short
|
|
// the display may not initialise or graphics will become corrupted.
|
|
// PIO write cycle frequency = (CPU clock/(4 * RP2040_PIO_CLK_DIV))
|
|
//#define RP2040_PIO_CLK_DIV 1 // 32ns write cycle at 125MHz CPU clock
|
|
//#define RP2040_PIO_CLK_DIV 2 // 64ns write cycle at 125MHz CPU clock
|
|
//#define RP2040_PIO_CLK_DIV 3 // 96ns write cycle at 125MHz CPU clock
|
|
|
|
// For the RP2040 processor define the SPI port channel used (default 0 if undefined)
|
|
//#define TFT_SPI_PORT 1 // Set to 0 if SPI0 pins are used, or 1 if spi1 pins used
|
|
|
|
// For the STM32 processor define the SPI port channel used (default 1 if undefined)
|
|
//#define TFT_SPI_PORT 2 // Set to 1 for SPI port 1, or 2 for SPI port 2
|
|
|
|
// Define the SPI clock frequency, this affects the graphics rendering speed. Too
|
|
// fast and the TFT driver will not keep up and display corruption appears.
|
|
// With an ILI9341 display 40MHz works OK, 80MHz sometimes fails
|
|
// With a ST7735 display more than 27MHz may not work (spurious pixels and lines)
|
|
// With an ILI9163 display 27 MHz works OK.
|
|
|
|
// #define SPI_FREQUENCY 1000000
|
|
// #define SPI_FREQUENCY 5000000
|
|
// #define SPI_FREQUENCY 10000000
|
|
// #define SPI_FREQUENCY 20000000
|
|
#define SPI_FREQUENCY 27000000
|
|
// #define SPI_FREQUENCY 40000000
|
|
// #define SPI_FREQUENCY 55000000 // STM32 SPI1 only (SPI2 maximum is 27MHz)
|
|
// #define SPI_FREQUENCY 80000000
|
|
|
|
// Optional reduced SPI frequency for reading TFT
|
|
#define SPI_READ_FREQUENCY 20000000
|
|
|
|
// The XPT2046 requires a lower SPI clock rate of 2.5MHz so we define that here:
|
|
#define SPI_TOUCH_FREQUENCY 2500000
|
|
|
|
// The ESP32 has 2 free SPI ports i.e. VSPI and HSPI, the VSPI is the default.
|
|
// If the VSPI port is in use and pins are not accessible (e.g. TTGO T-Beam)
|
|
// then uncomment the following line:
|
|
//#define USE_HSPI_PORT
|
|
|
|
// Comment out the following #define if "SPI Transactions" do not need to be
|
|
// supported. When commented out the code size will be smaller and sketches will
|
|
// run slightly faster, so leave it commented out unless you need it!
|
|
|
|
// Transaction support is needed to work with SD library but not needed with TFT_SdFat
|
|
// Transaction support is required if other SPI devices are connected.
|
|
|
|
// Transactions are automatically enabled by the library for an ESP32 (to use HAL mutex)
|
|
// so changing it here has no effect
|
|
|
|
// #define SUPPORT_TRANSACTIONS
|