GitHunt
JO

jounathaen/octoprint_btt_touch_support

OctoPrint Support for BTT TFT TouchScreens

OctoPrint-BTT TFT Touchscreen Firmware support

This plugin adds support for the remote printing features of the BigTreeTech TFT
Touchscreen Firmware's

Touch Mode for OctoPrint.

This plugin does not interact with the firmware's Marlin Mode - a normal serial connection between the TFT and the printer is sufficient.

Features:

  • Automatically switch to printing mode on the TFT upon print start.
  • Update the progress indicator on the TFT during print.
  • Update the remaining time on the TFT during print.
  • Update the Layer progress on the TFT (requires DisplayLayerProgress)
  • React to the TFT's Pause, Resume and Cancel buttons on in OctoPrint.

This plugin does not interact with the firmware's Marlin Mode - a normal serial connection
between the TFT and the printer is sufficient.

This is a fork of the M73Progress plugin, created by Cesar Vandevelde!

Picture of a BTT TFT Touchscreen

Setup

Install via the bundled Plugin Manager
or manually using this URL:

https://github.com/jounathaen/octoprint_btt_touch_support/archive/master.zip

Configuration

You can fine-tune the plugin's behavior in the BTT TFT Touchscreen tab in the OctoPrint settings (don't forget to restart OctoPrint to apply changes):

  • Use time estimate: By default, the plugin uses OctoPrint's built-in progress
    estimate, which is based on the progress inside a G-code file. In some cases,
    a better progress estimate can be calculated from the time elapsed and the
    time remaining: P = elapsed / (elapsed + remaining). This option is
    particularly useful for
    PrintTimeGenius users.

  • BTT TFT touchscreen serial port number: The number of the serial port the TFT is connected to. If it is set to 0 (default), all serial ports will be used, which could lead to issues if other plugins also utilize action commands.

    (Typically, your printer has two serial ports 1 and 2, of which one is the connected to your OctoPrint host and the other one to the TFT)

Languages

Python88.3%Jinja11.7%

Contributors

Created November 24, 2024
Updated March 6, 2026
jounathaen/octoprint_btt_touch_support | GitHunt