# BIGTREETECH-TouchScreenFirmware **Repository Path**: ccstl/BIGTREETECH-TouchScreenFirmware ## Basic Information - **Project Name**: BIGTREETECH-TouchScreenFirmware - **Description**: No description available - **Primary Language**: C - **License**: GPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 2 - **Created**: 2023-12-12 - **Last Updated**: 2023-12-12 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # BigTreeTech TFT Touchscreen license [![GitHub contributors](https://img.shields.io/github/contributors/bigtreetech/bigtreetech-TouchScreenFirmware.svg)](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/graphs/contributors) release date [![Build Binaries](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/actions/workflows/buildBinary.yml/badge.svg)](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/actions/workflows/buildBinary.yml) Important information related to BigTreeTech's TFT touchscreen 3D printer controllers ![TFT35v3 Image with cable](https://user-images.githubusercontent.com/54359396/115433717-25a5e800-a208-11eb-9bd1-8a66b4780cf7.png) ## Table of Contents - [Supported Screens](#supported-screens) - [Software Repository](#software-repository) - [Marlin Dependencies](#marlin-dependencies) - [Connecting the TFT to the Mainboard](#connecting-the-tft-to-the-mainboard) - [Touch Mode Setup](#touch-mode-setup) - [Setting the Baudrate on the TFT Firmware](#setting-the-baudrate-on-the-TFT-firmware) - [Marlin Mode Setup](#marlin-mode-setup) - [Menus and Themes](#menus) - [Firmware Update](#firmware-update) - [Deployment Files](#deployment-files) - [Firmware Binary](#firmware-binary) - [Fonts and Icons](#fonts-and-icons) - [Configuration File](#configuration-file) - [Optional - Language Files](#optional---language-files) - [Configuration](#configuration) - [Editing the Configuration File](#editing-the-configuration-file) - [Installation](#installation) - [Post Installation](#post-installation) - [Configuration Update](#configuration-update) - [Touch Screen Calibration](#touch-screen-calibration) - [Forcing the Touch Screen Calibration](#forcing-the-touch-screen-calibration) - [Hard Reset](#hard-reset) - [Resetting to Default Settings](#resetting-to-default-settings) - [Customization](#customization) - [Bootscreen and Icons](#bootscreen-and-icons) - [Firmware](#firmware) - [Vertical Screen Orientation - Portrait Mode](#vertical-screen-orientation---portrait-mode) - [Troubleshooting](#troubleshooting) - [Firmware Update Failed](#firmware-update-failed) - [Worst Case Scenario](#worst-case-scenario) - [Version History](#version-history) - [Appendix](#appendix) - [Printing from Host](#printing-from-host) - [Printing from Remote Host](#printing-from-remote-host) - [Adding Gcode Thumbnails](#adding-gcode-thumbnails) - [TFT Screen Configuration and Support for RRF](#tft-screen-configuration-and-support-for-rrf) - [Overview](#overview) - [Loading the Firmware](#loading-the-firmware) - [Configuration Changes](#configuration-changes) - [Implemented Features](#implemented-features) - [Menu System for Macros](#menu-system-for-macros) - [Setup of BTT TFT35 E3 V3 with MKS SGEN L Mainboards](#setup-of-btt-tft35-e3-v3-with-mks-sgen-l-mainboards) - [Connections](#connections) - [Firmware](#firmware) - [Show more statistics at the end of the print](#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_TFT32_V1.3 and V1.4 MKS_TFT32L_V3_0 MKS_TFT35_V1_0 **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](#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 **De**activated (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 **De**activated (especially `REPRAP_DISCOUNT_FULL_GRAPHIC_SMART_CONTROLLER`). ![Thomas White July 2021-1](https://user-images.githubusercontent.com/54359396/132397091-d596abcf-750f-422a-bb59-afafc246dc58.jpg) ![Thomas White July 2021-2](https://user-images.githubusercontent.com/54359396/132397098-136247da-c11e-4783-a163-4147a73094e1.jpg) ![Thomas White July 2021-3](https://user-images.githubusercontent.com/54359396/132397106-57d8b5c5-715a-4748-8d80-60eaac76477f.jpg) ## Menus | Status Screen DISABLED | Status Screen ENABLED | | :----------------------------------------------------------: | :----------------------------------------------------------: | | ![status screen 0](https://user-images.githubusercontent.com/54359396/103319145-09035b80-4a31-11eb-91d0-dd761a48b6f5.png) | ![Unified Material Main Screen](https://user-images.githubusercontent.com/54359396/98742038-03cd4d00-23ae-11eb-9552-36dc02fe66f4.png) | | 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](https://github.com/Acenotass)** | | :----------------------------------------------------------: | :----------------------------------------------------------: | | ![Unified Material Main Screen](https://user-images.githubusercontent.com/54359396/98742038-03cd4d00-23ae-11eb-9552-36dc02fe66f4.png) | ![Round Miracle Main Screen](https://user-images.githubusercontent.com/54359396/99251566-d77e5a00-280d-11eb-9c7a-0e7c0111eedd.png) | | Use firmware, icons, and fonts from the [`Copy to SD Card root directory to update - Unified Menu Material theme`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update/THEME_Unified%20Menu%20Material%20theme) folder | Use firmware, icons, and fonts from the [`Copy to SD Card root directory to update - The Round Miracle theme`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update/THEME_The%20Round%20Miracle%20Menu%20Material%20theme) folder | | Hybrid Red Material Theme by **[AntoszHUN](https://github.com/AntoszHUN)** | Hybrid Mono Material Theme by **[bepstein111](https://github.com/bepstein111)** | | :----------------------------------------------------------: | :----------------------------------------------------------: | | ![Hybrid Red Menu Material Mainscreen](https://user-images.githubusercontent.com/54359396/98869176-a995c000-2471-11eb-94da-a0bc41abf3e9.png) | ![Monochrome TFT35](https://user-images.githubusercontent.com/54359396/110254523-d5dccb80-7f8f-11eb-86a5-2d52ecd7ca4d.png) | | Use firmware, icons, and fonts from the [`Copy to SD Card root directory to update - Hybrid Red Menu Material theme`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update/THEME_Hybrid%20Red%20Menu%20Material%20theme) folder | Use firmware, icons, and fonts from the [`Copy to SD Card root directory to update - Hybrid Mono Menu Material theme`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update/THEME_Hybrid%20Mono%20Menu%20Material%20theme) folder | | Rep Rap Firmware Dark Theme by **[xPew](https://github.com/xPew)** | | | :----------------------------------------------------------: | ------------------------------------------------------------ | | ![Mainscreen-Rep Rap FW Dark](https://user-images.githubusercontent.com/54359396/132403911-067d5cba-942e-496a-9f24-c4b1c9be99d5.png) | ![Mainscreen](https://user-images.githubusercontent.com/54359396/132404369-948e7677-6d17-4a9a-ad7e-25ebc46b3fdb.png) | | Use firmware, icons, and fonts from the [`Copy to SD Card root directory to update - Rep Rap Firmware Dark theme`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update/THEME_Rep%20Rap%20Firmware%20Dark%20theme) folder | | ## Firmware Update The TFT firmware update process is based on the following stages: 1. [Deployment Files](#deployment-files): All the resources needed for the firmware update (up to four kinds of resources) 2. [Configuration](#configuration): All the changes needed on configuration file before the firmware installation 3. [Installation](#installation): All the steps needed in order to install the firmware 4. [Post Installation](#post-installation): Post installation process in case of major changes applied by the installed firmware ### Deployment Files The following sections provide all the resources needed for the firmware update (up to four kinds of resources). #### Firmware Binary Precompiled firmwares are available on [`Copy to SD Card root directory to update`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update) folder. For **BTT TFTs**, the firmwares use the naming convention `BIGTREE_TFT*_V*.*.*.x.bin`. For **BTT GD TFTs**, the firmwares use the naming convention `BIGTREE_GD_TFT*_V*.*.*.x.bin` ![GD Chip](https://user-images.githubusercontent.com/46979052/187049050-2bf05b07-3a1a-43c9-a375-6ef53cf48850.png) For **MKS TFTs**: 1. The firmwares use the naming convention `MKS_TFT*_V*.*.*.x.bin` 2. Any binary file for an MKS firmware (e.g. `MKS_TFT28_V4.0.27.x.bin`) **MUST** be renamed to `MKSTFT*.bin` (e.g. `MKSTFT28.bin`, `MKSTFT35.bin` etc.) in order it can be recognized and installed by the TFT For example, for BTT TFT35 V3 select: `BIGTREE_TFT35_V3.0.27.x.bin` where: - `BIGTREE_TFT35`: Model - `V3.0`: Hardware version - `27.x`: Software version **NOTE:** For BTT TFT35, there are currently three different kinds of firmware available: - V3.0 - E3_V3.0 - B1_V3.0 So, make sure to use the firmware matching your TFT screen. #### Fonts and Icons Themes are available on [`Copy to SD Card root directory to update`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update) folder. The root folder for fonts and icons is `TFT*`, where `*` is the size of the TFT (e.g. `TFT24`, `TFT35`, `TFT50` etc). Fonts and icons folder structure: - `TFT*/font`: Includes the fonts in .fon format and a readme.md - `TFT*/bmp`: Includes the icons in .bmp format and a readme.md For **MKS TFT32**, the `TFT28` folder has to be used and **MUST** be renamed to `TFT32` in order it can be recognized and installed by the TFT. #### Configuration File Templates for configuration file are available on [`Copy to SD Card root directory to update`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update) folder. The configuration file is named `config.ini`. **NOTE:** RepRap firmware users have to make their changes using the `config_rrf.ini` template file and renaming it to `config.ini`. #### Optional - Language Files Optional language files are available on [`Copy to SD Card root directory to update/Language Packs`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update/Language%20Packs) folder. Language files use the naming convention `language_*.ini` (e.g. `language_it.ini`). ### Configuration The firmware configuration can be modified by changing the `config.ini` (or the renamed `config_rrf.ini`) file using a simple text editor (make sure to use UTF encoding). A configuration can be uploaded without the need to upload the firmware or the TFT folder again, as long as the firmware and the configuration file are from the same version (see [Configuration Update](#configuration-update)). #### Editing the Configuration File **NOTE:** RepRap firmware users have to make their changes using the `config_rrf.ini` template file and renaming it to `config.ini`. To edit the `config.ini` file, follow the instructions here: [Detailed Instructions](config_instructions.md). ### Installation **NOTE:** For devices with USB flash drive support, it is possible to update the **icons**, **fonts**, **config** and the **language** files from a USB flash drive in the same way it is done through an SD card. However, the firmware can only be updated using an SD card. The following steps are needed in order to install the firmware: 1. Copy the precompiled `BIGTREE_TFT*_V*.*.*.bin` or your self compiled **firmware**, plus the `TFT*` folder of your preferred theme along with `config.ini` to the root of a blank SD card not greater than 8GB and formatted as FAT32: ![Firmware](https://user-images.githubusercontent.com/54359396/100600549-b6cffd00-3301-11eb-8b57-d56b7a4422f1.jpg) 2. Optionally, copy one or more `language_*.ini` file(s) onto the SD card. Doing so, it will allow you to switch between English and the uploaded language(s) from the **Language** menu present in the TFT firmware. We recommend to upload the minimum amount of languages to keep the memory usage low. The `language_*.ini` file can be edited to change the text shown on the TFT: ![Language Pack](https://user-images.githubusercontent.com/54359396/100600564-b9caed80-3301-11eb-8997-d376f05323f6.jpg) 3. Place the SD card with `BIGTREE_TFT*_V*.*.*.bin`, the `TFT*` folder, `config.ini` and the optional `language_*.ini` file(s) into the TFT's SD card reader and reset your TFT (or optionally - power cycle your printer) to start the update process:

⚠️ Failing to update your icons & fonts will result in missing icons and/or unreadable text ⚠️

**Update process shown on TFT screen:** A successful update looks like this on the screen: ![Screenshot 2020-09-26 at 22 10 04](https://user-images.githubusercontent.com/54359396/94349526-5abcd400-0045-11eb-993a-afc5b241f4d7.png) ... and the name of the elements on the SD card changes to this: ![After Update](https://user-images.githubusercontent.com/54359396/94349755-dc156600-0047-11eb-9b1e-a1334bc5675f.png) In case one or several parts of the update failed, an error will be shown. Follow the information on the screen to update the missing or outdated elements: ![Screenshot 2020-10-23 at 14 37 36](https://user-images.githubusercontent.com/54359396/97004894-002c7000-153e-11eb-9951-f493be46af3e.png)

⚠️ Errors during the update can not be ignored and must be solved before using the TFT ⚠️

After the update is done and the files are renamed, it is possible to reuse them again. To do so, change the name of the element(s) to the pre-update name and start the update process again. 4. After a successful update, the TFT will switch to one of the following menus: - **Main** menu: The update is completed and you can use the TFT - **Touch Screen Calibration** menu: A post installation process is needed before switching to Main menu. Please, see [Post Installation](#post-installation) section for completing the post installation process **TIP:** Format the SD card after the firmware update in case you would like to print from it. ### Post Installation In case major changes have been applied by the installed firmware, a post installation process consisting on touch screen calibration is automatically started. Please, see [Touch Screen Calibration](#touch-screen-calibration) section for completing the process. ## Configuration Update Please, see [Configuration](#configuration) section for configuring `config.ini` file. **NOTES:** - For devices with USB flash drive support, it is possible to update the **icons**, **fonts**, **config** and the **language** files from a USB flash drive in the same way it is done through an SD card. However, the firmware can only be updated using an SD card - The following procedure can be also applied to any combination of resources (e.g. only **icons**, **icons** + **fonts**, **config** + **language** files etc.) In order to update the firmware configuration: 1. Copy your edited `config.ini` file to the root of the SD card. The SD card capacity should be less than or equal to 8GB and formatted as FAT32 2. Insert the SD card into the TFT's SD card slot and press the reset button of the TFT (or power cycle your printer) 3. The TFT's configuration will update from the configuration file on reboot 4. The `config.ini` file will be renamed to `config.ini.CUR` after updating the configuration ## Touch Screen Calibration The touch screen calibration process begins showing a white screen with a red dot in the upper right corner and the following text: Touch Screen Calibration - Please click on the red dot Once the process is started, to calibrate the touch screen press (with your finger or a stylus): 1. the red dot in the upper left corner 2. then the red dot in the upper right corner 3. then the red dot in the lower right corner 4. and finally, the black dot in the middle of the screen to finish the calibration Repeat the process in case the following message is shown: Adjustment failed, please try again. ### Forcing the Touch Screen Calibration The touch screen calibration process can be forced in two ways: - by menu: The calibration can be started from **Menu->Settings->Screen->TSC Adjust** menu - by hard reset: The calibration is started at the end of the hard reset process (see [Hard Reset](#hard-reset)) ## Hard Reset **NOTES:** - The hard reset process is typically used as the last chance when the firmware is not properly working (e.g. in case of freezes, errors on screen etc.) - Unless the default hard coded settings have been properly configured (e.g. a self compiled firmware was installed), after an hard reset the TFT typically needs to be reconfigured with the proper `config.ini` file (see [Configuration Update](#configuration-update)) The hard reset process consists in: 1. resetting the TFT's configuration to the TFT's default hard coded settings 2. starting the touch screen calibration process (see [Touch Screen Calibration](#touch-screen-calibration)) at startup before moving to **Main** menu In order to hard reset the firmware: 1. Create a blank file named `reset.txt` 2. Copy the `reset.txt` file to the root of the SD card. The SD card capacity should be less than or equal to 8GB and formatted as FAT32 3. Insert the SD card into the TFT's SD card slot and press the reset button of the TFT (or power cycle your printer) 4. The TFT's configuration will be reset to the TFT's default hard coded settings and the touch screen calibration process will start on reboot 5. The `reset.txt` file will be renamed to `reset.txt.DONE` after the touch screen calibration process is completed ### Resetting to Default Settings When the default hard coded settings are properly configured for a TFT and the TFT's basic function such as surfing on the menus is working, in case of issues the user can opt to apply only a configuration reset (soft reset) instead of an hard reset. In order to reset to default settings: - Enter on **Menu->Settings->Feature** menu - Select and press on **Reset default settings** item - Press on **Ok** button to confirm the reset - Leave the menu ## Customization ### Bootscreen and Icons Please, see [Customization Guides](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/readme/) section for detailed information. ### Firmware
View full instructions
  1. Setup Visual Studio Code with PlatformIO instructions
  2. Click on the PlatformIO icon (①) and then click on Open Project (②):
  3. Find the BIGTREETECH firmware source directory, then click Open:
  4. After opening the project, edit platformio.ini and change the default_envs to one that matches your TFT model and version: 
    ;BIGTREE_TFT35_V1_0
;BIGTREE_TFT35_V1_1
;BIGTREE_TFT35_V1_2
;BIGTREE_TFT35_V2_0
;BIGTREE_TFT35_V3_0
;BIGTREE_TFT35_E3_V3_0
;BIGTREE_TFT28_V1_0
;BIGTREE_TFT28_V3_0
;BIGTREE_TFT24_V1_1
;MKS_TFT32_V1_3
;MKS_TFT32_V1_4
;MKS_TFT32_V1_4_NOBL
;MKS_TFT28_V3_0
;MKS_TFT28_V4_0
;MKS_TFT28_NEW_GENIUS
;MKS_TFT35_V1_0
[platformio]
src_dir      = TFT
boards_dir   = buildroot/boards
default_envs = BIGTREE_TFT35_V3_0
  5. Click the check mark (✓) at the bottom of VSCode or press Ctrl+Alt+B (Windows) / Ctrl+Option+B (macOS) to compile:
  6. A BIGTREE_TFT*_V*.*.*.bin file will be generated in the hidden .pio\build\BIGTREE_TFT*_V*_* folder. Follow the update process outlined in the Firmware Update section above to update your TFT to the latest version
**TIP:** In case there is a problem compiling the TFT firmware try to restart VSC. If this does not help and you are using macOS, delete the **packages** and **platforms** folders usually present under the folder `/Users/***username***/.platformio/`. ### Vertical Screen Orientation - Portrait Mode All the precompiled firmwares available on [`Copy to SD Card root directory to update`](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/tree/master/Copy%20to%20SD%20Card%20root%20directory%20to%20update) folder are compiled to support the standard (horizontal) screen orientation. In case the TFT needs to be placed with a vertical orientation (e.g. 90°), the firmware needs to be compiled with the portrait mode support and installed following the procedure below: - Start VSC - Open `platformio.ini` - Uncomment (remove the leading `;` character) the following line:
`; -DPORTRAIT_MODE="_portrait" ; uncomment here to enable Portrait Mode .bin firmware generation` - Compile the firmware - The binary file named `BIGTREE_TFT*_V*.*.*.x_portrait.bin` is created (see the presence of the **_portrait** suffix) - Rename the binary file to the standard name `BIGTREE_TFT*_V*.*.*.x.bin` - Copy `BIGTREE_TFT*_V*.*.*.x.bin`, the `TFT*` folder, `config.ini` and also `reset.txt` (needed to force the screen calibration) into the SD card - Proceed with the firmware update (following the usual procedure) ## Troubleshooting ### Firmware Update Failed In case the firmware update process failed: 1. Verify that you have been using the firmware matching your TFT 2. Try to upload the **firmware**, the `TFT*` folder and `config.ini` again (like described above) using a **new** SD card - 8GB or smaller, FAT32 formatted **NOTE:** Some uploads worked fine after executing a low level format of the SD card and not a quick format. ### Worst Case Scenario In case: - The screen remains black or the brightness is not stable - The screen does not react after pressing a button or executes clicks by itself or does something similar and the reset described above did not help, try the following: - Remove the TFT from the enclosure and disconnect everything from the TFT, including the cable to the mainboard - Cut a USB cable you do not need anymore and connect the red and black wire to 5V and GND of the TFT - Do not use the unshielded wires directly but use a 2 pin connector instead - Power up the TFT and try to reset the TFT or to instal a new firmware like described in this document **NOTE:** With only power supplied, you should be able to navigate through the menus using the touchscreen and even to switch to Marlin Mode (if available). Marlin Mode will not show any interface without a proper EXP connection (see [Marlin Mode Setup](#marlin-mode-setup)). ## Version History Please, see [BIGTREETECH-TouchScreenFirmware/releases](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/releases) section for a complete version history. ## Appendix ### Printing from Host OctoPrint, ESP3D, Pronterface etc, connected to a TFT's serial port, can browse files on both the TFT's and mainboard's media devices and start a print that will be handled by the host (TFT or mainboard). The following actions and the related triggering G-codes are currently supported by the TFT fw: | | **TFT SD** | **TFT USB** | **onboard media** | | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------- | :--------------------- | | **ACTION** | **G-CODE** | **G-CODE** | **G-CODE** | | **init media device** | | | `M21 ` | | **release media device** | | | `M22` | | **list files** | `M20 SD:`
or
`M20 S `

Examples:
`M20 SD:`
`M20 SD:/test`
`M20 S /test` | `M20 U:`
or
`M20 U ` | `M20` | | **select file** | `M23 SD:`
or
`M23 S `

Examples:
`M23 SD:cap.gcode`
`M23 SD:/test/cap2.gcode`
`M23 S /test/cap2.gcode` | `M23 U:`
or
`M23 U ` | `M23 ` | | **start/resume print** | `M24` | `M24` | `M24` | | **pause print** | `M25` | `M25` | `M25` | | **pause print and park head** | `M125` | `M125` | `M125` | | **abort print** | `M524` | `M524` | `M524` | | **report print status** | `M27 [C]` | `M27 [C]` | `M27 [C] [S]` | | **start file write** | `M28 SD:`
or
`M28 S `

Examples:
`M28 SD:cap.gcode`
`M28 SD:/test/cap2.gcode`
`M28 S /test/cap2.gcode` | `M28 U:`
or
`M28 U ` | `M28 [B1] ` | | **stop file write** | `M29` | `M29` | `M29` | | **delete file** | `M30 SD:`
or
`M30 S `

Examples:
`M30 SD:cap.gcode`
`M30 SD:/test/cap2.gcode`
`M30 S /test/cap2.gcode` | `M30 U:`
or
`M30 U ` | `M30 ` | | **firmware info** | `M115 TFT` | `M115 TFT` | `M115` | | **play tone** | `M300 TFT [P] [S]` | `M300 TFT [P] [S]` | `M300 [P] [S]` | **NOTES:** - TFT's media devices, if any, does not need to be initialized/released - When present, the G-code's options (e.g. `M27 C`) have the same meaning like in Marlin fw ### Printing from Remote Host OctoPrint, ESP3D, Pronterface etc, connected to a TFT's or mainboard's serial port, can host a print (print handled by the host) and optionally can trigger some actions to the TFT sending specific G-codes. The following actions and the related triggering G-codes are currently supported by the TFT fw: | **ACTION** | **G-CODE** | | :-------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **start** | `M118 P0 A1 action:print_start` | | **end** | `M118 P0 A1 action:print_end` | | **cancel** | `M118 P0 A1 action:cancel` | | **pause** | `M118 P0 A1 action:pause` | | **resume** | `M118 P0 A1 action:resume` | | **remaining time progress** | `M118 P0 A1 action:notification Time Left hms`
or
`M117 Time Left hms`

Examples:
`M118 P0 A1 action:notification Time Left 02h04m06s`
`M117 Time Left 02h04m06s` | | **print layer progress** | `M118 P0 A1 action:notification Layer Left /`
or
`M117 Layer Left /`

Examples:
`M118 P0 A1 action:notification Layer Left 51/940`
`M117 Layer Left 51/940` | | **file data progress** | `M118 P0 A1 action:notification Data Left /`
or
`M117 Data Left /`

Examples:
`M118 P0 A1 action:notification Data Left 123/12345`
`M117 Data Left 123/12345` | When the trigger `print_start` is received, the TFT switches to **Printing** menu. When the trigger `print_end` or `cancel` is received, the TFT Printing menu is finalized (statistics available etc.). When on Printing menu, pressing on the **pause**, **resume** and **stop** buttons will trigger to the remote host the following notifications, respectively: | **NOTIFICATION** | **ACK MESSAGE** | | :-------------------------- | :------------------------------------ | | **pause** | `//action:notification remote pause` | | **resume** | `//action:notification remote resume` | | **cancel** | `//action:notification remote cancel` | The remote host must properly handle the received notifications. For example, if `//action:notification remote pause` is received then the remote host must effectively pause the print and send `M118 P0 A1 action:pause` in order to trigger the pause action to the TFT. **NOTES:** - A new plugin on OctoPrint implementing the above protocol should be the preferable way (available to everyone) - With the exception of TFT70, the maximum number of displayable layer count is 999 (there's no space to display layer number and count if the layer count is above 999) ### Adding Gcode Thumbnails The TFT can display embedded G-code thumbnails in the file viewer using two different flavors: - Bigtreetech-style - PrusaSlicer-style ![ps-thumbnail](https://user-images.githubusercontent.com/54359396/121322884-a4b5c380-c90f-11eb-9380-09757d57d84e.png) The first type is to store the thumbnails at a specific location in the G-code file using a dedicated Cura plugin or external post-processing script. The thumbnail's image data is raw encoded in a format which can be displayed on the TFT without any complex image transformation. Displaying these embedded thumbnails at the TFT is the fastest approach and suitable for all different BigTreeTech's TFT variants. Downside is that you either need a dedicated plugin, for example the [BTT 3D Plug-In Suit](https://github.com/bigtreetech/Bigtree3DPluginSuit), or you have to use the post-processing script. The other type is to store the thumbnails using dedicated comments (`thumbnail begin...` and `thumbnail end`) which is implemented in stock by some slicers like Prusa-Slicer. The thumbnail's image data is a PNG file encoded in Base64 which cannot be displayed directly on the TFT: A base64 decoding and png decoding needs to be performed which is quite complex for the TFT. Displaying these thumbnails is slower but more flexible. Due to the memory requirements it is not suitable for all the different TFT variants (only for those with `RAM_SIZE > 96`). Thumbnail generation needs to be specifically enabled in Prusa-Slicer. Under _Printer Settings_ at the _G-code thumbnails_ settings you have to enter the specific required thumbnail image size for your TFT. ![ps-thumbnail-settings](https://user-images.githubusercontent.com/54359396/121322977-b9925700-c90f-11eb-9a6a-bcebd8f21542.png) Thumbnail image sizes are: - `70x70`: TFT24 / TFT28 - `95x80`: TFT43 / TFT50 - `95x95`: TFT35 - `160x140`: TFT70 If this setting is not visible within the Prusa-Slicer you need to enable _Expert Settings Mode_: ![ps-expert-settings](https://user-images.githubusercontent.com/54359396/121323041-c7e07300-c90f-11eb-9644-e12e31f7b5f9.png) ### TFT Screen Configuration and Support for RRF #### Overview The most recent version of the standard bigtreetech TFT firmware has built in support for RepRap firmware. The pre-built images have this enabled by default. #### Loading the Firmware There is now an RRF config file. It needs to be renamed from `config_rrf.ini` to `config.ini` for updating the configuration of the TFT for RRF. #### Configuration Changes Add the following line to your `config.g` to enable the screen: `M575 P1 S2 B57600`. #### Implemented Features - Auto detect fw type + separate config.ini for easier setup - Temperature/movement/cooling status monitoring and control - Print status monitoring with mid-print tuning/pausing - Macro support - Print from onboard/external SD card - Please see [RRF further tweaks #2278](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/issues/2278) for more information. #### Menu System for Macros - Thumbnail and menu system support for onboard G-codes - Load/unload menu - PID tune menu ### Setup of BTT TFT35 E3 V3 with MKS SGEN L Mainboards The following mainboards are covered by this document: - MKS GEN_L v1.0 - MKS SGEN (LPC1769) - MKS SGEN_L v1.0 (LPC1768) - MKS SGEN_L v2.0 (LPC1769) #### Connections The TFT35 E3 V3.0 has 3 cables to connect to the mainboard. Two 10 pin ribbon cables and one 5 pin serial cable. The 2 ribbon cables connect to the EXP1 and the EXP2 connections on both the TFT35 E3 V3.0 and the MKS mainboards. The RS232 cable is connected to the RS232 connection on the touchscreen, with the other end connecting to the AUX1 connection on the mainboard. The RS232 cable has 5 wires. One end has a single 5 wire connector that goes to the RS232 connector on the touchscreen, and the other end has two connectors, one has 4 wires, and the second one has one wire. That single wire is for the Reset and is not used on these MKS mainboards. The 4-pin connector plugs into the AUX1 connection. It must connect to the top row of pins when looking at the socket with the notch facing away from the mainboard and must be also plugged in with the 5v+ wire connected to the first pin in the upper left corner of the socket. The RESET wire is not connected to anything. ![Serial](https://user-images.githubusercontent.com/54359396/103489161-acc68000-4e12-11eb-8ee8-cb6376f3589a.png) **NOTE:** On the MKS mainboards there is an issue that involves at least the MKS GEN_L, MKS SGEN, and MKS SGEN_L models. The EXP1 and EXP2 connections have the socket shell installed wrong way around. The notch that indexes the cable should be facing towards the mainboard. If you get a blank screen on the TFT35 E3 V3.0 touchscreen after connecting the two EXP cables and turning the printer on, turn printer off and disconnect the 10 pin cables from either the touch screen or the mainboard and using small diagonal cutters trim the tab down to be as close to flush as you can get on both cables (and only on one end) and plug them back in with the trimmed tab now facing the mainboard. ![EXP](https://user-images.githubusercontent.com/54359396/103489164-b2bc6100-4e12-11eb-9210-685e8735e040.png) The second workaround for this issue is to carefully pry the two shells surrounding the pins on the mainboard upwards until they clear the pins. Do NOT use a metal tool for this, use a sturdy plastic or whalebone prying tool. Turn the shell 180 degrees and align the pins with the holes in the shells and push the shells back on with your thumb. Do not push the shell back on with something that could cause damage if it were to slip. Once the shells are installed you can use the stock (unaltered) cables as they are. #### Firmware Edit the `Configuration.h` file and enable (uncomment) `REPRAP_DISCOUNT_FULL_GRAPHIC_SMART_CONTROLLER`. Rebuild and deploy the Marlin firmware to your 3D Printer. ### Show more statistics at the end of the print Statistics as filament length, filament weight and filament cost can be embedded into the G-code. After the print is finished there will be an infobox that you can click and a popup will present you the printed filename (limited to the first 25 characters), the time needed for the print, the filament length used, the filament weight and its cost. In the case of multi-filament usage the statistics will show the sum of all individual data (sum of length, sum of weight, sum of cost). The statistic data in the G-code must have the following format (a good practice would be to include this at the beginning of the G-code): - `M118 P0 filament_data L:{12.3456}m` L: represents the length in meters - `M118 P0 filemant_data W:{1.23456}g` W: represents the weight in grams - `M118 P0 filament_data C:{0.1234}` C: represents the cost without a unit The values of every filament data can be in a brackets, parentheses, apostrophes, etc. or without them, measurement units can be there or not. So `M118 P0 filament_data L:(12.3456)m`, `M118 P0 filament_data L:12.3456meters`, `M118 P0 filament_data L:[12.3456]` and so on are all valid formats. For multi-filament print statistics the data for each used filament should be written, they can be separated by comma, space, asterix, whatever, except `;` and `.`. Examples for multi-filament: - `M118 P0 filament_data L:(12.3456, 8.2520974)m` - `M118 P0 filament_data W: 24.87652 15.568264 gramm` - `M118 P0 filament_data C:[1.3456], [0.56024]` The inclusion of the filament data into the G-code can be automated. In Cura all you have to do is to insert the following into the Start G-Code: - `M118 P0 filament_data L:{filament_amount}m` - `M118 P0 filament_data W:{filament_weight}g` - `M118 P0 filament_data C:{filament_cost}` In case the G-code file has been generated using the [BTT 3D Plug-In Suit](https://github.com/bigtreetech/Bigtree3DPluginSuit), the data is automatically added. In case filament data is not present in the G-code, the filament length data is calculated during print. Length is calculated regardless of using the TFT USB, TFT SD or the onboard media. Calculations are done in both absolute or relative extrusion mode. Filament data takes into account the flow rate also but with a caveat. It has to be the same flow rate during the entire time of the printing, because the end result is calculated based on the flow rate at the time the print has finished. If flow rate changes during the print the results will not be accurate anymore.