diff --git a/setup/configuration.md b/setup/configuration.md index 07c2a1d..e78779f 100644 --- a/setup/configuration.md +++ b/setup/configuration.md @@ -1,10 +1,13 @@ -# Configuration +--- +description: >- + 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). +--- -{% hint style="warning" %} -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). -{% endhint %} +# Configuration -## Required +## Fast way (mainsail.cfg) The following configuration elements are required and must be configured for Mainsail to function properly. In **MainsailOS** they are stored by default in [mainsail.cfg](https://github.com/mainsail-crew/mainsail-config/blob/master/client.cfg) and only need to be included in `printer.cfg`. @@ -16,6 +19,12 @@ This ensures that your printer config file includes the mainsail.cfg. If you are [include mainsail.cfg] ``` +## Manual way + +{% hint style="info" %} +This step is not necessary if you are already using mainsail.cfg. +{% endhint %} + ### Virtual SD Card The `Virtual SD Card` allows G-Code file uploads. @@ -41,9 +50,7 @@ These macros enable pause and resume in Klipper. [pause_resume] ``` -### Macros - -#### Add pause / resume / cancel functionality +#### Add pause / resume / cancel macros You can modify the below macros to fit your needs. @@ -63,8 +70,8 @@ rename_existing: RESUME_BASE gcode: ##### read extrude from _TOOLHEAD_PARK_PAUSE_CANCEL macro ##### -{% raw %} - {% set extrude = printer['gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL'].extrude %} + {% raw %} +{% set extrude = printer['gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL'].extrude %} #### get VELOCITY parameter if specified #### {% if 'VELOCITY' in params|upper %} {% set get_params = ('VELOCITY=' + params.VELOCITY) %} @@ -82,6 +89,7 @@ gcode: {% endraw %} + RESUME_BASE {get_params} ``` @@ -93,13 +101,14 @@ variable_park: True gcode: ## Move head and retract only if not already in the pause state and park set to true -{% raw %} - {% if printer.pause_resume.is_paused|lower == 'false' and park|lower == 'true'%} + {% raw %} +{% if printer.pause_resume.is_paused|lower == 'false' and park|lower == 'true'%} _TOOLHEAD_PARK_PAUSE_CANCEL {% endif %} {% endraw %} + TURN_OFF_HEATERS CANCEL_PRINT_BASE ``` @@ -112,8 +121,8 @@ gcode: ##### set park positon for x and y ##### # default is your max posion from your printer.cfg -{% raw %} - {% set x_park = printer.toolhead.axis_maximum.x|float - 5.0 %} + {% raw %} +{% set x_park = printer.toolhead.axis_maximum.x|float - 5.0 %} {% set y_park = printer.toolhead.axis_maximum.y|float - 5.0 %} {% set z_park_delta = 2.0 %} ##### calculate save lift position #####