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: updates BED_MESH_CALIBRATE description #6494

Merged

Conversation

pedrolamas
Copy link
Contributor

Adds the ADAPTIVE and ADAPTIVE_MARGIN parameters to the documentation.

@pedrolamas
Copy link
Contributor Author

@Arksine @voidtrance I would really appreciate it if you could review this.

the bed using generated points specified by the parameters in the config. After
probing, a mesh is generated and z-movement is adjusted according to the mesh.
`BED_MESH_CALIBRATE [PROFILE=<name>] [METHOD=manual] [HORIZONTAL_MOVE_Z=<value>]
[<probe_parameter>=<value>] [<mesh_parameter>=<value>] [ADAPTIVE=1]
Copy link
Contributor

Choose a reason for hiding this comment

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

ADAPTIVE=0 is also valid. Technically, any integer value is valid since the option is only used as a boolean.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed, and the only reason I only specified ADAPTIVE=1 was to follow the same pattern as with METHOD=manual (where the default METHOD=automatic is also omitted, and thus, I omitted the default ADAPTIVE=0)

docs/G-Codes.md Outdated
See the PROBE command for details on the optional probe parameters. If
METHOD=manual is specified then the manual probing tool is activated - see the
MANUAL_PROBE command above for details on the additional commands available
while this tool is active. The optional `HORIZONTAL_MOVE_Z` value overrides the
`horizontal_move_z` option specified in the config file.
`horizontal_move_z` option specified in the config file. If ADAPTIVE=1 is
specified then the probed area will use the objects defined by the Gcode file
Copy link
Contributor

Choose a reason for hiding this comment

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

then the probed area will use the objects defined by the Gcode file

This reads a little odd to me. The probed area doesn't use anything. The algorithm uses the printed objects to re-define the probed area.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about this:

If ADAPTIVE=1 is specified then the objects defined by the Gcode file being printed will be used to define the probed area.

Adds the ADAPTIVE and ADAPTIVE_MARGIN parameters to the documentation.

Signed-off-by: Pedro Lamas <[email protected]>
@pedrolamas pedrolamas force-pushed the pedrolamas/docs-bed-mesh-calibrate branch from 451e290 to 4a08980 Compare February 19, 2024 09:27
@KevinOConnor KevinOConnor merged commit a77d079 into Klipper3d:master Feb 20, 2024
1 check passed
@KevinOConnor
Copy link
Collaborator

Thanks.

-Kevin

@pedrolamas pedrolamas deleted the pedrolamas/docs-bed-mesh-calibrate branch February 20, 2024 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants