BIGTREETECH-TouchScreenFirmware

BigTreeTech TFT Touchscreen

Important information related to BigTreeTech's TFT touchscreen 3D printer controllers

Table of Contents

• Supported Screens
• Software Repository
• Marlin Dependencies
• Connecting the TFT to the Mainboard
  • Touch Mode Setup
    • Setting the Baudrate on the TFT Firmware
  • Marlin Mode Setup
• Menus and Themes
• Firmware Update
  • Deployment Files
    • Firmware Binary
    • Fonts and Icons
    • Configuration File
    • Optional - Language Files
  • Configuration
    • Editing the Configuration File
  • Installation
  • Post Installation
• Configuration Update
• Touch Screen Calibration
  • Forcing the Touch Screen Calibration
• Hard Reset
  • Resetting to Default Settings
• Customization
  • Bootscreen and Icons
  • Firmware
  • Vertical Screen Orientation - Portrait Mode
• Troubleshooting
  • Firmware Update Failed
  • Worst Case Scenario
• Version History
• Appendix
  • Printing from Host
  • Printing from Remote Host
  • Adding Gcode Thumbnails
  • TFT Screen Configuration and Support for RRF
    • Overview
    • Loading the Firmware
    • Configuration Changes
    • Implemented Features
    • Menu System for Macros
  • Setup of BTT TFT35 E3 V3 with MKS SGEN L Mainboards
    • Connections
    • Firmware
  • Show more statistics at the end of the print

Supported Screens

Only the TFTs listed below are currently supported. Trying to install the firmware on a TFT which is not supported can harm the hardware.

BTT TFT

BTT_TFT24_V1.1
BTT_TFT28_V1.0 and V3.0
BTT_TFT35_V1.0, V1.1, V1.2, V2.0, V3.0, E3_V3.0 and B1_V3.0
BTT_TFT43_V3.0
BTT_TFT50_V3.0
BTT_TFT70_V3.0

BTT GD TFT

BTT_GD_TFT24_V1.1
BTT_GD_TFT35_V2.0, V3.0, E3_V3.0 and B1_V3.0
BTT_GD_TFT43_V3.0
BTT_GD_TFT50_V3.0
BTT_GD_TFT70_V3.0

MKS TFT

MKS_TFT28_V3.0 and V4.0
MKS_TFT28_NEW_GENIUS
MKS_TFT32_V1.3 and V1.4
MKS_TFT32L_V3.0
MKS_TFT35_V1.0

MKS GD TFT

MKS_GD_TFT28_V1.2-4 (V1.2 and V1.4)

WARNING: BTT does not officially provide MKS TFT hardware support. MKS TFT is maintained by open source contributors and BTT does not bear any risk of MKS TFT hardware using this firmware.

Software Repository

Firmware source: https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware

Main branch: Master

In the Master branch you will find:

• The most recent source code updates
• The most recent resources such as precompiled firmwares, themes, configuration and language files

IMPORTANT NOTE: The Master branch is currently the ONLY branch in the project to be used. The other currently existing branches develop and release-xx.27 are outdated and MUST NOT be used.

Marlin Dependencies

Minimum Marlin firmware version: 2.1.1
Distribution date: 2022-09-22
Firmware source: https://github.com/MarlinFirmware/Marlin/releases

To use all the features and functionalities supported by the TFT, the following options must be enabled in Marlin firmware.

General options which MUST be always activated:

EEPROM_SETTINGS (in Configuration.h)
BABYSTEPPING (in Configuration_adv.h)
AUTO_REPORT_TEMPERATURES (in Configuration_adv.h)
AUTO_REPORT_POSITION (in Configuration_adv.h)
EXTENDED_CAPABILITIES_REPORT (in Configuration_adv.h)
M115_GEOMETRY_REPORT (in Configuration_adv.h)
M114_DETAIL (in Configuration_adv.h)
REPORT_FAN_CHANGE (in Configuration_adv.h)

Options to support printing from onboard media:

SDSUPPORT (in Configuration.h)
LONG_FILENAME_HOST_SUPPORT (in Configuration_adv.h)
AUTO_REPORT_SD_STATUS (in Configuration_adv.h)
SDCARD_CONNECTION ONBOARD (in Configuration_adv.h)

Options to support dialog with host:

EMERGENCY_PARSER (in Configuration_adv.h)
SERIAL_FLOAT_PRECISION 4 (in Configuration_adv.h)
HOST_ACTION_COMMANDS (in Configuration_adv.h)
HOST_PROMPT_SUPPORT (in Configuration_adv.h)
HOST_STATUS_NOTIFICATIONS (in Configuration_adv.h)

Options to support M73 with host:

Options to support dialog with host (as pre requisite)
SET_PROGRESS_MANUALLY (in Configuration_adv.h)
M73_REPORT (in Configuration_adv.h)

Options to support ADVANCED_OK with host:

ADVANCED_OK (in Configuration_adv.h)

Options to support M600 with host & (Un)Load menu:

Options to support dialog with host (as pre requisite)
NOZZLE_PARK_FEATURE (in Configuration.h)
ADVANCED_PAUSE_FEATURE (in Configuration_adv.h)
PARK_HEAD_ON_PAUSE (in Configuration_adv.h)
FILAMENT_LOAD_UNLOAD_GCODES (in Configuration_adv.h)

Options to fully support Bed Leveling menu:

Z_MIN_PROBE_REPEATABILITY_TEST (in Configuration.h)
G26_MESH_VALIDATION (in Configuration.h)
Z_STEPPER_AUTO_ALIGN (in Configuration_adv.h)

Connecting the TFT to the Mainboard

Touch Mode Setup

In order to use the Touch Mode on your screen:

1. Connect the 5pin serial cable according to the manual of your mainboard
2. Define a serial port in Marlin, to activate the port used by the TFT
3. Make sure the same BAUDRATE is defined on both the Marlin and TFT firmwares

In case one of the three points above is not properly done, the message:

No printer attached!

will be shown at the top of the screen. This is because the TFT can not "see" the mainboard through the serial cable.

Setting the Baudrate on the TFT Firmware

On TFT firmware, the baudrate can be changed in two ways:

• by menu: After the firmware is installed, the baudrate can be changed from Menu->Settings->Connection->S. Ports menu
• by configuration file: Set the parameter serial_port in config.ini file with the proper baudrate (e.g. serial_port:P1:6 for baudrate 115200). Please, see Configuration section for configuring config.ini file

Marlin Mode Setup

In order to use the Marlin Mode (emulation mode) on your screen:

1. In case your TFT does not have an EXP connector at all (TFT28 v1 for example), you can not use the Marlin emulator mode.
2. In case your mainboard provides EXP1 and EXP2, you have to connect 2 ribbon cables connecting EXP1 and EXP2 of the mainboard to EXP1 and EXP2 of the TFT. In the Marlin firmware of your mainboard, make sure that ONLY REPRAP_DISCOUNT_FULL_GRAPHIC_SMART_CONTROLLER is activated in Configuration.h and that all other controllers are Deactivated (especially CR10_STOCKDISPLAY).
3. In case you have an "E3" mainboard which provides a single EXP connector, you have to connect 1 ribbon cable connecting EXP of the mainboard to EXP3 of the TFT. In case your TFT does not provide an EXP3 connector but only two 10pin connectors (TFT24 v1.1 for example) you will need a "Y-split" cable with one 10pin connector on one side (for the mainboard) and two 10pin connectors on the other side (for the TFT). In the Marlin firmware of your mainboard, make sure that ONLY CR10_STOCKDISPLAY is activated in Configuration.h and that all other controllers are Deactivated (especially REPRAP_DISCOUNT_FULL_GRAPHIC_SMART_CONTROLLER).

Menus

Status Screen DISABLED	Status Screen ENABLED
If status_screen:0 is not defined in config.ini, define: # UI Settings # Status Screen # Select the Main Screen flavour # Options: [disable: 0, enable: 1] status_screen:0	If status_screen:1 is not defined in config.ini, define: # UI Settings # Status Screen # Select the Main Screen flavour # Options: [disable: 0, enable: 1] status_screen:1

Themes

Unified Menu Theme	The Round Miracle Theme by Acenotass
Use firmware, icons, and fonts from the Copy to SD Card root directory to update - Unified Menu Material theme folder	Use firmware, icons, and fonts from the Copy to SD Card root directory to update - The Round Miracle theme folder

Hybrid Red Material Theme by AntoszHUN	Hybrid Mono Material Theme by bepstein111
Use firmware, icons, and fonts from the Copy to SD Card root directory to update - Hybrid Red Menu Material theme folder	Use firmware, icons, and fonts from the Copy to SD Card root directory to update - Hybrid Mono Menu Material theme folder

Rep Rap Firmware Dark Theme by xPew
Use firmware, icons, and fonts from the Copy to SD Card root directory to update - Rep Rap Firmware Dark theme folder

Firmware Update

The TFT firmware update process is based on the following stages:

1. Deployment Files: All the resources needed for the firmware update (up to four kinds of resources)
2. Configuration: All the changes needed on configuration file before the firmware installation
3. [Installation](