diff --git a/docs/installation.md b/docs/installation.md index 3297e948..00192b4e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -245,6 +245,12 @@ wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/v0 ``` Now it should be possible to open the interface: `http:///`. +### Important macros +if you want to get the full experience with mainsail and klipper virtual_sdcard print, +you should use these macros, or use them as templates for your own. + +[Link to the macros doc](macros.md) + ### Change the Hostname (optional) to use the hostname instate of the ip, you can install the avahi-daemon: ``` diff --git a/docs/macros.md b/docs/macros.md index e380bf46..d1fa2092 100644 --- a/docs/macros.md +++ b/docs/macros.md @@ -1,15 +1,40 @@ # Useful macros for Moonraker/Mainsail -These macros are important for pause/resume/cancel. - +## pause / resume / cancel ``` +#is required to load the pause_resume module in klipper [pause_resume] +[gcode_macro PAUSE] +rename_existing: BASE_PAUSE +default_parameter_X: 230 #edit to your park position +default_parameter_Y: 230 #edit to your park position +default_parameter_Z: 10 #edit to your park position +default_parameter_E: 1 #edit to your retract length +gcode: + SAVE_GCODE_STATE NAME=PAUSE_state + BASE_PAUSE + G91 + G1 E-{E} F2100 + G1 Z{Z} + G90 + G1 X{X} Y{Y} F6000 + +[gcode_macro RESUME] +rename_existing: BASE_RESUME +default_parameter_E: 1 #edit to your retract length +gcode: + G91 + G1 E{E} F2100 + G90 + RESTORE_GCODE_STATE NAME=PAUSE_state MOVE=1 + BASE_RESUME + [gcode_macro CANCEL_PRINT] rename_existing: BASE_CANCEL_PRINT -default_parameter_X: 230 -default_parameter_Y: 230 -default_parameter_Z: 10 +default_parameter_X: 230 #edit to your park position +default_parameter_Y: 230 #edit to your park position +default_parameter_Z: 10 #edit to your park position gcode: M104 S0 M140 S0 @@ -18,28 +43,19 @@ gcode: CLEAR_PAUSE SDCARD_RESET_FILE BASE_CANCEL_PRINT +``` -[gcode_macro PAUSE] -rename_existing: BASE_PAUSE -default_parameter_X: 230 -default_parameter_Y: 230 -default_parameter_Z: 10 +## customize klipper default commands +for example, if you want to adjust the BED_MESH_CALIBRATE command, which will execute under "heightmap > calibrate". +``` +[gcode_macro BED_MESH_CALIBRATE] +rename_existing: BASE_BED_MESH_CALIBRATE gcode: - SAVE_GCODE_STATE NAME=PAUSE_state - BASE_PAUSE - G91 - G1 E-1.7 F2100 - G1 Z{Z} - G90 - G1 X{X} Y{Y} F6000 - G91 - -[gcode_macro RESUME] -rename_existing: BASE_RESUME -gcode: - G91 - G1 E1.7 F2100 - G91 - RESTORE_GCODE_STATE NAME=PAUSE_state MOVE=1 - BASE_RESUME + #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 ``` \ No newline at end of file