Skip to content

Commit e38cd16

Browse files
committed
update documentation
1 parent 6256a53 commit e38cd16

37 files changed

+579
-95
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "marlin-conf",
3-
"version": "2.10.4",
3+
"version": "2.10.5",
44
"description": "configuration tool for Marlin project",
55
"main": "./index.js",
66
"scripts": {

views/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -703,7 +703,7 @@ Both acceleration and jerk affect your print quality. If jerk is too low, the ex
703703
```cpp
704704
//#define Z_MIN_PROBE_ENDSTOP
705705
```
706-
Use this option if you've connected the probe to a pin other than the Z MIN endstop pin. With this option enabled, by default Marlin will assume the probe is connected to the Z MAX endstop pin (since this is the most likely to be unused). If you need to use a different pin, you can set a custom pin number for `Z_MIN_PROBE_PIN` in `Configuration.h`.
706+
Use this option if you've connected the probe to a pin other than the Z MIN endstop pin. With this option enabled, by default Marlin will use the `Z_MIN_PROBE_PIN` specified in your board's pins file (usually the X or Z MAX endstop pin since these are the most likely to be unused). If you need to use a different pin, define your custom pin number for `Z_MIN_PROBE_PIN` in `Configuration.h`.
707707

708708
```cpp
709709
#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN

views/gcode/G010.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ codes:
1515
long:
1616
- Retract the filament according to settings of [`M207`](/docs/gcode/M207.html).
1717
- Firmware retraction allows you to tune retraction at the machine level and can significantly reduce the size of G-code files.
18+
- Multiple consecutive `G10` or `G10 S1` commands without a corresponding `G11` or `G11 S1` will be ignored.
19+
- "Performs two moves: a retract move at the retract feedrate/acceleration, and an optional Z lift at the maximum Z feedrate (travel acceleration)."
1820

1921
notes:
2022
- Requires `FWRETRACT`.

views/gcode/G011.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ group: planner
1212
codes:
1313
- G11
1414

15-
long: Unretract (i.e., recover, prime) the filament according to settings of [`M208`](/docs/gcode/M208.html).
15+
long:
16+
- Unretract (i.e., recover, prime) the filament according to settings of [`M208`](/docs/gcode/M208.html).
17+
- Multiple consecutive `G11` or `G11 S1` commands without a corresponding `G10` or `G10 S1` will be ignored.
18+
- "Performs two moves: An optional Z lower at the maximum Z feedrate (travel acceleration), and a recovery move at the recover feedrate (retract acceleration)."
1619

1720
notes:
1821
- Requires `FWRETRACT`.

views/gcode/G012.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ codes:
1212
- G12
1313

1414
long:
15-
- Start the nozzle cleaning process. Two types of cleaning patterns are supported: stroke-based and zigzag-based. This feature requires a dedicated cleaning area on or outside the bed, but within reach of the nozzle.
15+
- Start the nozzle cleaning process. Three types of cleaning patterns are supported: straight strokes, zigzags and circles. This feature requires a dedicated cleaning area on or outside the bed, but within reach of the nozzle. The patten may be repeated as many times as desired.
1616

1717
notes:
18-
- Default behavior is defined by `NOZZLE_CLEAN_STROKES`, `NOZZLE_CLEAN_START_POINT`, `NOZZLE_CLEAN_END_POINT` and `NOZZLE_CLEAN_PARK`.
19-
- With `NOZZLE_CLEAN_PARK` enabled, the nozzle automatically returns to the XYZ position before `G12`.
18+
- Default behavior is defined by `NOZZLE_CLEAN_STROKES`, `NOZZLE_CLEAN_START_POINT`, `NOZZLE_CLEAN_END_POINT`, `NOZZLE_CLEAN_TRIANGLES`, `NOZZLE_CLEAN_CIRCLE_MIDDLE`, `NOZZLE_CLEAN_CIRCLE_RADIUS` and `NOZZLE_CLEAN_GOBACK`.
19+
- With `NOZZLE_CLEAN_GOBACK` enabled, the nozzle automatically returns to the XYZ position before `G12`.
2020

2121
parameters:
2222
-
@@ -26,12 +26,25 @@ parameters:
2626
values:
2727
-
2828
tag: 0
29+
description: Stroke straight back and forth
2930
-
3031
tag: 1
32+
description: Move in a zigzag pattern
33+
-
34+
tag: 2
35+
description: Move in a circular pattern
36+
-
37+
tag: R
38+
optional: true
39+
description: Radius of nozzle cleaning circle
40+
values:
41+
-
42+
tag: radius
43+
type: float
3144
-
3245
tag: S
3346
optional: true
34-
description: Number of strokes (i.e. back-and-forth movements)
47+
description: Number of repetitions of the pattern
3548
values:
3649
-
3750
tag: count
@@ -40,7 +53,7 @@ parameters:
4053
tag: T
4154
type: int
4255
optional: true
43-
description: Number of repetitions
56+
description: Number of triangles in the zigzag pattern
4457
values:
4558
-
4659
tag: count
@@ -53,5 +66,8 @@ examples:
5366
-
5467
pre: To generate a three triangle zig-zag pattern which will be stroked one time use the following command.
5568
code: G12 P1 S1 T3 ; zig-zag pattern with 3 triangles
69+
-
70+
pre: To generate a 10mm radius circle which will be stroked one time use the following command.
71+
code: G12 P2 S1 R10 ; 10mm circle
5672

5773
---

views/gcode/G028.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ brief: Auto home one or more axes.
55
author: thinkyhead
66

77
experimental: false
8-
since: 1.0.0-beta
98
group: calibration
109

1110
codes:
@@ -19,6 +18,16 @@ notes:
1918
- If homing is needed the LCD will blink the X Y Z indicators.
2019

2120
parameters:
21+
-
22+
tag: O
23+
type: boolean
24+
optional: true
25+
description: Optional. If the position is known then exit without homing. (1.1.9)
26+
-
27+
tag: R
28+
type: float
29+
optional: true
30+
description: Raise before homing distance (1.1.9)
2231
-
2332
tag: X
2433
type: boolean

views/gcode/G029-abl.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ brief: Probe the bed and enable leveling compensation.
55
author: thinkyhead
66

77
experimental: false
8-
since: 1.0.0-beta
98
requires: AUTO_BED_LEVELING_(3POINT|LINEAR|BILINEAR)
109
group: calibration
1110

@@ -95,6 +94,11 @@ parameters:
9594
values:
9695
-
9796
type: bool
97+
-
98+
tag: O
99+
type: boolean
100+
optional: true
101+
description: Optional. If leveling is already enabled then exit without leveling. (1.1.9)
98102
-
99103
tag: Q
100104
optional: true

views/gcode/G029-mbl.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ author: thinkyhead
66

77
experimental: false
88
requires: MESH_BED_LEVELING
9-
since: 1.0.0-beta
109
group: calibration
1110

1211
codes:

views/gcode/G033.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ parameters:
2626
tag: P
2727
optional: true
2828
values:
29+
-
30+
tag: -1
31+
description: Check the z-offset with a center probe and paper test.
2932
-
3033
tag: 0
3134
description: Normalize end-stops and tower angle corrections only (no probing).
@@ -77,18 +80,18 @@ parameters:
7780
-
7881
default: 1
7982
-
80-
tag: A
83+
tag: E
8184
optional: true
82-
description: Auto tune calibration factors.
85+
description: Engage the probe for each point.
8386
values:
8487
-
8588
type: bool
8689
-
8790
default: 0
8891
-
89-
tag: E
92+
tag: S
9093
optional: true
91-
description: Engage the probe for each point.
94+
description: Setup mode - disables probe protection.
9295
values:
9396
-
9497
type: bool

views/gcode/G042.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
tag: g42
3+
title: Move to mesh coordinate
4+
brief: Move to a specific point in the leveling mesh
5+
author: ManuelMcLure
6+
7+
experimental: false
8+
since: 1.1.2
9+
requires: HAS_MESH
10+
group: calibration
11+
12+
codes:
13+
- G42
14+
15+
long: |
16+
The `G42` command moves the nozzle to the location corresponding to a specific coordinate in the bed leveling mesh. It operates similarly to the `G0` and `G1` commands except that the provided coordinates are a mesh row and column instead of an absolute or relative position on the bed.
17+
18+
The `G42` command will determine the bed position that corresponds to the provided mesh row and column and move the nozzle to that position.
19+
20+
parameters:
21+
-
22+
tag: I
23+
optional: true
24+
description: The column of the mesh coordinate
25+
values:
26+
-
27+
tag: pos
28+
type: float
29+
-
30+
tag: J
31+
optional: true
32+
description: The row of the mesh coordinate
33+
values:
34+
-
35+
tag: pos
36+
type: float
37+
-
38+
tag: F
39+
optional: true
40+
description: The maximum movement rate of the move between the start and end point. The feedrate set here applies to subsequent moves that omit this parameter.
41+
values:
42+
-
43+
tag: rate
44+
type: float
45+
46+
examples:
47+
-
48+
pre: Move to various points on a 9x9 mesh
49+
code:
50+
- G42 I0 J0 ; front left corner
51+
- G42 I4 J4 ; center
52+
- G42 I4 J8 ; back center
53+
- G42 I8 J8 ; back right
54+
55+
---

0 commit comments

Comments
 (0)