TFT_Graphic_Lib.exe

TFT Graphic Library Set-up Tool

(Current version 1.03)

TFT_Graphic_Lib.exe is the main tool used to properly configure TFT Graphic Library 2. It automatically generates all the necessary include files required by your program. Due to the increasing complexity of the library, this tool is now mandatory, as it ensures that only the required optimized files are included and always in the correct order, based on your selected settings.

In addition, the tool provides new features such as saving and loading configuration profiles, and previewing fonts (BDF or Standard) before they are included.

Important: For the tool to function correctly, TFT_Graphic_Lib.exe must be located in the main library directory TftLib, together with the file TFT_Graphic_Lib.inc

PROFILE MANAGEMENT

OPEN PROFILE - Load a previously saved configuration file, so you do not need to re-enter settings.
SAVE PROFILE - Save the current configuration to a profile file that can be recalled later.

MCU TYPE - Select the MCU type being used:

8-bit
16-bit

Sprites - Defines the use of the graphic RAM buffer.

Buffer Size - Total number of pixels (2 bytes per pixel) allocated for the graphic buffer. Used RAM = 2 × Pixels.
Buffers # - Maximum number of virtual buffers to use. The Buffer Size can be dynamically partitioned among these buffers with arbitrary dimensions. They can also be resized later, up to the total Buffer Size. Fewer buffers require fewer auxiliary RAM variables.

TFT IC - Select the display driver IC from the drop-down menu.

TFT Width - The display’s width (the larger of the two dimensions).
TFT Height - The display’s height (the smaller of the two dimensions).
W-Offset - Horizontal offset. Some modules have an internal RAM offset that must be added to pixel coordinates.
H-Offset - Vertical offset. Same as above, but for height.
Pixel Check - If enabled, drawing operations that fall outside the display area are automatically clipped or skipped.

Yes - Safer, prevents random pixels or corrupted graphics but increases code size and decreases speed.
No - Much faster, but the program must ensure coordinates stay within valid bounds.

TFT COM - Select the TFT communication interface type. Available options depend on the selected TFT driver IC and the physical module tested.

SPI_1 - Hardware SPI module 1
SPI_2 - Hardware SPI module 2
SPI_SW - Software (bit-banged) SPI
PAR_FSW - Fully software-driven 16-bit parallel interface
PAR_HSW - High byte is software-driven; low byte is hardware via an 8-bit or half 16b port
PAR_LSW - Low byte is software-driven; high byte is hardware via an 8-bit or half 16b port
PAR_2×8b - Two hardware 8-bit ports or two half 16b ports
PAR_16b - Full 16-bit port, hardware-mapped

SPI_1/SPI_2 Defines - Inline commands to explicitly change the SPI clock speed

$define TFT_COM_Slow - Lower SPI clock speed (used before reading from TFT)
$define TFT_COM_Fast - Restore normal SPI clock speed (used for writing to TFT)

TFT DATA LINES - Configure which ports or pins will be used for the selected communication interface.

SPI LINES:

TFT-RST - Reset chip
TFT-CS - Chip select
TFT-DC - Data/Command
TFT-MOSI - Master Out / Slave In
TFT-MISO - Master In / Slave Out (mirrors MOSI for modules with bidirectional data line)
TFT-SCLK - SPI clock

PARALLEL LINES (common):

TFT-RST - Reset chip
TFT-CS - Chip select
TFT-DC - Data/Command
TFT-WR - Write enable
TFT-RD - Read enable

PAR_FSW:

TFT-B15 … TFT-B0 - Individually mapped data bits

PAR_HSW:

TFT-LB - LowByte of the 16b parallel interface via an 8-bit or half 16b hardware port
TFT-B15 … B8 - High-byte individual pins

PAR_LSW:

TFT-HB - HighByte of the 16b parallel interface via an 8-bit or half 16b hardware port
TFT-B7 … B0 - Low-byte individual pins

PAR_2×8b:

TFT-HB - HighByte of the 16b parallel interface via an 8-bit or half 16b hardware port
TFT-LB - LowByte of the 16b parallel interface via an 8-bit or half 16b hardware port

PAR_16b:

TFT-WD - Full 16-bit port

TOUCH IC - Select the touch controller driver.

Touch Com:

SPI_SW - Modified software SPI for resistive touch controllers

Touch SPI lines:

T-CS - Touch driver chip select
T-IRQ - Touch interrupt requst signaling a change in the touch screen pressure
T-MOSI - SPI master output, slave input
T-MISO - SPI master input, slave output
T-SCLK - SPI clock line

Z Thrld - Z-threshold, Minimum pressure needed to register a touch (recommended range: 500-1500).
Average - Number of samples to take and average upon a touch event. Measuring a single touch readout takes only a few microseconds, while human reaction is typically slower, allowing flexibility. Higher values increase RAM usage and reduce speed. Recommended: 2-16.
Median - Defines the maximum permitted distance, in pixels, between the median point and any individual point in the averaging array for that point to be included in the final average calculation. After gathering the number of samples specified in "Average", only those points whose X and Y distances from the median point fall within the specified Median Distance will participate in the averaging process. If this value is set too low, the filter may end up selecting only the median point itself, which may not accurately represent the center of the full sample set. For additional background information, you may look up "Average vs. Median" on the Internet.

SD CARD - Select whether an SD card is used:

FAT System:

FAT16/32 - Standard FAT16/FAT32 file system
RAW - No file system

SD COM:

SPI_1 - Hardware SPI module 1
SPI_2 - Hardware SPI module 2
SPI_SW - Software SPI

SPI LINES:

SD-CS - SD card chip select
SD-MOSI - SPI master output, slave input
SD-MISO - SPI master input, slave output
SD-SCLK - SPI clock line

MEMORY - Select external memory usage.

MEM COM - select memory interface

SPI_1 - Hardware SPI module 1
SPI_2 - Hardware SPI module 2
SPI_SW - Software SPI

Memory SPI Lines:

MEM-CS - Memory chip select
MEM-MOSI - SPI master output, slave input
MEM-MISO - SPI master input, slave output
MEM-SCLK - SPI clock line

Page - Flash memory page size in bytes (typically 128 or 256).
Sector - Flash sector size in bytes (commonly 4096).
Sector# - Total number of uniform sectors.
File# - Maximum number of stored files (minimum 256; add in steps of 128).
Delay - Minimum delay between write operations (typically ~5 ms).

*Always consult the FLASH memory datasheet.

Fonts Bar

SND Font - Select a standard-size font to include in the program.
Smooth - When enabled, resized standard fonts will have smoother, anti-aliased edges instead of blocky pixel edges. This option increases code size, uses more RAM, and is slower to render. The resulting font appears visually bolder than the original. It is generally better to use a font that already matches the required size, but this is not always feasible due to additional program-memory requirements.
H-Space - The maximum horizontal space any selected standard font may occupy, automatically calculated based on the chosen fonts. This value is important when resizing fonts, as it helps reduce RAM usage.
V-Space - The maximum vertical space any selected standard font may occupy, automatically calculated based on the chosen fonts. Like H-Space, it is essential for efficient font resizing and RAM optimization.
A/R SND - A button used to add or remove the currently selected standard font from the program’s header includes.
BDF Font - Select a BDF font to include in the program.
A/R BDF - A button to add or remove the currently selected BDF font from the program’s header includes.
Font Preview Window - This window displays the glyphs of the currently selected font. It can be resized if necessary to provide a clearer view.
Preview - When enabled, the preview window automatically adopts the pixel dimensions specified in the "TFT Width" and "TFT Height" fields. This allows you to see the actual proportional size of the font glyphs as they will appear on the TFT screen.

Header Text Box - This section displays all required includes and defines, generated in the correct order, to ensure proper operation of the TFT Graphic Library.

COPY TO CLIPBOARD - Copies all generated includes and defines from the Header Text Box directly to the clipboard.

Note: If a particular feature is not being used, you should set it to "Not Used." Doing so helps reduce both code size and RAM consumption.

Example header:

Device = 33EP128MC504

Declare Xtal = 150

Declare Auto_Heap_Arrays = On

Declare Auto_Heap_Strings = On

Declare Auto_Variable_Bank_Cross = On

Declare Stack_Expand = On

Declare Watchdog = OFF

Declare Warnings = Off

Declare Access_Upper_64K = On

'================ MCU =======================

$define McuType 1

'================ TFT SCREEN ================

$define TFT_IC ILI9341

$define TftScreenWidth 320

$define TftScreenHeight 240

$define TftWidthOffset 0

$define TftHeightOffset 0

$define TftPixelCheck 0

$define TFT_COM SPI_2

$define TFT_COM_Slow SPI2STAT = 0X0000 : SPI2CON1 = 0X0323 : SPI2BUF = 0 : SPI2STAT = 0X8000

$define TFT_COM_Fast SPI2STAT = 0X0000 : SPI2CON1 = 0X033B : SPI2BUF = 0 : SPI2STAT = 0X8000

$define TFT_RESET PORTC.2

$define TFT_CS PORTC.9

$define TFT_DC PORTC.1

$define TFT_MOSI PORTC.6

$define _TFT_MOSI _PORTC.6

$define TFT_MISO PORTC.5

$define _TFT_MISO _PORTC.5

$define TFT_SCLK PORTC.7

$define _TFT_SCLK _PORTC.7

Include "TftLib\TFT_Graphic_Lib.inc"

Include "TftLib\Colors\Colors.inc"

Include "TftLib\Drivers\Drivers.inc"

Include "TftLib\Drivers\ILI9341.inc"

Include "TftLib\System\System.inc"

Include "TftLib\System\System_SPI_V4.inc"

Include "TftLib\Shapes\Shapes.inc"

Include "TftLib\Shapes\Shapes_SPI_V1.inc"

'================ SD CARD ===================

$define SDCardUsed 1

$define SDCardFatUsed 1

$define SD_COM SPI_1

$define SD_CS PORTA.1

$define SD_SDO PORTA.4

$define _SD_SDO _PORTA.4

$define SD_SDI PORTA.9

$define _SD_SDI _PORTA.9

$define SD_CLK PORTC.3

$define _SD_CLK _PORTC.3

Include "TftLib\SdCard\SdCard.inc"

Include "TftLib\SdCard\Fat.inc"

Include "TftLib\SdCard\SdCard_SPI_V4.inc"

'================ MEMORY ====================

$define MemoryType 2

$define MEM_PAGE_SIZE 256

$define MEM_SECTOR_SIZE 4096

$define MEM_SECTOR_COUNT 2048

$define MEM_FILE_COUNT 256

$define MEM_WRITE_DELAY 5

$define MEM_COM SPI_1

$define MEM_CS PORTA.7

$define MEM_MOSI PORTA.4

$define _MEM_MOSI _PORTA.4

$define MEM_MISO PORTA.9

$define _MEM_MISO _PORTA.9

$define MEM_SCLK PORTC.3

$define _MEM_SCLK _PORTC.3

Include "TftLib\Memory\Memory.inc"

Include "TftLib\Memory\Flash.inc"

Include "TftLib\Memory\Memory_SPI_V3.inc"

Include "TftLib\Memory\Flash_SPI_V1.inc"

'================ TFT TOUCH =================

$define TOUCH_IC XPT2046

$define Z_Threshold 500

$define TouchAveragePoints 2

$define TouchMedianDistance 8

$define TOUCH_COM SPI_SW

$define T_CS PORTC.8

$define T_IRQ PORTA.8

$define T_MOSI PORTC.6

$define _T_MOSI _PORTC.6

$define T_MISO PORTC.5

$define _T_MISO _PORTC.5

$define T_SCLK PORTC.7

$define _T_SCLK _PORTC.7

Include "TftLib\Touch\Touch.inc"

Include "TftLib\Touch\XPT2046.inc"

'================ SPRITES ===================

$define SpritesUsed 1

$define SpriteBufferSize 900

$define SpriteBufferNumber 3

Include "TftLib\Sprites\Sprites.inc"

Include "TftLib\Sprites\Sprites_SPI_V2.inc"

'=============== SND FONT ===================

$define FontSNDUsed 1

Include "TftLib\Fonts\SND\F0_SND_8x8_Basic.inc"

$define FontSmooth 0

$define FontMaxSpace 8

$define FontMaxPixels 8

Include "TftLib\Fonts\SND.inc"

Include "TftLib\Fonts\SND_SPI_V1.inc"

'=============== BDF FONT ===================

$define FontBDFUsed 1

Include "TftLib\Fonts\BDF\F2_BDF_Margarine-Regular-24.inc"

Include "TftLib\Fonts\BDF.inc"

Include "TftLib\Fonts\BDF_SPI_V1.inc"

Created with the Personal Edition of HelpNDoc: Full-featured EPub generator