-
-
Notifications
You must be signed in to change notification settings - Fork 363
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
46 changed files
with
16,435 additions
and
16,419 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,140 +1,140 @@ | ||
--- | ||
layout: default | ||
title: Configuration | ||
nav_order: 5 | ||
has_children: false | ||
permalink: /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: | ||
|
||
* [Virtual SD Card](configuration#virtual_sdcard) | ||
* [Display Status](configuration#display_status) | ||
* [Pause / Resume](configuration#pause_resume) | ||
* [GCode Macros](configuration#pause--resume--cancel) | ||
|
||
The following configuration elements are optional, including making tweaks and alterations to Klipper's default commands: | ||
* [Custom Commands](configuration#customisation) | ||
|
||
## Virtual SD Card | ||
The `Virtual SD Card` allows gcode file uploads. | ||
```yaml | ||
[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. | ||
```yaml | ||
[display_status] | ||
``` | ||
|
||
## Pause, Resume, Cancel | ||
These macros enable pause and resume in Klipper. | ||
|
||
```yaml | ||
[pause_resume] | ||
``` | ||
|
||
# Macros | ||
## Add pause / resume / cancel functionality | ||
You can modify the below macros to fit your needs. | ||
{% raw %} | ||
```yaml | ||
[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 %} | ||
``` | ||
|
||
```yaml | ||
[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} | ||
``` | ||
|
||
|
||
```yaml | ||
[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 %} | ||
```yaml | ||
[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 %} | ||
--- | ||
layout: default | ||
title: Configuration | ||
nav_order: 5 | ||
has_children: false | ||
permalink: /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: | ||
|
||
* [Virtual SD Card](configuration#virtual_sdcard) | ||
* [Display Status](configuration#display_status) | ||
* [Pause / Resume](configuration#pause_resume) | ||
* [GCode Macros](configuration#pause--resume--cancel) | ||
|
||
The following configuration elements are optional, including making tweaks and alterations to Klipper's default commands: | ||
* [Custom Commands](configuration#customisation) | ||
|
||
## Virtual SD Card | ||
The `Virtual SD Card` allows gcode file uploads. | ||
```yaml | ||
[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. | ||
```yaml | ||
[display_status] | ||
``` | ||
|
||
## Pause, Resume, Cancel | ||
These macros enable pause and resume in Klipper. | ||
|
||
```yaml | ||
[pause_resume] | ||
``` | ||
|
||
# Macros | ||
## Add pause / resume / cancel functionality | ||
You can modify the below macros to fit your needs. | ||
{% raw %} | ||
```yaml | ||
[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 %} | ||
``` | ||
|
||
```yaml | ||
[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} | ||
``` | ||
|
||
|
||
```yaml | ||
[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 %} | ||
```yaml | ||
[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 %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,46 @@ | ||
--- | ||
layout: default | ||
title: Welcome | ||
nav_order: 1 | ||
has_children: false | ||
--- | ||
|
||
# Welcome to Mainsail! | ||
Mainsail makes Klipper more accessible by adding a lightweight, responsive web user interface, centred around an intuitive and consistent design philosophy.. | ||
{: .fs-5 } | ||
|
||
[Getting Started](/setup){: .btn .btn-primary } | ||
[GitHub](https://github.com/mainsail-crew/mainsail){: .btn}{:target="_blank"} | ||
[Release Notes](https://github.com/mainsail-crew/mainsail/releases){: .btn}{:target="_blank"} | ||
|
||
## Screenshots | ||
![Dashboard](assets/img/screenshot.png) | ||
|
||
## Features | ||
- Responsive web interface, optimized for desktops, tablets and mobile devices | ||
- Supports multiple 3D printers (Printer Farm) | ||
- Localization (i18n) | ||
- File Manager (gcode and config files) | ||
- File Editor (gcode and config files) | ||
- Print History and Statistics | ||
- Temperature Presets (with custom gcode) | ||
- Bed Mesh Leveling | ||
- Multi-Webcam support | ||
- Control power devices such as relays, TPLink and Tasmota devices, and more | ||
- Customizable user interface including logos, backgrounds, and custom CSS | ||
|
||
## Help and Support | ||
Do you need help or just want to talk? Join our active community on Discord. | ||
Have you found a bug? Please create an Issue in GitHub and let us know. | ||
|
||
[Discord](https://discord.gg/skWTwTD){: .btn}{:target="_blank"} | ||
[GitHub Issues](https://github.com/mainsail-crew/mainsail/issues){: .btn}{:target="_blank"} | ||
|
||
## Support Mainsail | ||
Mainsail is primarily developed and maintained by `meteyou`. To keep the project going he invests his free time, almost every day. To motivate him (☕🍺😜) there are several ways to support him: | ||
|
||
- [Patreon (recurring)](https://patreon.com/meteyou){:target="_blank"} | ||
- [Ko-Fi (one-time)](https://ko-fi.com/mainsail){:target="_blank"} | ||
|
||
Please also support all of our maintainers and contributors. | ||
{: .info} | ||
--- | ||
layout: default | ||
title: Welcome | ||
nav_order: 1 | ||
has_children: false | ||
--- | ||
|
||
# Welcome to Mainsail! | ||
Mainsail makes Klipper more accessible by adding a lightweight, responsive web user interface, centred around an intuitive and consistent design philosophy.. | ||
{: .fs-5 } | ||
|
||
[Getting Started](/setup){: .btn .btn-primary } | ||
[GitHub](https://github.com/mainsail-crew/mainsail){: .btn}{:target="_blank"} | ||
[Release Notes](https://github.com/mainsail-crew/mainsail/releases){: .btn}{:target="_blank"} | ||
|
||
## Screenshots | ||
![Dashboard](assets/img/screenshot.png) | ||
|
||
## Features | ||
- Responsive web interface, optimized for desktops, tablets and mobile devices | ||
- Supports multiple 3D printers (Printer Farm) | ||
- Localization (i18n) | ||
- File Manager (gcode and config files) | ||
- File Editor (gcode and config files) | ||
- Print History and Statistics | ||
- Temperature Presets (with custom gcode) | ||
- Bed Mesh Leveling | ||
- Multi-Webcam support | ||
- Control power devices such as relays, TPLink and Tasmota devices, and more | ||
- Customizable user interface including logos, backgrounds, and custom CSS | ||
|
||
## Help and Support | ||
Do you need help or just want to talk? Join our active community on Discord. | ||
Have you found a bug? Please create an Issue in GitHub and let us know. | ||
|
||
[Discord](https://discord.gg/skWTwTD){: .btn}{:target="_blank"} | ||
[GitHub Issues](https://github.com/mainsail-crew/mainsail/issues){: .btn}{:target="_blank"} | ||
|
||
## Support Mainsail | ||
Mainsail is primarily developed and maintained by `meteyou`. To keep the project going he invests his free time, almost every day. To motivate him (☕🍺😜) there are several ways to support him: | ||
|
||
- [Patreon (recurring)](https://patreon.com/meteyou){:target="_blank"} | ||
- [Ko-Fi (one-time)](https://ko-fi.com/mainsail){:target="_blank"} | ||
|
||
Please also support all of our maintainers and contributors. | ||
{: .info} |
Oops, something went wrong.