Skip to content

Commit

Permalink
Octoprint and RRF #2278 added to ReadMe (#2285)
Browse files Browse the repository at this point in the history
  • Loading branch information
oldman4U committed Dec 17, 2021
1 parent 6f7bd98 commit e069f7a
Showing 1 changed file with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,12 @@ Important information related to BigTreeTech's TFT touchscreen 3D printer contro

- [Appendix](#appendix)

- [Integration with Octoprint](#integration-with-octoprint)
- [Embedded Gcode Thumbnails](#embedded-gcode-thumbnails)
- [TFT Screen Configuration and support for RRF](#tft-screen-configuration-and-support-for-rrf)
- [Setup of BTT TFT35 E3 V3 with MKS SGEN L Mainboards](#setup-of-btt-tft35-e3-v3-with-mks-sgen-l-mainboards)
- [Show more statistics at the end of the print](#show-more-statistics-at-the-end-of-the-print)




Expand Down Expand Up @@ -408,9 +409,44 @@ See [BIGTREETECH-TouchScreenFirmware/releases](https://github.com/bigtreetech/BI



## Appendix

### Integration with Octoprint

Octoprint can optionally trigger some actions to the TFT sending specific gcodes. The following actions and the related triggering gcodes are currently supported by the TFT fw:

**start:**
M118 A1 P0 action:print_start

**end:**
M118 A1 P0 action:print_end

**cancel:**
M118 A1 P0 action:cancel

**pause:**
M118 A1 P0 action:pause

**resume:**
M118 A1 P0 action:resume

**time remaining progress:**
M118 A1 P0 action:notification Time Left hms (e.g. 02h04m06s)

M117 Time Left hms
**file data progress:**

M118 A1 P0 action:notification Data Left / (e.g. 123/12345)
M117 Data Left /

When the trigger "print_start" is received, the TFT switches to Printing menu.
Once on Printing menu, the "pause", "resume" and "stop" buttons on the menu will be disabled.
That means only Octoprint will control the print.
Only on print end or cancel the TFT Printing menu is finalized (statistics available etc...) and unlocked (it can be closed).

**NOTE:** A new plugin on Octoprint implementing the above protocol should be the preferable way (available to everyone)


## Appendix

### Embedded Gcode Thumbnails

Expand Down Expand Up @@ -469,14 +505,16 @@ Auto detect fw type + separate config.ini for easier setup
- Print status monitoring with mid-print tuneing/pausing
- Macro support
- Print from onboard/external SD card
- Please see [Feature request #1791](https://github.com/bigtreetech/BIGTREETECH-TouchScreenFirmware/issues/1791) for more information.
- 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 gcodes
- 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.
Expand Down

0 comments on commit e069f7a

Please sign in to comment.