https://github.com/kageurufu/preprocess_cancellation

Klipper Exclude Object Preprocessor for multiple slicers
https://github.com/kageurufu/preprocess_cancellation

Last synced: 2 months ago
JSON representation

Klipper Exclude Object Preprocessor for multiple slicers

• Host: GitHub
• URL: https://github.com/kageurufu/preprocess_cancellation
• Owner: kageurufu
• License: gpl-3.0
• Created: 2021-09-03T20:42:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-28T16:45:38.000Z (6 months ago)
• Last Synced: 2024-07-28T11:08:55.041Z (2 months ago)
• Language: G-code
• Homepage:
• Size: 5.21 MB
• Stars: 150
• Watchers: 10
• Forks: 24
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-voron - Kageurufu Cancel Object Preprocessor - G-Code postprocessor to insert annotations for use with Troy Jacobson's Klipper object cancellation plugin. (Printer Firmware / Klipper)

README

        
Klipper GCode Preprocessor for Object Cancellation

==================================================

This preprocessor modifies GCode files to add klipper's exclude object gcode.

The following slicers are supported:

* SuperSlicer

* PrusaSlicer

* Slic3r

* Cura

* IdeaMaker

## Installation and usage

### SuperSlicer, PrusaSlicer, and Slic3r

Download the provided binary for your platform from the [git releases page](https://github.com/kageurufu/preprocess_cancellation/releases), and place it in with in your slicer's folder.

 

In your Print Settings, under Output Options, add `preprocess_cancellation.exe;` to the 

"Post-Processing Scripts". For mac or linux, you should just use `preprocess_cancellation;`

Then, all generated gcode should be automatically processed and rewritten to support cancellation.

### G-Codes for Object Cancelation

There are 3 gcodes inserted in the files automatically, and 4 more used to control the 

object cancellation.

`EXCLUDE_OBJECT_DEFINE NAME= [CENTER=x,y] [POLYGON=[[x,y],...]]`

The NAME must be unique and consistent throughout the file. CENTER is the center location 

for the mesh, used to show on interfaces where and object being canceled is on the bed. 

POLYGON is a series of points, used to represent the bounds of the object. It can be just 

a bounding box, a simplified outline, or another useful shape.

`EXCLUDE_OBJECT_START NAME=` and `EXCLUDE_OBJECT_END [NAME=]`

The beginning and end markers for the gcode for a single object. When an object is excluded, 

anything between these markers is ignored.

For a full breakdown, see [the klipper G-Code Reference](https://www.klipper3d.org/G-Codes.html#excludeobject)

### Known Limitations

Cura and Ideamaker sliced files have all support material as a single non-mesh entity.

This means that when canceling an object, it's support will still print. Including

support that is inside or built onto the canceled mesh. The Slic3r family (including

PrusaSlicer and SuperSlicer) treat support as part of the individual mesh's object,

so canceling a mesh cancels it's support as well.

### How does it work

This looks for known markers inside the GCode, specific to each slicer. It uses those

to figure out the printing object's name, and track's all extrusion moves within it's 

print movements. Those are used to calculate a minimal bounding box for each mesh. 

A series of `EXCLUDE_OBJECT_DEFINE` gcodes are placed in a header, including the bounding boxes

and objects centers. Then, these markers are used to place `EXCLUDE_OBJECT_START` and 

`EXCLUDE_OBJECT_END` gcodes in the file surrounding each set of extrusions for that object.