Skip to content

Instantly share code, notes, and snippets.

@ChipCE
Last active December 11, 2024 22:54
Show Gist options
  • Save ChipCE/95fdbd3c2f3a064397f9610f915f7d02 to your computer and use it in GitHub Desktop.
Save ChipCE/95fdbd3c2f3a064397f9610f915f7d02 to your computer and use it in GitHub Desktop.
Klipper bed mesh on print area only macro install guide

READ THIS FIRST

Adaptive bed mesh is merged into klipper master branch. You can use this feature without this custom macro. Official klipper adaptive bed mesh

Klipper mesh on print area only install guide

What this macro do

  • This macro will dynamically changing the bed mesh area based on the size of the parts will be printed. The fw will only probe on the area that the part will be printed (plus mesh_area_offset value)

Setup guide

  • (1) Add the following macro to your printer config, this will replace the default BED_MESH_CALIBRATE command.
[gcode_macro BED_MESH_CALIBRATE]
rename_existing: BED_MESH_CALIBRATE_BASE
; gcode parameters
variable_parameter_AREA_START : 0,0
variable_parameter_AREA_END : 0,0
; the clearance between print area and probe area 
variable_mesh_area_offset : 5.0
; number of sample per probe point
variable_probe_samples : 2
; minimum probe count
variable_min_probe_count : 4
; scale up the probe count, should be 1.0 ~ < variable_max_probe_count/variable_min_probe_count
variable_probe_count_scale_factor : 1.0
; enable preference index
variable_enable_reference_index : False
gcode:
    {% if params.AREA_START and params.AREA_END %}
        {% set bedMeshConfig = printer["configfile"].config["bed_mesh"] %}
        {% set safe_min_x = bedMeshConfig.mesh_min.split(",")[0]|float %}
        {% set safe_min_y = bedMeshConfig.mesh_min.split(",")[1]|float %}
        {% set safe_max_x = bedMeshConfig.mesh_max.split(",")[0]|float %}
        {% set safe_max_y = bedMeshConfig.mesh_max.split(",")[1]|float %}

        {% set area_min_x = params.AREA_START.split(",")[0]|float %}
	{% set area_min_y = params.AREA_START.split(",")[1]|float %}
	{% set area_max_x = params.AREA_END.split(",")[0]|float %}
	{% set area_max_y = params.AREA_END.split(",")[1]|float %}

	{% if bedMeshConfig.probe_count.split(",")|length == 2 %}
            {% set meshPointX = bedMeshConfig.probe_count.split(",")[0]|int %}
            {% set meshPointY = bedMeshConfig.probe_count.split(",")[1]|int %}
        {% else %}
            {% set meshPointX = bedMeshConfig.probe_count.split(",")[0]|int %}
            {% set meshPointY = bedMeshConfig.probe_count.split(",")[0]|int %}
        {% endif %}

	{% set meshMaxPointX = meshPointX %}
	{% set meshMaxPointY = meshPointY %}


        {% if (area_min_x < area_max_x) and (area_min_y < area_max_y) %}
            {% if area_min_x - mesh_area_offset >=  safe_min_x %}
                {% set area_min_x = area_min_x - mesh_area_offset %}
            {% else %}
                {% set area_min_x = safe_min_x %}
            {% endif %}

            {% if area_min_y - mesh_area_offset >=  safe_min_y %}
                {% set area_min_y = area_min_y - mesh_area_offset %}
            {% else %}
                {% set area_min_y = safe_min_y %}
            {% endif %}

            {% if area_max_x + mesh_area_offset <=  safe_max_x %}
                {% set area_max_x = area_max_x + mesh_area_offset %}
            {% else %}
                {% set area_max_x = safe_max_x %}
            {% endif %}

            {% if area_max_y + mesh_area_offset <=  safe_max_y %}
                {% set area_max_y = area_max_y + mesh_area_offset %}
            {% else %}
                {% set area_max_y = safe_max_y %}
            {% endif %}

            {% set meshPointX = (meshPointX * (area_max_x - area_min_x) / (safe_max_x - safe_min_x) * probe_count_scale_factor)|round(0)|int %}
            {% if meshPointX < min_probe_count %}
                {% set meshPointX = min_probe_count %}
            {% endif %}
	    {% if meshPointX > meshMaxPointX %}
                {% set meshPointX = meshMaxPointX %}
            {% endif %}

            {% set meshPointY = (meshPointY * (area_max_y -area_min_y ) / (safe_max_y - safe_min_y) * probe_count_scale_factor )|round(0)|int %}
            {% if meshPointY < min_probe_count %}
                {% set meshPointY = min_probe_count %}
            {% endif %}
	    {% if meshPointY > meshMaxPointY %}
                {% set meshPointY = meshMaxPointY %}
            {% endif %}

            {% set algorithm = "bicubic" %}
	    {% if "algorithm" in bedMeshConfig %}
	        {% set algorithm = bedMeshConfig.algorithm %}
            {% endif %}
            {% if meshPointX >=7 or meshPointY >=7 %}
                {% set algorithm = "bicubic" %}
            {% endif %}

            {% if enable_reference_index %}
                {% set referenceIndex = (meshPointX * meshPointY / 2 - 1 )|round(0)|int %}
                BED_MESH_CALIBRATE_BASE mesh_min={area_min_x},{area_min_y} mesh_max={area_max_x},{area_max_y} probe_count={meshPointX},{meshPointY} samples={probe_samples|int} algorithm={algorithm} relative_reference_index={referenceIndex}
            {% else %}
                BED_MESH_CALIBRATE_BASE mesh_min={area_min_x},{area_min_y} mesh_max={area_max_x},{area_max_y} probe_count={meshPointX},{meshPointY} samples={probe_samples|int} algorithm={algorithm}
            {% endif %}
        {% else %}
            BED_MESH_CALIBRATE_BASE
        {% endif %}
    {% else %}
        BED_MESH_CALIBRATE_BASE
    {% endif %}
  • (2) Go to slicer setting and replace the old bed mesh gcode the following command.

Prusa Slicer
BED_MESH_CALIBRATE AREA_START={first_layer_print_min[0]},{first_layer_print_min[1]} AREA_END={first_layer_print_max[0]},{first_layer_print_max[1]}

Ideal maker
BED_MESH_CALIBRATE AREA_START={print_pos_min_x},{print_pos_min_y} AREA_END={print_pos_max_x},{print_pos_max_y}

Cura slicer
BED_MESH_CALIBRATE AREA_START=%MINX%,%MINY% AREA_END=%MAXX%,%MAXY%

*(Cura slicer plugin) To make the macro to work in Cura slicer, you need to install the post process plugin click here to download (based on frankbags's script)
- In cura menu Help -> Show configuration folder.
- Copy the python script from the above link in to scripts folder.
- Restart Cura
- In cura menu Extensions -> Post processing -> Modify G-Code and select Klipper print area mesh

For user using single command START_PRINT

  • (*) If you use single command start gcode like START_PRINT BED_TEMP={material_bed_temperature_layer_0} EXTRUDER_TEMP={material_print_temperature_layer_0} .You might need to add parameter parsing to BED_MESH_CALIBRATE inside START_PRINT. This is an example, also check my macro sample
[gcode_macro START_PRINT]
variable_parameter_EXTRUDER_TEMP: 190
variable_parameter_BED_TEMP: 60
; gcode parameters for area bed mesh
variable_parameter_AREA_START : 0,0
variable_parameter_AREA_END : 0,0
gcode:
    # preheat, homing, etc
    BED_MESH_CALIBRATE AREA_START={params.AREA_START|default("0,0")} AREA_END={params.AREA_END|default("0,0")}
    # the rest of your start macro here

And you will need to change Slicer start gcode to this

  • Cura: START_PRINT EXTRUDER_TEMP={material_print_temperature_layer_0} BED_TEMP={material_bed_temperature_layer_0} AREA_START=%MINX%,%MINY% AREA_END=%MAXX%,%MAXY%
  • Prusa slicer: START_PRINT EXTRUDER_TEMP=[first_layer_temperature] BED_TEMP=[first_layer_bed_temperature] AREA_START={first_layer_print_min[0]},{first_layer_print_min[1]} AREA_END={first_layer_print_max[0]},{first_layer_print_max[1]}

change logs

  • 2022/07/21
    • Added force lagrange algorithm for mesh with lower than 3 points
    • Added enable_reference_index config flag

The code does not work?

  • I will try to help if possible, you will have to post ALL of your configs, your slicer start gcode and your sliced gcode.
  • If I'm cannot or too slow to respose, our discord members might help you. Check our discord here
@kubark42
Copy link

kubark42 commented Sep 21, 2022

@locki-cz you can test manually with BED_MESH_CALIBRATE AREA_START=50,50 AREA_END=100,100. This will do a mesh across a square bounded by (50,50) and (100,100) You'll have to set the bounding box yourself, though, since it's not coming from the slicer.

@locki-cz
Copy link

locki-cz commented Oct 5, 2022

I followed this manual but i am not able figureou what is wrong :(

21:02:24 Klipper state: Disconnect
21:02:24 FIRMWARE_RESTART
21:02:08 Internal error on command:"PRINT_START"
21:02:08 Internal error on command:"BED_MESH_CALIBRATE"
21:02:08 Internal error on command:"BED_MESH_CALIBRATE_BASE"

image

@dnahas
Copy link

dnahas commented Oct 11, 2022

To enforce an odd number of probe points, I added the following, BEFORE the {% set algorithm = "lagrange" %} line. **This (lazy) placement can increase an even max points variable.

{% if meshPointX is divisibleby 2 %}
     {% set meshPointX = meshPointX + 1 %}
{% endif %}
{% if meshPointY is divisibleby 2 %}
     {% set meshPointY = meshPointY + 1 %}
{% endif %}

@ChipCE Thank you for you effort!!

@datapaganism
Copy link

Is there any possible way to increase the object area and add a purge line?

@ChipCE
Copy link
Author

ChipCE commented Oct 21, 2022

@datapaganism Yes, its possible but

  • this macro is a override of the original command and it should do just that
  • Each machine have it's purge line position, length and direction. It's hard to make one to work for all.

A simple hack that cam make it work on your machine: save area_min_x, area_min_y, area_max_x, area_max_y to some where(with saved variable or set gcode variable value) and use that as preference for your purge line gcode/macro

@ChipCE
Copy link
Author

ChipCE commented Oct 21, 2022

@dnahas Thank you!
My small machine actually have max possible probe count 6x6 so i might want to keep the even probe count. I have ideal to fix all the algorithm and probe count problem. I will try to move my lazy ass and fix that in the next few days.

@dnahas
Copy link

dnahas commented Oct 22, 2022

Is there any possible way to increase the object area and add a purge line? @datapaganism

For RatRig RatOS I changed the following PRIME_LINE macro lines (I didnt see the need to save it).

From:

  G1 X{printer.toolhead.axis_minimum.x + 5} Y{printer.toolhead.axis_minimum.y + 10} F{speed}
  G1 Y{printer.toolhead.axis_minimum.y + 80} E16 F1200
  G1 Y{printer.toolhead.axis_minimum.y + 100} F{speed}

To:

  G1 X{printer.bed_mesh.mesh_min[0]|float} Y{printer.bed_mesh.mesh_min[1]|float} F{speed}
  G1 Y{printer.bed_mesh.mesh_min[1]|float + 80} E16 F1200
  G1 Y{printer.bed_mesh.mesh_min[1]|float + 100} F{speed}

*This is my lazy code that does not provide any check for out side of safe area.

Also see
printer.bed_mesh.profiles.XXXXXX.mesh_params.min_y
printer.configfile.save_config_pending_items['XXXXXX'].min_y

@pjaxed
Copy link

pjaxed commented Oct 29, 2022

Thank you @ChipCE and all contributors. I now have this working with my Klicky probe setup. One issue left for me to work though is the Z Offset which is now off. Any pointers where to look?

@5P4P
Copy link

5P4P commented Oct 29, 2022

Thank you @ChipCE and all contributors. I now have this working with my Klicky probe setup. One issue left for me to work though is the Z Offset which is now off. Any pointers where to look?

This works great on my Voron 2.4r2 https://github.com/protoloft/klipper_z_calibration

@pjaxed
Copy link

pjaxed commented Oct 29, 2022 via email

@xdased14x
Copy link

xdased14x commented Nov 1, 2022

@panik988 @Lecso11, et al: There are two things I had to do to get this to work with Klicky.

  1. Place the below into a file called bed_mesh_print_area.cfg.
[gcode_macro BED_MESH_CALIBRATE]
rename_existing: BED_MESH_CALIBRATE_BASE
; gcode parameters
variable_parameter_AREA_START : 0,0
variable_parameter_AREA_END : 0,0
; the clearance between print area and probe area 
variable_mesh_area_offset : 5.0
; number of sample per probe point
variable_probe_samples : 2
; minimum probe count
variable_min_probe_count : 3
; scale up the probe count, should be 1.0 ~ < variable_max_probe_count/variable_min_probe_count
variable_probe_count_scale_factor : 1.0
; enable preference index
variable_enable_reference_index : False

variable_mesh_delta : 25                   ## distance between points
variable_x_mesh_max : 7                    ## max points on x-axis
variable_y_mesh_max : 7                    ## max points on y-axis

gcode:

    _CheckProbe action=query
	G90
    Attach_Probe

	{% if params.AREA_START and params.AREA_END %}
	## get [bed_mesh] config parameters
		{% set bedMeshConfig = printer["configfile"].config["bed_mesh"] %}
		{% set safe_min_x = bedMeshConfig.mesh_min.split(",")[0]|float %}
		{% set safe_min_y = bedMeshConfig.mesh_min.split(",")[1]|float %}
		{% set safe_max_x = bedMeshConfig.mesh_max.split(",")[0]|float %}
		{% set safe_max_y = bedMeshConfig.mesh_max.split(",")[1]|float %}
	## get print area min/max from slicer gcode
		{% set area_min_x = params.AREA_START.split(",")[0]|float %}
		{% set area_min_y = params.AREA_START.split(",")[1]|float %}
		{% set area_max_x = params.AREA_END.split(",")[0]|float %}
		{% set area_max_y = params.AREA_END.split(",")[1]|float %}
	## set probing area
		{% if area_min_x - mesh_area_offset >=  safe_min_x %}
			{% set area_min_x = area_min_x - mesh_area_offset %}
			{% else %}
			{% set area_min_x = safe_min_x %}
		{% endif %}
		{% if area_min_y - mesh_area_offset >=  safe_min_y %}
			{% set area_min_y = area_min_y - mesh_area_offset %}
			{% else %}
			{% set area_min_y = safe_min_y %}
		{% endif %}
		{% if area_max_x + mesh_area_offset <=  safe_max_x %}
			{% set area_max_x = area_max_x + mesh_area_offset %}
			{% else %}
			{% set area_max_x = safe_max_x %}
		{% endif %}
		{% if area_max_y + mesh_area_offset <=  safe_max_y %}
			{% set area_max_y = area_max_y + mesh_area_offset %}
			{% else %}
			{% set area_max_y = safe_max_y %}
		{% endif %}
	## set probe counts
		{% set meshPointX = ((area_max_x - area_min_x) / mesh_delta + 1)|round(0)|int %}
		{% if meshPointX < 3 %}
			{% set meshPointX = 3 %}
			{% elif meshPointX > x_mesh_max %}
			{% set meshPointX = x_mesh_max %}
		{% endif %}
		{% set meshPointY = ((area_max_y - area_min_y) / mesh_delta + 1)|round(0)|int %}
		{% if meshPointY < 3 %}
			{% set meshPointY = 3 %}
			{% elif meshPointY > y_mesh_max %}
			{% set meshPointY = y_mesh_max %}
		{% endif %}
	## check for invalid mesh
		{% if meshPointX > 5 %}
			{% if meshPointY == 3 %}  # 7x3 mesh invalid for bicubic
			{% set meshPointY = 5 %}  # set 7x5 mesh
			{% endif %}
		{% endif %}
		{% if meshPointY > 5 %}
			{% if meshPointX == 3 %}  # 3x7 mesh invalid for bicubic
			{% set meshPointX = 5 %}  # set 5x7 mesh
			{% endif %}
		{% endif %}
	## set new reference index point
		{% set referenceIndex = (meshPointX * meshPointY / 2 - 1 )|round(0)|int %}
	## send bed mesh parameters
		M117 probe_count={meshPointX},{meshPointY}
		BED_MESH_CALIBRATE_BASE mesh_min={area_min_x},{area_min_y} mesh_max={area_max_x},{area_max_y} probe_count={meshPointX},{meshPointY} relative_reference_index={referenceIndex} 
	{% else %}
	BED_MESH_CALIBRATE_BASE
	{% endif %}

    Dock_Probe
  1. Place the below into klicky-probe.cfg.
[include ./bed_mesh_print_area.cfg]             # Bounding box for mesh https://gist.github.com/ChipCE/95fdbd3c2f3a064397f9610f915f7d02?permalink_comment_id=4119897#gistcomment-4119897

You can test with, e.g., BED_MESH_CALIBRATE AREA_START=100,100 AREA_END=200,200

tried this and i get a full bed mesh every time i run a test print. the part i'm using is small and i move it around the bed
i committed out the the klicky bed mesh cfg,not sure what i'm doing wrong

@pjaxed
Copy link

pjaxed commented Nov 3, 2022

Thank you for feedback. Issue was with the code generated by my slicer. All is working as it should.

@C0NN0R92
Copy link

C0NN0R92 commented Nov 5, 2022

i keep getting Error evaluating 'gcode_macro BED_MESH_CALIBRATE:gcode': jinja2.exceptions.UndefinedError: 'dict object' has no attribute 'bed_mesh' can anyone help me

@ChipCE
Copy link
Author

ChipCE commented Nov 5, 2022

i keep getting Error evaluating 'gcode_macro BED_MESH_CALIBRATE:gcode': jinja2.exceptions.UndefinedError: 'dict object' has no attribute 'bed_mesh' can anyone help me

seem like "bed_mesh" is missing in your original config

@ga-rr-is-on
Copy link

ga-rr-is-on commented Nov 17, 2022

To get this to work on IdeaMaker using single Start_Print
(including temp parameters to help those that are new to using Klipper macros and parameters within the Slicer G-Code). If you can copy and paste, you don't need to modify anything.
Copy and paste the BED_MESH_CALIBRATE macro as per instructions above to your printer.cfg file.
If you have a START_PRINT macro already in you printer.cfg file, comment out that section and paste the code below above the code you just commented out. If not, just paste this under the BED_MESH_CALIBRATE macro. Indentation is important.

[gcode_macro START_PRINT]
gcode:
    {% set BED_TEMP = params.BED_TEMP|default(60)|float %} # Setup bed temp parameter and give it a default value of 60
    {% set EXTRUDER_TEMP = params.EXTRUDER_TEMP|default(210)|float %} # Setup extruder temp parameter and give it a default value of 210
    {% set AREA_START = params.AREA_START|default("75,75") %} # Setup start coordinates for the mesh and give it a default of 75,75
    {% set AREA_END = params.AREA_END|default("125,125") %} # Setup end coordinates for the mesh and give it a default of 125,125
    #The original default values for the Start and End coordinates were both 0,0, which either takes the measured value at 0,0 and uses that value everywhere, or does nothing, i forget
    #75,75 and 125,125 will at least probe a small area close to the middle depending on your size bed. Adjust however you want. 
    M140 S{BED_TEMP} # Start bed heating using the declared or default value
    G28 # Home the printer while we wait on the bed to heat up
    M190 S{BED_TEMP} # Wait for bed to reach temperature
    BED_MESH_CALIBRATE AREA_START={params.AREA_START} AREA_END={params.AREA_END} # Create the mesh
    G90 # Use absolute coordinates
    G1 X1 Y1 F5000; Move to the front left corner
    SET_GCODE_OFFSET Z=0.0 # Reset the G-Code Z offset (adjust Z offset if needed)
    G1 Z5 F3000 # Move the nozzle near the bed    
    G1 Z0.15 F300 # Move the nozzle very close to the bed
    M109 S{EXTRUDER_TEMP} # Set and wait for nozzle to reach temperature

Uncomment any additional lines that you commented out of the existing START_PRINT macro that you want to include and each line is commented so you understand exactly what it is doing.

Leave anything commented out that you do not know what it is doing until you can add your own comments. Additional commands are useful, but not necessary.

Add this to your Start GCode setting in IdeaMaker:

START_PRINT EXTRUDER_TEMP={temperature_extruder1} BED_TEMP={temperature_heatbed} AREA_START={print_pos_min_x},{print_pos_min_y} AREA_END={print_pos_max_x},{print_pos_max_y}

@olivierD-FR
Copy link

Hello, anyone know how I can fix this problem. I receive this error not on every gcode file?

image

@olivierD-FR
Copy link

Hello, anyone know how I can fix this problem. I receive this error not on every gcode file?

image

SOLVED: I was not passing the zone to test in the slicer (forgot to update all my printers config in Prusa Slicer

@tohax
Copy link

tohax commented Dec 1, 2022

Simplify3d?

@Skennd
Copy link

Skennd commented Dec 16, 2022

Unfortunately I wasn't isolating variables but I was just able to get past there errors. The last bits of tinkering I did was moving the BMC macro above START_PRINT and commenting out split_delta_z and a faulty region in the [bed_mesh] config section.

Internal error on command:"START_PRINT"
Internal error on command:"BED_MESH_CALIBRATE"
Internal error on command:"BED_MESH_CALIBRATE_BASE"

@voronbuildstart
Copy link

im having the same problem as Skennd and locki-cz has anyone solved this been at it for a bit now

@Skennd
Copy link

Skennd commented Dec 20, 2022

im having the same problem as Skennd and locki-cz has anyone solved this been at it for a bit now

Like I'd said I was able to get past it. I did them all at once tho. I'm guessing based on nothing at all that putting the bed mesh macro before [start_print]. I also commented out the faulty region and split delta z I had set in my [bed_mesh] config section

@locki-cz
Copy link

locki-cz commented Dec 20, 2022

there are some bugs in macro, i used diferent one, much better ... but still have problem with first layer ... then just turned it of because floating z endstop with bed mesh when it is not complete.... no time to install TAP ... try this one:

https://github.com/Frix-x/klipper-voron-V2/blob/main/macros/calibration/adaptive_bed_mesh.cfg

and i will use this with tap and it have random purge ...

https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging

@Skennd
Copy link

Skennd commented Dec 21, 2022

I'll have to check that out once I get a coreXY set up. I'm on an ender 3 so I've been avoiding the nice voron and ratOS resources. I feel like it would take more work to adapt than this was.
If you don't mind be asking, what's buggy about this one?

@MrLowe72
Copy link

MrLowe72 commented Jan 1, 2023

Hi I think I know the answer but could do with this being confirmed, after installing the macro and the bed mesh being calibrated for the print i now get this when the probe is completed

Move out of range: 203.175 361.000 7.600 [14.000]

This is an Ender 3 S1 Pro with a bed of 220 x 220, why is it calculating a 203 x 361.

thanks

@ChipCE
Copy link
Author

ChipCE commented Jan 2, 2023

If the bed mesh is completed then the error showup, the problem is more likely from your start gcode. Just my random guess, maybe the G0 or G1 is called when the printer in relative mode. You can try to add G90 line right after bed meah command called.

@rstudner
Copy link

rstudner commented Jan 7, 2023

Question - so I have this working (I think). But wanted a bit of clarity.

If I go into Fluidd/Mainsail "Tune" to view the Mesh, it shows it near a corner and not "in the center of the bed" though I of course watched it probe perfectly in the center of my bed around the "bound" of the print as desired
Screenshot 2023-01-07 at 8 36 38 AM

@frankbags
Copy link

are the X and Y coordinates correct? that's all that matters, the visual representation will be cut off after the furthest probe points.

@rstudner
Copy link

rstudner commented Jan 9, 2023

Anyone know in superslicer what the custom G code would be? I can't seem to find the right variable:

START_PRINT BED_TEMP=[first_layer_bed_temperature] EXTRUDER_TEMP=[first_layer_temperature] AREA_START=[first_layer_print_min[0]],[first_layer_print_min[1]] AREA_END=[first_layer_print_max[0]],[first_layer_print_max[1]]

doesn't like first_layer_print_min[0] etc.

@ChipCE
Copy link
Author

ChipCE commented Jan 10, 2023

@rstudner The web UI only draw the area you probed. Does the web UI display the exact mesh position?

what slicer are you using?

@petitxef
Copy link

@rstudner I have this code on start g-code on superslicer:

START_PRINT AREA_START_X={first_layer_print_min[0]} AREA_START_Y={first_layer_print_min[1]} AREA_END_X={first_layer_print_max[0]} AREA_END_Y={first_layer_print_max[1]}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment