4.0 KiB
layout, title, nav_order, has_children, permalink, redirect_from
layout | title | nav_order | has_children | permalink | redirect_from | |
---|---|---|---|---|---|---|
default | Configuration | 5 | false | /configuration |
|
Required configuration
Mainsail requires a minimum configuration to function properly and will display a warning at startup if the required parts are not found in your configuration file(s). {: .warning}
The following configuration elements are mandatory and must be configured for Mainsail to operate correctly:
The following configuration elements are optional, including making tweaks and alterations to Klipper's default commands:
Virtual SD Card
The Virtual SD Card
allows gcode file uploads.
[virtual_sdcard]
path: ~/gcode_files
Display Status
Display Status
is required for messages in your status panel, if you don't have [display]
in your configuration.
[display_status]
Pause, Resume, Cancel
These macros enable pause and resume in Klipper.
[pause_resume]
Macros
Add pause / resume / cancel functionality
You can modify the below macros to fit your needs. {% raw %}
[gcode_macro PAUSE]
description: Pause the actual running print
rename_existing: PAUSE_BASE
gcode:
##### set defaults #####
{% set x = params.X|default(230) %} #edit to your park position
{% set y = params.Y|default(230) %} #edit to your park position
{% set z = params.Z|default(10)|float %} #edit to your park position
{% set e = params.E|default(1) %} #edit to your retract length
##### calculate save lift position #####
{% set max_z = printer.toolhead.axis_maximum.z|float %}
{% set act_z = printer.toolhead.position.z|float %}
{% set lift_z = z|abs %}
{% if act_z < (max_z - lift_z) %}
{% set z_safe = lift_z %}
{% else %}
{% set z_safe = max_z - act_z %}
{% endif %}
##### end of definitions #####
PAUSE_BASE
G91
{% if printer.extruder.can_extrude|lower == 'true' %}
G1 E-{e} F2100
{% else %}
{action_respond_info("Extruder not hot enough")}
{% endif %}
{% if "xyz" in printer.toolhead.homed_axes %}
G1 Z{z_safe}
G90
G1 X{x} Y{y} F6000
{% else %}
{action_respond_info("Printer not homed")}
{% endif %}
[gcode_macro RESUME]
description: Resume the actual running print
rename_existing: RESUME_BASE
gcode:
##### set defaults #####
{% set e = params.E|default(1) %} #edit to your retract length
#### get VELOCITY parameter if specified ####
{% if 'VELOCITY' in params|upper %}
{% set get_params = ('VELOCITY=' + params.VELOCITY) %}
{%else %}
{% set get_params = "" %}
{% endif %}
##### end of definitions #####
G91
{% if printer.extruder.can_extrude|lower == 'true' %}
G1 E{e} F2100
{% else %}
{action_respond_info("Extruder not hot enough")}
{% endif %}
RESUME_BASE {get_params}
[gcode_macro CANCEL_PRINT]
description: Cancel the actual running print
rename_existing: CANCEL_PRINT_BASE
gcode:
TURN_OFF_HEATERS
CANCEL_PRINT_BASE
{% endraw %}
Optional
Customisation
Klipper has a number of preset commands that are also just macros.
The default configuration of these may not suit your needs or preferences, though they are usually a good place to start. It's possible to adjust these by including them in your config, along with any additional code you would like to run.
Example
Adjusting the BED_MESH_CALIBRATE
command, which is found in the menu at Sidebar > Heightmap > Calibrate.
{% raw %}
[gcode_macro BED_MESH_CALIBRATE]
rename_existing: BASE_BED_MESH_CALIBRATE
gcode:
#before the original gcode
BED_MESH_CLEAR
QUAD_GANTRY_LEVEL
G1 X125 Y125 Z5 F6000
#the original gcode
BASE_BED_MESH_CALIBRATE
#after the original gcode
{% endraw %}