Skip to content

Commit

Permalink
docs: fix typos in mainsail.cfg comments and README.md
Browse files Browse the repository at this point in the history
A big Thank you to @JamShady and @GDRPrint to provide them.

Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
  • Loading branch information
zellneralex committed Jan 14, 2023
1 parent b969149 commit f39600a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Mainsail klipper macros and settings

This is the new location of the macros and settings provided by the Mainsail team. The intent is to enable all user to setup important macros and settings needed by the mainsail UI.
This is the new location of the macros and settings provided by the Mainsail team. The intent is to enable all users to setup important macros and settings needed by the mainsail UI.

### Important features
- Park position depending on printer kinematics or user preference
- Round beds 0:Ymax
- Square beds Xmax:Ymax
- User Position
- PAUSE now supports option input parameters [X,Y,Z_MIN]
- That is helpfule to direct use the PAUSE macro in your M600 (see the mainsail.cfg for an example)
- Customization via a simgl macro that contains all allowed variables
- Additional custom variables for stuff like extra retact at CANCLE_PRINT.
- That is helpful to direct the use of the PAUSE macro in your M600 (see the mainsail.cfg for an example)
- Customization via a single macro that contains all allowed variables
- Additional custom variables for stuff like extra retract at CANCEL_PRINT.

### Why have we decided to use a dedicated repo?
There are 2 main reasons for that decision
1) The current moonraker changes have shown that we need to react very fast on changes.
2) We regular improve the macros and that is the simplest way that also the installed base can benefit from it.
2) We regularly improve the macros and that is the simplest way that the installed base can benefit from it.

### How to install
We currently do not provide an installer and we might never do. But doing it is simple copy and paste a few commands in a ssh terminal
We currently do not provide an installer and we might never do. But doing it is simple copy and paste a few commands in an ssh terminal.
The instructions assume that you have a up to data and working moonraker installation. If not start with updating your moonraker first.

```
Expand Down
6 changes: 2 additions & 4 deletions mainsail.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
##
## This file may be distributed under the terms of the GNU GPLv3 license

## Version 2.0

## add [include mainsail.cfg] to your printer.cfg

## Customization:
Expand Down Expand Up @@ -36,7 +34,7 @@
#description: Filament change
#gcode: PAUSE X=10 Y=10 Z_MIN=50

## That will park your head front left with a minimum hight of 50mm above the bed. If your head
## That will park your head front left with a minimum height of 50mm above the bed. If your head
## is already above 50mm it will use only the z_hop specified with dz.

[virtual_sdcard]
Expand Down Expand Up @@ -132,7 +130,7 @@ gcode:
##### get config and toolhead values #####
{% set act = printer.toolhead.position %}
{% set max = printer.toolhead.axis_maximum %}
{% set cone = printer.toolhead.cone_start_z|default(max.z) %} ; hight as long the toolhead can reach max and min of an delta
{% set cone = printer.toolhead.cone_start_z|default(max.z) %} ; height as long the toolhead can reach max and min of an delta
{% set round_bed = True if printer.configfile.settings.printer.kinematics is in ['delta','polar','rotary_delta','winch']
else False %}
##### define park position #####
Expand Down

0 comments on commit f39600a

Please sign in to comment.