Skip to content

Commit

Permalink
Added BTT TFT Touchscreen Firmware support plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
jounathaen committed Nov 26, 2024
1 parent 93e600b commit 2187004
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions _plugins/btt_touch_support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
layout: plugin

id: btt_touch_support
title: BTT TFT TouchScreen Firmware Support
description: Support for the BTT TFT touchscreen firmware
authors:
- Jounathaen
license: AGPLv3

date: 2024-11-24

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

#privacypolicy: your plugin's privacy policy URL

# Set this to true if your plugin uses the dependency_links setup parameter to include
# library versions not yet published on pypi. SHOULD ONLY BE USED IF THERE IS NO OTHER OPTION!
follow_dependency_links: false

tags:
- display
- touchscreen
- action commands


featuredimage: /assets/img/plugins/btt_touch_support/btt_touchscreen.jpg

compatibility:
python: ">=2.7,<4"

---

# OctoPrint-BTT TFT Touchscreen Firmware support

This plugin adds support for the remote printing features of the [BigTreeTech TFT
Touchscreen Firmware's](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware)
_Touch Mode_ for [OctoPrint](https://github.com/OctoPrint/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](/plugins/DisplayLayerProgress))
- React to the TFT's _Pause_, _Resume_ and _Cancel_ buttons on in OctoPrint.

This is a fork of the [M73Progress plugin](https://github.com/cesarvandevelde/OctoPrint-M73Progress), created by [Cesar Vandevelde](/by_author/#cesar-vandevelde)!

{:refdef: style="text-align: center;"}
![BTT TFT Touchscreen during an OctoPrint
print](/assets/img/plugins/btt_touch_support/btt_touchscreen.jpg){: width="50%" }
{: refdef}

## Setup

Install via the bundled [Plugin Manager](https://github.com/foosel/OctoPrint/wiki/Plugin:-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:

* `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](https://github.com/eyal0/OctoPrint-PrintTimeGenius) users.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2187004

Please sign in to comment.