Skip to content

Commit 0570fd8

Browse files
committed
documentation updated
1 parent 4acfca0 commit 0570fd8

File tree

12 files changed

+1174
-69
lines changed

12 files changed

+1174
-69
lines changed

views/configuration.md

Lines changed: 998 additions & 55 deletions
Large diffs are not rendered by default.

views/gcode/G005.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ parameters:
3636
-
3737
tag: pos
3838
type: float
39+
-
40+
tag: E
41+
optional: true
42+
description: The length of filament to feed into the extruder between the start and end point
43+
values:
44+
-
45+
tag: pos
46+
type: float
3947
-
4048
tag: I
4149
optional: false

views/gcode/G026.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,22 @@ title: Mesh Validation Pattern
44
brief: Test the mesh and adjust.
55

66
experimental: true
7-
requires: AUTO_BED_LEVELING_UBL,UBL_G26_MESH_EDITING
7+
since: 1.1.0
8+
requires: HAS_MESH,G26_MESH_VALIDATION
89
group: calibration
910

1011
codes:
1112
- G26
1213

1314
long:
1415
- |
15-
`G26` Mesh Validation Pattern is designed to be used in conjunction with mesh-based leveling to test the accuracy of the probed mesh. This feature is currently only implemented for [Unified Bed Leveling](/docs/features/unified_bed_leveling.html), so `AUTO_BED_LEVELING_UBL` is required.
16+
`G26` Mesh Validation Pattern is designed to be used in conjunction with mesh-based leveling to test the accuracy of the probed mesh.
1617
1718
The `G26` command prints a single-layer pattern over the entire print bed, giving a clear indication of how accurately every mesh point is defined. `G26` can be used to determine which areas of the mesh are less-than-perfect and how much to adjust each mesh point.
1819
19-
notes: Requires `AUTO_BED_LEVELING_UBL` and `UBL_G26_MESH_EDITING`.
20+
notes: |
21+
- Before 1.1.6 requires `UBL_G26_MESH_VALIDATION` and `AUTO_BED_LEVELING_UBL`.
22+
- Since 1.1.7 requires `G26_MESH_VALIDATION` and `HAS_MESH` (`AUTO_BED_LEVELING_UBL`, `MESH_BED_LEVELING`, or `AUTO_BED_LEVELING_BILINEAR`).
2023
2124
parameters:
2225
-

views/gcode/G029-abl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ parameters:
165165
description: Dry-Run mode. Just probe the grid but don't update the bed leveling data
166166
values:
167167
-
168-
tag: flag
168+
type: bool
169169
-
170170
tag: V
171171
optional: true
@@ -188,7 +188,7 @@ parameters:
188188
description: Generate a Bed Topology Report (`AUTO_BED_LEVELING_LINEAR`)
189189
values:
190190
-
191-
tag: flag
191+
type: bool
192192
-
193193
tag: F
194194
optional: true

views/gcode/G029-ubl.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,15 +81,15 @@ parameters:
8181
optional: true
8282
description: |
8383
- With a value (v), do _Square Grid_ probing of v x v points.
84-
- With no value, do _Three Point_ probing.
84+
- With no value, do _Three Point_ probing - e.g. to adjust a loaded mesh to match slight bed misalignment.
8585
values:
8686
-
8787
type: int
8888
-
8989
tag: K
9090
optional: true
9191
description: |
92-
**Kompare**: Subtract the stored mesh with the given index from the current mesh.
92+
**Kompare**: Subtract the stored mesh with the given index from the current mesh. This operates on the mesh in-memory, so it will probably invalidate the active mesh for purposes of printing.
9393
values:
9494
-
9595
unit: index
@@ -122,7 +122,7 @@ parameters:
122122
-
123123
tag: 3
124124
description: |
125-
**Fill Unpopulated** regions of the Mesh with a fixed value (`C` or ).
125+
**Fill Unpopulated** regions of the Mesh with a fixed value (`C`) or use 'smart fill' to extrapolate from already probed points (`no argument`).
126126
-
127127
tag: 4
128128
description: |
@@ -219,5 +219,39 @@ parameters:
219219
unit: linear
220220

221221
examples:
222+
-
223+
pre: This is a minimal 'quick-start' sequence for set-up and initial probing of a UBL mesh on a machine that includes a display and z-probe
224+
code:
225+
- M502 ; Reset settings to configuration defaults...
226+
- M500 ; ...and Save to EEPROM. Use this on a new install.
227+
- M501 ; Read back in the saved EEPROM.
228+
229+
- M190 S65 ; Not required, but having the printer at temperature helps accuracy
230+
- M104 S210 ; Not required, but having the printer at temperature helps accuracy
231+
232+
- G28 ; Home XYZ.
233+
- G29 P1 ; Do automated probing of the bed.
234+
- G29 P2 B T ; Manual probing of locations USUALLY NOT NEEDED!!!!
235+
- G29 P3 T ; Repeat until all mesh points are filled in.
236+
237+
- G29 T ; View the Z compensation values.
238+
- G29 S1 ; Save UBL mesh points to EEPROM.
239+
- G29 F 10.0 ; Set Fade Height for correction at 10.0 mm.
240+
- G29 A ; Activate the UBL System.
241+
- M500 ; Save current setup. WARNING - UBL will be active at power up, before any `G28`.
242+
-
243+
pre: Use `G26` and `G29` commands to fine-tune a measured mesh
244+
code:
245+
- G26 C P T3.0 ; Produce mesh validation pattern with primed nozzle.
246+
- ; NOTE - PLA temperatures are assumed unless you specify - e.g. - B 105 H 225 for ABS Plastic
247+
- G29 P4 T ; Move nozzle to 'bad' areas and fine tune the values if needed.
248+
- ; Repeat G26 and G29 P4 T commands as needed.
249+
- G29 S1 ; Save UBL mesh values to EEPROM.
250+
- M500 ; Resave UBL's state information.
251+
-
252+
pre: Use 3-point probe to 'tilt' a stored mesh; e.g. in your startup script
253+
code:
254+
- G29 L1 ; Load the mesh stored in slot 1 (from G29 S1)
255+
- G29 J ; No size specified on the J option tells G29 to probe the specified 3 points and tilt the mesh according to what it finds.
222256

223257
---

views/gcode/G030.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ parameters:
3131
-
3232
tag: pos
3333
type: float
34+
-
35+
tag: E
36+
optional: true
37+
description: Engage the probe for each point.
38+
values:
39+
-
40+
type: bool
41+
-
42+
default: 0
3443

3544
notes:
3645

views/gcode/G033.md

Lines changed: 40 additions & 3 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: 0
31+
description: Normalize end-stops and tower angle corrections only (no probing).
2932
-
3033
tag: 1
3134
description: Probe center and set height only.
@@ -36,15 +39,29 @@ parameters:
3639
tag: 3
3740
description: Probe all positions - center, towers and opposite towers. Set all.
3841
-
39-
tag: 4-7
40-
description: Probe all positions at different locations and average them.
42+
tag: 4-10
43+
description: Probe all positions + at different itermediate locations and average them.
44+
-
45+
default: set in Configuration.h
4146
-
4247
tag: T
4348
optional: true
44-
description: Enable or disable tower angle corrections calibration (`P3`-`P7`)
49+
description: Disable tower angle corrections calibration (`P3`-`P7`)
4550
values:
4651
-
4752
type: bool
53+
-
54+
default: 0
55+
-
56+
tag: C
57+
optional: true
58+
description: If omitted iterations stop at best achievable precision; if set force iterations to stop at the set precision.
59+
values: mm
60+
-
61+
tag: F
62+
optional: true
63+
description: Force to run at least n iterations and take the best result.
64+
values: 1-30
4865
-
4966
tag: V
5067
optional: true
@@ -59,6 +76,26 @@ parameters:
5976
-
6077
tag: 2
6178
description: Report settings and probe results
79+
-
80+
default: 1
81+
-
82+
tag: A
83+
optional: true
84+
description: Auto tune calibration factors.
85+
values:
86+
-
87+
type: bool
88+
-
89+
default: 0
90+
-
91+
tag: E
92+
optional: true
93+
description: Engage the probe for each point.
94+
values:
95+
-
96+
type: bool
97+
-
98+
default: 0
6299

63100
notes:
64101

views/gcode/M111.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ examples:
4545
-
4646
pre: Enable everything except dry-run mode
4747
code: M111 S247 ; 255 - 8
48+
-
49+
pre: Disable previously set extra debugging output.
50+
code: M111 S0
4851

4952
---
5053

views/gcode/M203.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ parameters:
6161
examples:
6262
-
6363
pre: 'Set max feedrate for XY to 100mm/s:'
64-
code: M203 X6000 Y6000
64+
code: M203 X100 Y1000
6565

6666
---
6767

views/gcode/M220.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ group: planner
1010
codes:
1111
- M220
1212

13-
long: Set the feedrate percentage, which applies to all G-code-based moves.
13+
long: Set the feedrate percentage, which applies to all G-code-based moves in all (X, Y, Z, and E) axes.
1414

1515
notes:
1616

0 commit comments

Comments
 (0)