Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update for some extra adaptive info #6664

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/Bed_Mesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,9 +410,12 @@ adaptive_margin: 5
![adaptive_bedmesh_margin](img/adaptive_bed_mesh_margin.svg)

By nature, adaptive bed meshes use the objects defined by the Gcode file being printed.
Therefore, it is expected that each Gcode file will generate a mesh that probes a different
area of the print bed. Therefore, adapted bed meshes should not be re-used. The expectation
is that a new mesh will be generated for each print if adaptive meshing is used.
EXCLUDE_OBJECT_DEFINE gcode needs to be present in the Gcode file, which can be procesed in
with a slicer plugin, moonraker or by slicer specific functions, see [Slicers.md](Slicers.md),
also [exclude_object] should be in the configuration.It is expected that each Gcode file
Copy link
Contributor

@thijstriemstra thijstriemstra Aug 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing space before "It" and capitalize Moonraker

will generate a mesh that probes a different area of the print bed. Therefore, adapted bed
meshes should not be re-used. The expectation is that a new mesh will be generated for each
print if adaptive meshing is used.

It is also important to consider that adaptive bed meshing is best used on machines that can
normally probe the entire bed and achieve a maximum variance less than or equal to 1 layer
Expand Down
28 changes: 26 additions & 2 deletions docs/Slicers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

This document provides some tips for configuring a "slicer"
application for use with Klipper. Common slicers used with Klipper are
Slic3r, Cura, Simplify3D, etc.
Slic3r, Cura, Simplify3D, PrusaSlicer, SuperSlicer, OrcaSlicer etc.

## Set the G-Code flavor to Marlin

Many slicers have an option to configure the "G-Code flavor". The
default is frequently "Marlin" and that works well with Klipper. The
"Smoothieware" setting also works well with Klipper.
"Smoothieware" setting also works well with Klipper. Some slicers
may have an actual "Klipper" flavor, which you should use over
"Marlin" or "Smoothieware" if available.

## Klipper gcode_macro

Expand Down Expand Up @@ -88,6 +90,28 @@ Klipper's maximum extrusion cross-section check.
In contrast, it is okay (and often helpful) to use a slicer's
"retract" setting, "wipe" setting, and/or "wipe on retract" setting.

## Disable arc generating features of OrcaSlicer

OrcaSlicer uses "Arc fitting" and "Spiral Z-Lift", these will produce
errors in the console if used without enabling gcode_arcs in Klipper
config. These options can also produce timing errors due to how Klipper
deals with arcs and can cause the step rate to be massively increased,
overloading the hardware.

## Object labelling and exclude_object

Some slicers, like the Slic3r forks: PrusaSlicer and OrcaSlicer can
automatically produce the gcode needed for exclude_object support with no
need for external processing. This slicer option should be enabled when
using exclude_object support. The flavor should be set to Klipper and the
label object setting set to "Firmware Specific", making sure all options
for Label Object and Exclude Object are enabled.
Other slicers that dont have this functionality can be processed through a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dont -> don't

plugin or via Moonraker Object Processing. In all cases this will insert an
EXCLUDE_OBJECT_DEFINE gcode into the first commands in the Gcode file that
will inform Klipper of the object details, to be used for adaptive functions
and object cancelling.

## START_PRINT macros

When using a START_PRINT macro or similar, it is useful to sometimes
Expand Down
Loading