update documentation

package.json

@@ -1,6 +1,6 @@
 {
   "name": "marlin-conf",
-  "version": "2.10.4",
+  "version": "2.10.5",
   "description": "configuration tool for Marlin project",
   "main": "./index.js",
   "scripts": {

views/configuration.md

@@ -703,7 +703,7 @@ Both acceleration and jerk affect your print quality. If jerk is too low, the ex
 ```cpp
 //#define Z_MIN_PROBE_ENDSTOP
 ```
-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`.
+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`.
 
 ```cpp
 #define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN

views/gcode/G010.md

@@ -15,6 +15,8 @@ codes:
 long: 
   - Retract the filament according to settings of [`M207`](/docs/gcode/M207.html).
   - Firmware retraction allows you to tune retraction at the machine level and can significantly reduce the size of G-code files.
+  - Multiple consecutive `G10` or `G10 S1` commands without a corresponding `G11` or `G11 S1` will be ignored.
+  - "Performs two moves: a retract move at the retract feedrate/acceleration, and an optional Z lift at the maximum Z feedrate (travel acceleration)."
 
 notes:
   - Requires `FWRETRACT`.

views/gcode/G011.md

@@ -12,7 +12,10 @@ group: planner
 codes:
   - G11
 
-long: Unretract (i.e., recover, prime) the filament according to settings of [`M208`](/docs/gcode/M208.html).
+long:
+  - Unretract (i.e., recover, prime) the filament according to settings of [`M208`](/docs/gcode/M208.html).
+  - Multiple consecutive `G11` or `G11 S1` commands without a corresponding `G10` or `G10 S1` will be ignored.
+  - "Performs two moves: An optional Z lower at the maximum Z feedrate (travel acceleration), and a recovery move at the recover feedrate (retract acceleration)."
 
 notes:
   - Requires `FWRETRACT`.

views/gcode/G012.md

@@ -12,11 +12,11 @@ codes:
   - G12
 
 long:
-  - 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.
+  - 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.
 
 notes:
-  - Default behavior is defined by `NOZZLE_CLEAN_STROKES`, `NOZZLE_CLEAN_START_POINT`, `NOZZLE_CLEAN_END_POINT` and `NOZZLE_CLEAN_PARK`.
-  - With `NOZZLE_CLEAN_PARK` enabled, the nozzle automatically returns to the XYZ position before `G12`.
+  - 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`.
+  - With `NOZZLE_CLEAN_GOBACK` enabled, the nozzle automatically returns to the XYZ position before `G12`.
 
 parameters:
   -
@@ -26,12 +26,25 @@ parameters:
     values:
       -
         tag: 0
+        description: Stroke straight back and forth
       -
         tag: 1
+        description: Move in a zigzag pattern
+      -
+        tag: 2
+        description: Move in a circular pattern
+  -
+    tag: R
+    optional: true
+    description: Radius of nozzle cleaning circle
+    values:
+      -
+        tag: radius
+        type: float
   -
     tag: S
     optional: true
-    description: Number of strokes (i.e. back-and-forth movements)
+    description: Number of repetitions of the pattern
     values:
       -
         tag: count
@@ -40,7 +53,7 @@ parameters:
     tag: T
     type: int
     optional: true
-    description: Number of repetitions
+    description: Number of triangles in the zigzag pattern
     values:
       -
         tag: count
@@ -53,5 +66,8 @@ examples:
   -
     pre: To generate a three triangle zig-zag pattern which will be stroked one time use the following command.
     code: G12 P1 S1 T3 ; zig-zag pattern with 3 triangles
+  -
+    pre: To generate a 10mm radius circle which will be stroked one time use the following command.
+    code: G12 P2 S1 R10 ; 10mm circle
 
 ---

views/gcode/G028.md

@@ -5,7 +5,6 @@ brief: Auto home one or more axes.
 author: thinkyhead
 
 experimental: false
-since: 1.0.0-beta
 group: calibration
 
 codes:
@@ -19,6 +18,16 @@ notes:
   - If homing is needed the LCD will blink the X Y Z indicators.
 
 parameters:
+  -
+    tag: O
+    type: boolean
+    optional: true
+    description: Optional. If the position is known then exit without homing. (1.1.9)
+  -
+    tag: R
+    type: float
+    optional: true
+    description: Raise before homing distance (1.1.9)
   -
     tag: X
     type: boolean

views/gcode/G029-abl.md

@@ -5,7 +5,6 @@ brief: Probe the bed and enable leveling compensation.
 author: thinkyhead
 
 experimental: false
-since: 1.0.0-beta
 requires: AUTO_BED_LEVELING_(3POINT|LINEAR|BILINEAR)
 group: calibration
 
@@ -95,6 +94,11 @@ parameters:
     values:
       -
         type: bool
+  -
+    tag: O
+    type: boolean
+    optional: true
+    description: Optional. If leveling is already enabled then exit without leveling. (1.1.9)
   -
     tag: Q
     optional: true

views/gcode/G029-mbl.md

@@ -6,7 +6,6 @@ author: thinkyhead
 
 experimental: false
 requires: MESH_BED_LEVELING
-since: 1.0.0-beta
 group: calibration
 
 codes:

views/gcode/G033.md

@@ -26,6 +26,9 @@ parameters:
     tag: P
     optional: true
     values:
+      -
+        tag: -1
+        description: Check the z-offset with a center probe and paper test.
       -
         tag: 0
         description: Normalize end-stops and tower angle corrections only (no probing).
@@ -77,18 +80,18 @@ parameters:
       -
         default: 1
   -
-    tag: A
+    tag: E
     optional: true
-    description: Auto tune calibration factors.
+    description: Engage the probe for each point.
     values:
       -
         type: bool
       -
         default: 0
   -
-    tag: E
+    tag: S
     optional: true
-    description: Engage the probe for each point.
+    description: Setup mode - disables probe protection.
     values:
       -
         type: bool

views/gcode/G042.md

@@ -0,0 +1,55 @@
+---
+tag: g42
+title: Move to mesh coordinate
+brief: Move to a specific point in the leveling mesh
+author: ManuelMcLure
+
+experimental: false
+since: 1.1.2
+requires: HAS_MESH
+group: calibration
+
+codes:
+  - G42
+
+long: |
+    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.
+
+    The `G42` command will determine the bed position that corresponds to the provided mesh row and column and move the nozzle to that position.
+
+parameters:
+  -
+    tag: I
+    optional: true
+    description: The column of the mesh coordinate
+    values:
+      -
+        tag: pos
+        type: float
+  -
+    tag: J
+    optional: true
+    description: The row of the mesh coordinate
+    values:
+      -
+        tag: pos
+        type: float
+  -
+    tag: F
+    optional: true
+    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.
+    values:
+      -
+        tag: rate
+        type: float
+
+examples:
+  -
+    pre: Move to various points on a 9x9 mesh
+    code:
+      - G42 I0 J0	; front left corner
+      - G42 I4 J4	; center
+      - G42 I4 J8	; back center
+      - G42 I8 J8	; back right
+
+---

views/gcode/M023.md

@@ -17,6 +17,10 @@ notes:
   - Requires [`SDSUPPORT`](/docs/configuration/configuration.html#sd-card)
 
 parameters:
+  -
+    tag: filename
+    optional: false
+    description: The filename of the file to open.
 
 examples:
 

views/gcode/M024.md

@@ -11,12 +11,31 @@ group: sdcard
 codes:
   - M24
 
-long: Start an SD print or resume the paused SD print. If `PARK_HEAD_ON_PAUSE` is enabled, unpark the nozzle.
+long: |
+    Start an SD print or resume the paused SD print. If `PARK_HEAD_ON_PAUSE` is enabled, unpark the nozzle.
+
+    If `POWER_LOSS_RECOVERY` is enabled `M24` accepts parameters which allow resuming the print from a specific point in the file. These parameters are usually only used in this scenario.
 
 notes:
   - Requires [`SDSUPPORT`](/docs/configuration/configuration.html#sd-card)
 
 parameters:
+  -
+    tag: S
+    optional: true
+    description: Position in file to resume from (requires `POWER_LOSS_RECOVERY`)
+    values:
+      -
+        tag: pos
+        type: long
+  -
+    tag: T
+    optional: true
+    description: Elapsed time since start of print (requires `POWER_LOSS_RECOVERY`)
+    values:
+      -
+        tag: time
+        type: long
 
 examples:
 

views/gcode/M026.md

@@ -17,6 +17,14 @@ notes:
   - Requires [`SDSUPPORT`](/docs/configuration/configuration.html#sd-card)
 
 parameters:
+  -
+    tag: S
+    optional: true
+    description: Next file read position to set
+    values:
+      -
+        tag: pos
+        type: long
 
 examples:
 

views/gcode/M030.md

@@ -16,7 +16,10 @@ notes:
   - Requires [`SDSUPPORT`](/docs/configuration/configuration.html#sd-card)
 
 parameters:
-  - filename
+  -
+    tag: filename
+    optional: false
+    description: The filename of the file to delete.
 
 example:
   -

views/gcode/M106.md

@@ -39,7 +39,7 @@ parameters:
     optional: true
     description: |
       Secondary speed. Added in Marlin 1.1.7. (Requires `EXTRA_FAN_SPEED`)
-      - '`M106 P<fan> T3-255` sets a secondary speed for <fan>.'
+      - '`M106 P<fan> T3-255` sets a secondary speed for `<fan>`.'
       - '`M106 P<fan> T2` uses the set secondary speed.'
       - '`M106 P<fan> T1` restores the previous fan speed.'
     values:

views/gcode/M114.md

@@ -10,11 +10,22 @@ group: hosts
 codes:
   - M114
 
-long: Get the current position of the active nozzle. Includes stepper values.
+long: |
+    Get the current position of the active nozzle. Includes stepper values.
+    If `M114_DETAIL` is enabled the `D` parameter will provide more details such as leveling information and kinematics.
 
 notes: Hosts should respond to the output of `M114` by updating their current position.
 
 parameters:
+  -
+    tag: D
+    optional: true
+    description: Detailed information (requires `M114_DETAIL`)
+    values:
+      -
+        type: bool
+      -
+        default: 0
 
 examples:
   -

views/gcode/M119.md

@@ -12,16 +12,24 @@ codes:
 
 long:
   - Use this command to get the current state of all endstops, useful for setup and troubleshooting. Endstops are reported as either "`open`" or "`TRIGGERED`".
-  - The state of the Z probe is also reported.
+  - The state of the Z probe and filament runout sensors are also reported with this command.
 
 notes:
+  - The `BLTOUCH` probe only sends a brief pulse, so "`TRIGGERED`" indicates the probe is in error state.
+  - Similarly, Trinamic's Sensorless Homing only sends a short pulse, so for these "`TRIGGERED`" is unusual.
 
 parameters:
 
-examples:
+example:
   -
     pre: Get all endstop states
-    code: M119
+    code: |
+          > M119
+          Reporting endstop status
+          x_min: open
+          y_min: open
+          z_min: TRIGGERED
+          z_probe: open
+          filament: open
 
 ---
-

views/gcode/M126.md

@@ -16,6 +16,14 @@ long: Open the valve for Baricuda paste extruder 1.
 notes: Requires `BARICUDA`.
 
 parameters:
+  -
+    tag: S
+    optional: true
+    description: Valve pressure
+    values:
+      -
+        tag: pressure
+        type: byte
 
 examples:
   -