1. //                            USER DEFINED SETTINGS
2. //   Set driver type, fonts to be loaded, pins used and SPI control method etc
3. //
4. //   See the User_Setup_Select.h file if you wish to be able to define multiple
5. //   setups and then easily select which setup file is used by the compiler.
6. //
7. //   If this file is edited correctly then all the library example sketches should
8. //   run without the need to make any more changes for a particular hardware setup!
9. //   Note that some sketches are designed for a particular TFT pixel width/height
10.  
11.  
12. // ##################################################################################
13. //
14. // Section 1. Call up the right driver file and any options for it
15. //
16. // ##################################################################################
17.  
18. // Define STM32 to invoke optimised processor support (only for STM32)
19. //#define STM32
20.  
21. // Defining the STM32 board allows the library to optimise the performance
22. // for UNO compatible "MCUfriend" style shields
23. //#define NUCLEO_64_TFT
24. //#define NUCLEO_144_TFT
25.  
26. // STM32 8 bit parallel only:
27. // If STN32 Port A or B pins 0-7 are used for 8 bit parallel data bus bits 0-7
28. // then this will improve rendering performance by a factor of ~8x
29. //#define STM_PORTA_DATA_BUS
30. //#define STM_PORTA_DATA_BUS
31.  
32. // Tell the library to use 8 bit parallel mode (otherwise SPI is assumed)
33. //#define TFT_PARALLEL_8_BIT
34.  
35. // Display type -  only define if RPi display
36. //#define RPI_DISPLAY_TYPE // 20MHz maximum SPI
37.  
38. // Only define one driver, the other ones must be commented out
39. #define ILI9341_DRIVER
40. //#define ST7735_DRIVER      // Define additional parameters below for this display
41. //#define ILI9163_DRIVER     // Define additional parameters below for this display
42. //#define S6D02A1_DRIVER
43. //#define RPI_ILI9486_DRIVER // 20MHz maximum SPI
44. //#define HX8357D_DRIVER
45. //#define ILI9481_DRIVER
46. //#define ILI9486_DRIVER
47. //#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)
48. //#define ST7789_DRIVER      // Full configuration option, define additional parameters below for this display
49. //#define ST7789_2_DRIVER    // Minimal configuration option, define additional parameters below for this display
50. //#define R61581_DRIVER
51. //#define RM68140_DRIVER
52. //#define ST7796_DRIVER
53. //#define SSD1963_480_DRIVER    // Untested
54. //#define SSD1963_800_DRIVER    // Untested
55. //#define SSD1963_800ALT_DRIVER // Untested
56.  
57. // Some displays support SPI reads via the MISO pin, other displays have a single
58. // bi-directional SDA pin and the library will try to read this via the MOSI line.
59. // To use the SDA line for reading data from the TFT uncomment the following line:
60.  
61. // #define TFT_SDA_READ      // This option is for ESP32 ONLY, tested with ST7789 display only
62.  
63. // For ST7735, ST7789 and ILI9341 ONLY, define the colour order IF the blue and red are swapped on your display
64. // Try ONE option at a time to find the correct colour order for your display
65.  
66. //  #define TFT_RGB_ORDER TFT_RGB  // Colour order Red-Green-Blue
67. //  #define TFT_RGB_ORDER TFT_BGR  // Colour order Blue-Green-Red
68.  
69. // For M5Stack ESP32 module with integrated ILI9341 display ONLY, remove // in line below
70.  
71. // #define M5STACK
72.  
73. // For ST7789, ST7735 and ILI9163 ONLY, define the pixel width and height in portrait orientation
74. // #define TFT_WIDTH  80
75. // #define TFT_WIDTH  128
76. // #define TFT_WIDTH  240 // ST7789 240 x 240 and 240 x 320
77. // #define TFT_HEIGHT 160
78. // #define TFT_HEIGHT 128
79. // #define TFT_HEIGHT 240 // ST7789 240 x 240
80. // #define TFT_HEIGHT 320 // ST7789 240 x 320
81.  
82. // For ST7735 ONLY, define the type of display, originally this was based on the
83. // colour of the tab on the screen protector film but this is not always true, so try
84. // out the different options below if the screen does not display graphics correctly,
85. // e.g. colours wrong, mirror images, or tray pixels at the edges.
86. // Comment out ALL BUT ONE of these options for a ST7735 display driver, save this
87. // this User_Setup file, then rebuild and upload the sketch to the board again:
88.  
89. // #define ST7735_INITB
90. // #define ST7735_GREENTAB
91. // #define ST7735_GREENTAB2
92. // #define ST7735_GREENTAB3
93. // #define ST7735_GREENTAB128    // For 128 x 128 display
94. // #define ST7735_GREENTAB160x80 // For 160 x 80 display (BGR, inverted, 26 offset)
95. // #define ST7735_REDTAB
96. // #define ST7735_BLACKTAB
97. // #define ST7735_REDTAB160x80   // For 160 x 80 display with 24 pixel offset
98.  
99. // If colours are inverted (white shows as black) then uncomment one of the next
100. // 2 lines try both options, one of the options should correct the inversion.
101.  
102. // #define TFT_INVERSION_ON
103. // #define TFT_INVERSION_OFF
104.  
105.  
106. // ##################################################################################
107. //
108. // Section 2. Define the pins that are used to interface with the display here
109. //
110. // ##################################################################################
111.  
112. // If a backlight control signal is available then define the TFT_BL pin in Section 2
113. // below. The backlight will be turned ON when tft.begin() is called, but the library
114. // needs to know if the LEDs are ON with the pin HIGH or LOW. If the LEDs are to be
115. // driven with a PWM signal or turned OFF/ON then this must be handled by the user
116. // sketch. e.g. with digitalWrite(TFT_BL, LOW);
117.  
118. // #define TFT_BL   32            // LED back-light control pin
119. // #define TFT_BACKLIGHT_ON HIGH  // Level to turn ON back-light (HIGH or LOW)
120.  
121.  
122.  
123. // We must use hardware SPI, a minimum of 3 GPIO pins is needed.
124. // Typical setup for ESP8266 NodeMCU ESP-12 is :
125. //
126. // Display SDO/MISO  to NodeMCU pin D6 (or leave disconnected if not reading TFT)
127. // Display LED       to NodeMCU pin VIN (or 5V, see below)
128. // Display SCK       to NodeMCU pin D5
129. // Display SDI/MOSI  to NodeMCU pin D7
130. // Display DC (RS/AO)to NodeMCU pin D3
131. // Display RESET     to NodeMCU pin D4 (or RST, see below)
132. // Display CS        to NodeMCU pin D8 (or GND, see below)
133. // Display GND       to NodeMCU pin GND (0V)
134. // Display VCC       to NodeMCU 5V or 3.3V
135. //
136. // The TFT RESET pin can be connected to the NodeMCU RST pin or 3.3V to free up a control pin
137. //
138. // The DC (Data Command) pin may be labeled AO or RS (Register Select)
139. //
140. // With some displays such as the ILI9341 the TFT CS pin can be connected to GND if no more
141. // SPI devices (e.g. an SD Card) are connected, in this case comment out the #define TFT_CS
142. // line below so it is NOT defined. Other displays such at the ST7735 require the TFT CS pin
143. // to be toggled during setup, so in these cases the TFT_CS line must be defined and connected.
144. //
145. // The NodeMCU D0 pin can be used for RST
146. //
147. //
148. // Note: only some versions of the NodeMCU provide the USB 5V on the VIN pin
149. // If 5V is not available at a pin you can use 3.3V but backlight brightness
150. // will be lower.
151.  
152.  
153. // ###### EDIT THE PIN NUMBERS IN THE LINES FOLLOWING TO SUIT YOUR ESP8266 SETUP ######
154.  
155. // For NodeMCU - use pin numbers in the form PIN_Dx where Dx is the NodeMCU pin designation
156. //#define TFT_CS   PIN_D8  // Chip select control pin D8
157. //#define TFT_DC   PIN_D3  // Data Command control pin
158. //#define TFT_RST  PIN_D4  // Reset pin (could connect to NodeMCU RST, see next line)
159. //#define TFT_RST  -1    // Set TFT_RST to -1 if the display RESET is connected to NodeMCU RST or 3.3V
160.  
161. //#define TFT_BL PIN_D1  // LED back-light (only for ST7789 with backlight control pin)
162.  
163. //#define TOUCH_CS PIN_D2     // Chip select pin (T_CS) of touch screen
164.  
165. //#define TFT_WR PIN_D2       // Write strobe for modified Raspberry Pi TFT only
166.  
167.  
168. // ######  FOR ESP8266 OVERLAP MODE EDIT THE PIN NUMBERS IN THE FOLLOWING LINES  ######
169.  
170. // Overlap mode shares the ESP8266 FLASH SPI bus with the TFT so has a performance impact
171. // but saves pins for other functions. It is best not to connect MISO as some displays
172. // do not tristate that line wjen chip select is high!
173. // On NodeMCU 1.0 SD0=MISO, SD1=MOSI, CLK=SCLK to connect to TFT in overlap mode
174. // On NodeMCU V3  S0 =MISO, S1 =MOSI, S2 =SCLK
175. // In ESP8266 overlap mode the following must be defined
176.  
177. //#define TFT_SPI_OVERLAP
178.  
179. // In ESP8266 overlap mode the TFT chip select MUST connect to pin D3
180. //#define TFT_CS   PIN_D3
181. //#define TFT_DC   PIN_D5  // Data Command control pin
182. //#define TFT_RST  PIN_D4  // Reset pin (could connect to NodeMCU RST, see next line)
183. //#define TFT_RST  -1  // Set TFT_RST to -1 if the display RESET is connected to NodeMCU RST or 3.3V
184.  
185.  
186. // ###### EDIT THE PIN NUMBERS IN THE LINES FOLLOWING TO SUIT YOUR ESP32 SETUP   ######
187.  
188. // For ESP32 Dev board (only tested with ILI9341 display)
189. // The hardware SPI can be mapped to any pins
190.  
191. //#define TFT_MISO 19
192. #define TFT_MOSI 23
193. #define TFT_SCLK 18
194. #define TFT_CS   15  // Chip select control pin
195. #define TFT_DC   2  // Data Command control pin
196. #define TFT_RST  4  // Reset pin (could connect to RST pin)
197. //#define TFT_RST  -1  // Set TFT_RST to -1 if display RESET is connected to ESP32 board RST
198.  
199. #define TOUCH_CS 21     // Chip select pin (T_CS) of touch screen
200.  
201. //#define TFT_WR 22    // Write strobe for modified Raspberry Pi TFT only
202.  
203. // For the M5Stack module use these #define lines
204. //#define TFT_MISO 19
205. //#define TFT_MOSI 23
206. //#define TFT_SCLK 18
207. //#define TFT_CS   14  // Chip select control pin
208. //#define TFT_DC   27  // Data Command control pin
209. //#define TFT_RST  33  // Reset pin (could connect to Arduino RESET pin)
210. //#define TFT_BL   32  // LED back-light (required for M5Stack)
211.  
212. // ######       EDIT THE PINs BELOW TO SUIT YOUR ESP32 PARALLEL TFT SETUP        ######
213.  
214. // The library supports 8 bit parallel TFTs with the ESP32, the pin
215. // selection below is compatible with ESP32 boards in UNO format.
216. // Wemos D32 boards need to be modified, see diagram in Tools folder.
217. // Only ILI9481 and ILI9341 based displays have been tested!
218.  
219. // Parallel bus is only supported for the STM32 and ESP32
220. // Example below is for ESP32 Parallel interface with UNO displays
221.  
222. // Tell the library to use 8 bit parallel mode (otherwise SPI is assumed)
223. //#define TFT_PARALLEL_8_BIT
224.  
225. // The ESP32 and TFT the pins used for testing are:
226. //#define TFT_CS   33  // Chip select control pin (library pulls permanently low
227. //#define TFT_DC   15  // Data Command control pin - must use a pin in the range 0-31
228. //#define TFT_RST  32  // Reset pin, toggles on startup
229.  
230. //#define TFT_WR    4  // Write strobe control pin - must use a pin in the range 0-31
231. //#define TFT_RD    2  // Read strobe control pin
232.  
233. //#define TFT_D0   12  // Must use pins in the range 0-31 for the data bus
234. //#define TFT_D1   13  // so a single register write sets/clears all bits.
235. //#define TFT_D2   26  // Pins can be randomly assigned, this does not affect
236. //#define TFT_D3   25  // TFT screen update performance.
237. //#define TFT_D4   17
238. //#define TFT_D5   16
239. //#define TFT_D6   27
240. //#define TFT_D7   14
241.  
242. // ######       EDIT THE PINs BELOW TO SUIT YOUR STM32 SPI TFT SETUP        ######
243.  
244. // The TFT can be connected to SPI port 1 or 2
245. //#define TFT_SPI_PORT 1 // SPI port 1 maximum clock rate is 55MHz
246. //#define TFT_MOSI PA7
247. //#define TFT_MISO PA6
248. //#define TFT_SCLK PA5
249.  
250. //#define TFT_SPI_PORT 2 // SPI port 2 maximum clock rate is 27MHz
251. //#define TFT_MOSI PB15
252. //#define TFT_MISO PB14
253. //#define TFT_SCLK PB13
254.  
255. // Can use Ardiuno pin references, arbitrary allocation, TFT_eSPI controls chip select
256. //#define TFT_CS   D5 // Chip select control pin to TFT CS
257. //#define TFT_DC   D6 // Data Command control pin to TFT DC (may be labelled RS = Register Select)
258. //#define TFT_RST  D7 // Reset pin to TFT RST (or RESET)
259. // OR alternatively, we can use STM32 port reference names PXnn
260. //#define TFT_CS   PE11 // Nucleo-F767ZI equivalent of D5
261. //#define TFT_DC   PE9  // Nucleo-F767ZI equivalent of D6
262. //#define TFT_RST  PF13 // Nucleo-F767ZI equivalent of D7
263.  
264. //#define TFT_RST  -1   // Set TFT_RST to -1 if the display RESET is connected to processor reset
265.                         // Use an Arduino pin for initial testing as connecting to processor reset
266.                         // may not work (pulse too short at power up?)
267.  
268. // ##################################################################################
269. //
270. // Section 3. Define the fonts that are to be used here
271. //
272. // ##################################################################################
273.  
274. // Comment out the #defines below with // to stop that font being loaded
275. // The ESP8366 and ESP32 have plenty of memory so commenting out fonts is not
276. // normally necessary. If all fonts are loaded the extra FLASH space required is
277. // about 17Kbytes. To save FLASH space only enable the fonts you need!
278.  
279. #define LOAD_GLCD   // Font 1. Original Adafruit 8 pixel font needs ~1820 bytes in FLASH
280. #define LOAD_FONT2  // Font 2. Small 16 pixel high font, needs ~3534 bytes in FLASH, 96 characters
281. #define LOAD_FONT4  // Font 4. Medium 26 pixel high font, needs ~5848 bytes in FLASH, 96 characters
282. #define LOAD_FONT6  // Font 6. Large 48 pixel font, needs ~2666 bytes in FLASH, only characters 1234567890:-.apm
283. #define LOAD_FONT7  // Font 7. 7 segment 48 pixel font, needs ~2438 bytes in FLASH, only characters 1234567890:-.
284. #define LOAD_FONT8  // Font 8. Large 75 pixel font needs ~3256 bytes in FLASH, only characters 1234567890:-.
285. //#define LOAD_FONT8N // Font 8. Alternative to Font 8 above, slightly narrower, so 3 digits fit a 160 pixel TFT
286. #define LOAD_GFXFF  // FreeFonts. Include access to the 48 Adafruit_GFX free fonts FF1 to FF48 and custom fonts
287.  
288. // Comment out the #define below to stop the SPIFFS filing system and smooth font code being loaded
289. // this will save ~20kbytes of FLASH
290. #define SMOOTH_FONT
291.  
292.  
293. // ##################################################################################
294. //
295. // Section 4. Other options
296. //
297. // ##################################################################################
298.  
299. // Define the SPI clock frequency, this affects the graphics rendering speed. Too
300. // fast and the TFT driver will not keep up and display corruption appears.
301. // With an ILI9341 display 40MHz works OK, 80MHz sometimes fails
302. // With a ST7735 display more than 27MHz may not work (spurious pixels and lines)
303. // With an ILI9163 display 27 MHz works OK.
304.  
305. // #define SPI_FREQUENCY   1000000
306. // #define SPI_FREQUENCY   5000000
307. // #define SPI_FREQUENCY  10000000
308. // #define SPI_FREQUENCY  20000000
309. #define SPI_FREQUENCY  27000000
310. // #define SPI_FREQUENCY  40000000
311. // #define SPI_FREQUENCY  55000000 // STM32 SPI1 only (SPI2 maximum is 27MHz)
312. // #define SPI_FREQUENCY  80000000
313.  
314. // Optional reduced SPI frequency for reading TFT
315. #define SPI_READ_FREQUENCY  20000000
316.  
317. // The XPT2046 requires a lower SPI clock rate of 2.5MHz so we define that here:
318. #define SPI_TOUCH_FREQUENCY  2500000
319.  
320. // The ESP32 has 2 free SPI ports i.e. VSPI and HSPI, the VSPI is the default.
321. // If the VSPI port is in use and pins are not accessible (e.g. TTGO T-Beam)
322. // then uncomment the following line:
323. //#define USE_HSPI_PORT
324.  
325. // Comment out the following #define if "SPI Transactions" do not need to be
326. // supported. When commented out the code size will be smaller and sketches will
327. // run slightly faster, so leave it commented out unless you need it!
328.  
329. // Transaction support is needed to work with SD library but not needed with TFT_SdFat
330. // Transaction support is required if other SPI devices are connected.
331.  
332. // Transactions are automatically enabled by the library for an ESP32 (to use HAL mutex)
333. // so changing it here has no effect
334.  
335. // #define SUPPORT_TRANSACTIONS
336.