Clean up obsolete GCode pages, add Do Not Edit message

Scott Lahteine 2016-03-22 18:17:20 -07:00
parent dcbbc39c7a
commit ee00347c2f
43 changed files with 218 additions and 156 deletions

5
G0.md

@ -1,5 +1,4 @@
# DO NOT EDIT **__DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [Issue #3088 "New Documentation"](https://github.com/MarlinFirmware/Marlin/issues/3088) for more information.__**
This page has been ported into the new documentation system. Please read [#3088](https://github.com/MarlinFirmware/Marlin/issues/3088) for more information.
***
# Description
In Marlin G0 is exactly the same as [[G1]]. In Marlin G0 is exactly the same as [[G1]].

@ -1,20 +1,19 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
==== Description ==== = Description =
Coordinated Movement of specified axes. This command tells the planner to queue a move to a given position <code>X</code> <code>Y</code> <code>Z</code> <code>E</code> with a given feedrate <code>F</code>. Coordinated Movement of specified axes. This command tells the planner to queue a move to a given position <code>X</code> <code>Y</code> <code>Z</code> <code>E</code> with a given feedrate <code>F</code>.
==== Example ==== = Example =
G1 X10 Y11.5 E112.11 F5000 G1 X10 Y11.5 E112.11 F5000
==== Arguments ==== = Arguments =
X<mm> A coordinate on the X axis X<mm> A coordinate on the X axis
Y<mm> A coordinate on the Y axis Y<mm> A coordinate on the Y axis
Z<mm> A coordinate on the Z axis Z<mm> A coordinate on the Z axis
E<mm> A coordinate on the E axis E<mm> A coordinate on the E axis
F<mm/m> A maximum movement rate. The actual rate may be attenuated, scaled, accelerated, and decelerated over time. F<mm/m> A maximum movement rate. The actual rate may be attenuated, scaled, accelerated, and decelerated over time.
==== Discussion ==== = Discussion =
G1 is used for all coordinated movement. The effect of G1 is to simply add a move to the queue. The move itself will happen at some point in the future. All the specified axes will move simultaneously to arrive at the given coordinates at the same time using linear interpolation. The speed may change over time following an acceleration curve, according to the acceleration and jerk settings of the given axes. G1 is used for all coordinated movement. The effect of G1 is to simply add a move to the queue. The move itself will happen at some point in the future. All the specified axes will move simultaneously to arrive at the given coordinates at the same time using linear interpolation. The speed may change over time following an acceleration curve, according to the acceleration and jerk settings of the given axes.
==== Notes ==== ==== Notes ====

@ -1,17 +1,16 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
==== Description ==== = Description =
Add a clockwise arc movement to the planner. Add a clockwise arc movement to the planner.
==== Example ==== = Example =
Move in a clockwise arc from the current position to 125, 32 with the center offset from the current position by 10.5, 10.5: Move in a clockwise arc from the current position to 125, 32 with the center offset from the current position by 10.5, 10.5:
G2 X125 Y32 I10.5 J10.5 G2 X125 Y32 I10.5 J10.5
Move in a complete clockwise circle with the center offset from the current position by 20, 20: Move in a complete clockwise circle with the center offset from the current position by 20, 20:
G2 I20 J20 G2 I20 J20
==== Arguments ==== = Arguments =
X<mm> A coordinate on the X axis X<mm> A coordinate on the X axis
Y<mm> A coordinate on the Y axis Y<mm> A coordinate on the Y axis
Z<mm> A coordinate on the Z axis Z<mm> A coordinate on the Z axis
@ -20,7 +19,7 @@ Move in a complete clockwise circle with the center offset from the current posi
J<mm> An offset from the current Y position to use as the arc center J<mm> An offset from the current Y position to use as the arc center
F<mm/m> A maximum movement rate. The actual rate may be attenuated, scaled, accelerated, and decelerated over time. F<mm/m> A maximum movement rate. The actual rate may be attenuated, scaled, accelerated, and decelerated over time.
==== Discussion ==== = Discussion =
Arcs are drawn as perfect circular segments, with the number of degrees (hence, length) determined by the angular difference between the start point and the end point with respect to the center point. Arcs are drawn as perfect circular segments, with the number of degrees (hence, length) determined by the angular difference between the start point and the end point with respect to the center point.
==== Notes ==== ==== Notes ====

@ -1,21 +1,23 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Home one or more axes. Home one or more axes.
==== Examples ==== = Examples =
G28 ; Home X, Y, and Z axes G28 ; Home X, Y, and Z axes
G28 XYZ ; Same as G28 G28 XYZ ; Same as G28
G28 X ; Home the X axis only G28 X ; Home the X axis only
G28 X0 ; Same as G28 X G28 X0 ; Same as G28 X
G28 XY ; Home X and Y axes G28 XY ; Home X and Y axes
==== Arguments ==== = Arguments =
X Home the X axis X Home the X axis
Y Home the Y axis Y Home the Y axis
Z Home the Z axis Z Home the Z axis
If no arguments are given, all axes will be homed. If no arguments are given, all axes will be homed.
==== Discussion ==== = Discussion =
Homing is used to establish the current position of an axis by moving it towards an endstop switch at a known position. When the endstop switch is triggered, Marlin sets the current position of the axis to the endstop position. Homing is used to establish the current position of an axis by moving it towards an endstop switch at a known position. When the endstop switch is triggered, Marlin sets the current position of the axis to the endstop position.
==== Notes ==== ==== Notes ====

@ -1,11 +1,13 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Probe the bed Z height and enable bed leveling compensation. Requires [[ENABLE_AUTO_BED_LEVELING]] or [[MANUAL_BED_LEVELING]]. Probe the bed Z height and enable bed leveling compensation. Requires [[ENABLE_AUTO_BED_LEVELING]] or [[MANUAL_BED_LEVELING]].
==== Examples ==== = Examples =
G29 ; Probe the bed using default settings G29 ; Probe the bed using default settings
G29 P3 ; Probe the bed at 3 x 3 points G29 P3 ; Probe the bed at 3 x 3 points
==== Arguments ==== = Arguments =
E Engage (before) and disengage the probe (after) each point. E Engage (before) and disengage the probe (after) each point.
P Size of the grid that will be probed (P x P points). Requires AUTO_BED_LEVELING_GRID. P Size of the grid that will be probed (P x P points). Requires AUTO_BED_LEVELING_GRID.
@ -25,7 +27,7 @@ Probe the bed Z height and enable bed leveling compensation. Requires [[ENABLE_A
L Set the Left limit of the probing grid. Requires AUTO_BED_LEVELING_GRID. L Set the Left limit of the probing grid. Requires AUTO_BED_LEVELING_GRID.
R Set the Right limit of the probing grid. Requires AUTO_BED_LEVELING_GRID. R Set the Right limit of the probing grid. Requires AUTO_BED_LEVELING_GRID.
==== Discussion ==== = Discussion =
There is no standard bed leveling, so this command will behave differently depending on the Marlin configuration options. There is no standard bed leveling, so this command will behave differently depending on the Marlin configuration options.
==== Notes ==== ==== Notes ====

@ -1,17 +1,16 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
==== Description ==== = Description =
Add a counter-clockwise arc movement to the planner. Add a counter-clockwise arc movement to the planner.
==== Example ==== = Example =
Move in a counter-clockwise arc from the current position to 125, 32 with the center offset from the current position by 10.5, 10.5: Move in a counter-clockwise arc from the current position to 125, 32 with the center offset from the current position by 10.5, 10.5:
G3 X125 Y32 I10.5 J10.5 G3 X125 Y32 I10.5 J10.5
Move in a complete counter-clockwise circle with the center offset from the current position by 20, 20: Move in a complete counter-clockwise circle with the center offset from the current position by 20, 20:
G3 I20 J20 G3 I20 J20
==== Arguments ==== = Arguments =
X<mm> A coordinate on the X axis X<mm> A coordinate on the X axis
Y<mm> A coordinate on the Y axis Y<mm> A coordinate on the Y axis
Z<mm> A coordinate on the Z axis Z<mm> A coordinate on the Z axis
@ -20,7 +19,7 @@ Move in a complete counter-clockwise circle with the center offset from the curr
J<mm> An offset from the current Y position to use as the arc center J<mm> An offset from the current Y position to use as the arc center
F<mm/m> A maximum movement rate. The actual rate may be attenuated, scaled, accelerated, and decelerated over time. F<mm/m> A maximum movement rate. The actual rate may be attenuated, scaled, accelerated, and decelerated over time.
==== Discussion ==== = Discussion =
Arcs are drawn as perfect circular segments, with the number of degrees (hence, length) determined by the angular difference between the start point and the end point with respect to the center point. Arcs are drawn as perfect circular segments, with the number of degrees (hence, length) determined by the angular difference between the start point and the end point with respect to the center point.
==== Notes ==== ==== Notes ====

@ -1,14 +1,13 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
==== Description ==== = Description =
Dwell pauses the command queue, and waits for a given period of time. Dwell pauses the command queue, and waits for a given period of time.
==== Arguments ==== = Arguments =
S<sec> Amount of time (in seconds) to dwell S<sec> Amount of time (in seconds) to dwell
P<ms> Amount of time (in milliseconds) to dwell P<ms> Amount of time (in milliseconds) to dwell
==== Example ==== = Example =
G4 P500 ; Dwell for 1/2 second G4 P500 ; Dwell for 1/2 second
==== Notes ==== ==== Notes ====

@ -1,14 +1,13 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
==== Description ==== = Description =
Set the current position of one or more axes. Set the current position of one or more axes.
==== Examples ==== = Examples =
G92 X10 ; Set the X position to 10 G92 X10 ; Set the X position to 10
G92 X0 Y0 Z0 ; Make the current position the home position G92 X0 Y0 Z0 ; Make the current position the home position
==== Arguments ==== = Arguments =
X<mm> A coordinate on the X axis X<mm> A coordinate on the X axis
Y<mm> A coordinate on the Y axis Y<mm> A coordinate on the Y axis
Z<mm> A coordinate on the Z axis Z<mm> A coordinate on the Z axis

@ -1,15 +1,14 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
==== Description ==== = Description =
Pause and wait for a user reply, with an optional prompt message to display on the LCD controller screen. Pause and wait for a user reply, with an optional prompt message to display on the LCD controller screen.
==== Arguments ==== = Arguments =
S<sec> Maximum time (in seconds) to wait before resuming S<sec> Maximum time (in seconds) to wait before resuming
P<ms> Maximum time (in milliseconds) to wait before resuming P<ms> Maximum time (in milliseconds) to wait before resuming
<string> A string to display on the LCD screen <string> A string to display on the LCD screen
==== Examples ==== = Examples =
M0 Click When Ready M0 Click When Ready
* Display '''Click When Ready''' on the LCD screen * Display '''Click When Ready''' on the LCD screen
* Wait forever for a controller button press * Wait forever for a controller button press
@ -20,7 +19,7 @@ Pause and wait for a user reply, with an optional prompt message to display on t
* Display '''Wait for user...''' on the LCD screen * Display '''Wait for user...''' on the LCD screen
* Wait 10 seconds for a controller button press, then continue * Wait 10 seconds for a controller button press, then continue
==== Discussion ==== = Discussion =
==== Notes ==== ==== Notes ====
* M1 is a deprecated alias for M0. * M1 is a deprecated alias for M0.

@ -1,4 +1,3 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
M1 is a deprecated alias for [[M0]]. M1 is a deprecated alias for [[M0]].

@ -1,12 +1,14 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Set the target temperature for a hotend. Set the target temperature for a hotend.
==== Example ==== = Example =
M104 S190 ; Set the current extruder's hotend temperature M104 S190 ; Set the current extruder's hotend temperature
M104 T1 S220 ; Set the hotend temperature for Extruder 1 M104 T1 S220 ; Set the hotend temperature for Extruder 1
==== Arguments ==== = Arguments =
S<celsius> Required. The temperature to set. S<celsius> Required. The temperature to set.
T<target> An optional extruder number. T<target> An optional extruder number.
==== Discussion ==== = Discussion =
M104 changes the target temperature for an extruder's hotend. Unlike the [[M109]] command, it will not wait for the temperature to be reached before proceeding with the next command. M104 changes the target temperature for an extruder's hotend. Unlike the [[M109]] command, it will not wait for the temperature to be reached before proceeding with the next command.
==== Notes ==== ==== Notes ====
* Use [[M109]] to wait for the target temperature to be reached. [[M109]] can also be used to set the temperature, obviating the need for this command during a print job. * Use [[M109]] to wait for the target temperature to be reached. [[M109]] can also be used to set the temperature, obviating the need for this command during a print job.

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Optionally set the target temperature for an extruder, then wait in a loop until the target temperature is reached. Optionally set the target temperature for an extruder, then wait in a loop until the target temperature is reached.
==== Examples ==== = Examples =
M109 ; Wait for the current extruder's hotend to reach target temperature M109 ; Wait for the current extruder's hotend to reach target temperature
M109 S190 ; Set the current extruder's hotend temperature and wait M109 S190 ; Set the current extruder's hotend temperature and wait
M109 T1 S220 ; Set the hotend temperature for Extruder 1 and wait M109 T1 S220 ; Set the hotend temperature for Extruder 1 and wait
==== Arguments ==== = Arguments =
S<celsius> Optional. The temperature to set and wait for. Don't wait if cooling down. S<celsius> Optional. The temperature to set and wait for. Don't wait if cooling down.
R<celsius> Optional. The temperature to set and wait for. Always wait. R<celsius> Optional. The temperature to set and wait for. Always wait.
T<target> An optional extruder number. T<target> An optional extruder number.
@ -13,7 +15,7 @@ Optionally set the target temperature for an extruder, then wait in a loop until
S<celsius> Minimum temperature S<celsius> Minimum temperature
B<celsius> Maximum temperature B<celsius> Maximum temperature
See [[AUTOTEMP]] for further discussion. See [[AUTOTEMP]] for further discussion.
==== Discussion ==== = Discussion =
M109 changes the target temperature for an extruder's hotend and waits for the temperature to be reached before proceeding with the next command. If you don't want to pause for heating, use [[M104]]. M109 changes the target temperature for an extruder's hotend and waits for the temperature to be reached before proceeding with the next command. If you don't want to pause for heating, use [[M104]].
==== Notes ==== ==== Notes ====
* If both <code>S</code> and <code>R</code> parameters are given, <code>S</code> takes precedence. * If both <code>S</code> and <code>R</code> parameters are given, <code>S</code> takes precedence.

@ -1,17 +1,19 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Set the current Line Number. Set the current Line Number.
==== Examples ==== = Examples =
N500 M110 ; Set the Line Number to 500 (short form, checksum required) N500 M110 ; Set the Line Number to 500 (short form, checksum required)
N123 M110 N500 ; Set the Line Number to 500 (long form, checksum required) N123 M110 N500 ; Set the Line Number to 500 (long form, checksum required)
M110 N500 ; Set the Line Number to 500 (short form, no checksum required) M110 N500 ; Set the Line Number to 500 (short form, no checksum required)
==== Arguments ==== = Arguments =
N<num> The new Line Number N<num> The new Line Number
If no arguments are given, the Line Number will be set to the Line Number in the <code>N</code> prefix. If no arguments are given, the Line Number will be set to the Line Number in the <code>N</code> prefix.
==== Discussion ==== = Discussion =
Commands sent by host software during a printing session can optionally include a line number and a checksum that Marlin will check for validity. This allows hosts to catch communication errors and retry commands that don't get through. Usually the Line Number starts at 1 and continues sequentially, but if a host is resuming a print job or combining jobs it could start or continue at any point in the sequence. This command allows the Line Number to be set to a new value in such cases. Commands sent by host software during a printing session can optionally include a line number and a checksum that Marlin will check for validity. This allows hosts to catch communication errors and retry commands that don't get through. Usually the Line Number starts at 1 and continues sequentially, but if a host is resuming a print job or combining jobs it could start or continue at any point in the sequence. This command allows the Line Number to be set to a new value in such cases.
==== Notes ==== ==== Notes ====

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Set the target temperature for the heated bed. Set the target temperature for the heated bed.
==== Example ==== = Example =
M140 S70 ; Set the bed temperature M140 S70 ; Set the bed temperature
==== Arguments ==== = Arguments =
S<celsius> Required. The temperature to set. S<celsius> Required. The temperature to set.
==== Discussion ==== = Discussion =
M140 changes the target temperature for the heated bed. Unlike the [[M190]] command, it will not wait for the temperature to be reached before proceeding with the next command. M140 changes the target temperature for the heated bed. Unlike the [[M190]] command, it will not wait for the temperature to be reached before proceeding with the next command.
==== Notes ==== ==== Notes ====
* Use [[M190]] to wait for the target temperature to be reached. [[M190]] can also be used to set the temperature, obviating the need for this command during a print job. * Use [[M190]] to wait for the target temperature to be reached. [[M190]] can also be used to set the temperature, obviating the need for this command during a print job.

@ -1,7 +1,9 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Enable all stepper motors. Enable all stepper motors.
==== Example ==== = Example =
M17 M17
==== Notes ==== ==== Notes ====

5
M18.md

@ -1 +1,4 @@
Is in Marlin exactly the same as [[M84]]. **__DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [Issue #3088 "New Documentation"](https://github.com/MarlinFirmware/Marlin/issues/3088) for more information.__**
# Description
M18 is an alias for [[M84]].

@ -1,12 +1,14 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Optionally set the target temperature for the heated bed, then wait in a loop until that target temperature is reached. Optionally set the target temperature for the heated bed, then wait in a loop until that target temperature is reached.
==== Examples ==== = Examples =
M190 ; Wait for the heated bed to reach target temperature M190 ; Wait for the heated bed to reach target temperature
M190 S190 ; Set the heated bed temperature and wait M190 S190 ; Set the heated bed temperature and wait
==== Arguments ==== = Arguments =
S<celsius> Optional. The temperature to set and wait for. Don't wait if cooling down. S<celsius> Optional. The temperature to set and wait for. Don't wait if cooling down.
R<celsius> Optional. The temperature to set and wait for. Always wait. R<celsius> Optional. The temperature to set and wait for. Always wait.
==== Discussion ==== = Discussion =
M190 changes the target temperature for the heated bed and waits for the temperature to be reached before proceeding with the next command. If you don't want to pause for heating, use [[M109]]. M190 changes the target temperature for the heated bed and waits for the temperature to be reached before proceeding with the next command. If you don't want to pause for heating, use [[M109]].
==== Notes ==== ==== Notes ====
* If both <code>S</code> and <code>R</code> parameters are given, <code>S</code> takes precedence. * If both <code>S</code> and <code>R</code> parameters are given, <code>S</code> takes precedence.

@ -1,7 +1,9 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Print the contents of the SD card to serial output. Files and folders deeper than the [[MAX_DIR_DEPTH]] setting will not be listed. Print the contents of the SD card to serial output. Files and folders deeper than the [[MAX_DIR_DEPTH]] setting will not be listed.
==== Example ==== = Example =
M20 M20
This command produces output in DOS filename format similar to: This command produces output in DOS filename format similar to:
CHRYSL~1.GCO CHRYSL~1.GCO
@ -25,7 +27,7 @@ This command produces output in DOS filename format similar to:
/MISCEL~1/HEADPH~1/PHONEC~1.GCO /MISCEL~1/HEADPH~1/PHONEC~1.GCO
/MISCEL~1/HEADPH~1/PHONEC~2.GCO /MISCEL~1/HEADPH~1/PHONEC~2.GCO
==== Discussion ==== = Discussion =
M20 prints a listing of all files on the SD card in the machine to the serial output with their full DOS 8.3 paths. (Currently there is no method to obtain FAT32 long filenames through GCode.) M20 prints a listing of all files on the SD card in the machine to the serial output with their full DOS 8.3 paths. (Currently there is no method to obtain FAT32 long filenames through GCode.)
==== Notes ==== ==== Notes ====

@ -1,12 +1,14 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Set the filament diameter. If the diameter is non-zero, set the E-Units to cubic millimeters, otherwise set E-Units to linear millimeters. Set the filament diameter. If the diameter is non-zero, set the E-Units to cubic millimeters, otherwise set E-Units to linear millimeters.
==== Example ==== = Example =
M200 D2.9 M200 D2.9
==== Arguments ==== = Arguments =
T<tool> Extruder number. If omitted, uses the active extruder. T<tool> Extruder number. If omitted, uses the active extruder.
D<mm> Filament diameter. Use "D0" to go back to linear mm units. D<mm> Filament diameter. Use "D0" to go back to linear mm units.
==== Discussion ==== = Discussion =
Typical G-Code specifies the amount of material to extrude using the length of the extruder movement. This option allows G-Code to specify the amount of material to extrude using cubic millimeters, which is calculated as the volume of a cylinder. Typical G-Code specifies the amount of material to extrude using the length of the extruder movement. This option allows G-Code to specify the amount of material to extrude using cubic millimeters, which is calculated as the volume of a cylinder.

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Initialize the SD card reader. Initialize the SD card reader.
==== Example ==== = Example =
M21 M21
==== Discussion ==== = Discussion =
M21 attempts to initialize the SD card reader, find a volume on the card, and open the root of the volume. If it succeeds then it makes the card available for reading and printing. M21 attempts to initialize the SD card reader, find a volume on the card, and open the root of the volume. If it succeeds then it makes the card available for reading and printing.
This command is usually used to re-initialize an SD card reader that doesn't have an auto detect switch, or to wake up an SD card reader that has stopped responding. This command is usually used to re-initialize an SD card reader that doesn't have an auto detect switch, or to wake up an SD card reader that has stopped responding.

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Release the SD card. Release the SD card.
==== Example ==== = Example =
M22 M22
==== Discussion ==== = Discussion =
M22 tells the firmware to make the card reader unavailable for reading and printing. M22 tells the firmware to make the card reader unavailable for reading and printing.
==== Notes ==== ==== Notes ====

@ -1,12 +1,14 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Select a file on the SD card for reading. Select a file on the SD card for reading.
==== Examples ==== = Examples =
M23 /MISCEL~1/ARMCHAIR/ARMCHA~1.GCO M23 /MISCEL~1/ARMCHAIR/ARMCHA~1.GCO
M23 fishnetw.gco M23 fishnetw.gco
==== Arguments ==== = Arguments =
<filename> The full DOS 8.3 path to the file. The path is case-insensitive. <filename> The full DOS 8.3 path to the file. The path is case-insensitive.
==== Discussion ==== = Discussion =
M23 only selects a file for reading, but doesn't start to print it. Use [[M24]] to begin printing. M23 only selects a file for reading, but doesn't start to print it. Use [[M24]] to begin printing.

@ -1,8 +1,10 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Start printing the file selected with [[M23]]. Start printing the file selected with [[M23]].
==== Example ==== = Example =
M24 M24
==== Description ==== = Description =
M24 begins printing the file that has been selected and opened with [[M23]]. If no file has been selected M24 does nothing. M24 begins printing the file that has been selected and opened with [[M23]]. If no file has been selected M24 does nothing.

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Pause an ongoing SD print. If nothing is being printed this does nothing. Pause an ongoing SD print. If nothing is being printed this does nothing.
==== Example ==== = Example =
M25 M25
==== Discussion ==== = Discussion =
M25 pauses SD card printing, but doesn't immediately pause movement. Any movements still in the planner buffer from previous commands will continue. (Marlin 1.0.3) M25 pauses SD card printing, but doesn't immediately pause movement. Any movements still in the planner buffer from previous commands will continue. (Marlin 1.0.3)
==== Notes ==== ==== Notes ====

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Set the current SD file read/write position in bytes. If no file is open this does nothing. Set the current SD file read/write position in bytes. If no file is open this does nothing.
==== Example ==== = Example =
M26 S12345 M26 S12345
==== Discussion ==== = Discussion =
M26 sets the next position to start reading or writing. The file must have been selected to read with [[M23]] or to write with [[M28]]. M26 sets the next position to start reading or writing. The file must have been selected to read with [[M23]] or to write with [[M28]].
==== Notes ==== ==== Notes ====

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Print the current SD file position. Print the current SD file position.
==== Example ==== = Example =
M27 M27
'''SD printing byte 1242/23928''' '''SD printing byte 1242/23928'''
==== Description ==== = Description =
The file must have been opened for reading with [[M23]] or writing with [[M28]]. The file must have been opened for reading with [[M23]] or writing with [[M28]].

@ -1,11 +1,13 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Open a new or existing file on the SD card for writing. Open a new or existing file on the SD card for writing.
==== Example ==== = Example =
M28 path/to/newfile.gco M28 path/to/newfile.gco
==== Arguments ==== = Arguments =
<filename> The full DOS 8.3 path to the file. The actual path will be saved in upper-case. <filename> The full DOS 8.3 path to the file. The actual path will be saved in upper-case.
==== Description ==== = Description =
M28 creates a file for writing. All commands sent until the next [[M29]] will be ignored by the parser and written to the file. [[M29]] finishes and closes the file. M28 creates a file for writing. All commands sent until the next [[M29]] will be ignored by the parser and written to the file. [[M29]] finishes and closes the file.

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Finish writing a file on the SD card. Finish writing a file on the SD card.
==== Examples ==== = Examples =
M29 M29
==== Description ==== = Description =
M29 finishes a file write begun with [[M28]]. M29 finishes a file write begun with [[M28]].
==== Notes ==== ==== Notes ====

@ -1,12 +1,14 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Delete a file on the SD card. Delete a file on the SD card.
==== Examples ==== = Examples =
M30 /MISCEL~1/ARMCHAIR/ARMCHA~1.GCO M30 /MISCEL~1/ARMCHAIR/ARMCHA~1.GCO
M30 auto0.g M30 auto0.g
==== Arguments ==== = Arguments =
<filepath> The full DOS 8.3 path to the file. The path is case-insensitive. <filepath> The full DOS 8.3 path to the file. The path is case-insensitive.
==== Discussion ==== = Discussion =
M30 immediately deletes the file. Use with caution. M30 immediately deletes the file. Use with caution.

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Print the time elapsed since an SD print started (such as with [[M24]]) or since the most recent [[M109]] command completed. Print the time elapsed since an SD print started (such as with [[M24]]) or since the most recent [[M109]] command completed.
==== Examples ==== = Examples =
M31 M31
'''12 min, 28 sec''' '''12 min, 28 sec'''
==== Discussion ==== = Discussion =
Most G-Code files have only a single [[M109]] command near the top, so this can usually be interpreted as the total print time, not including the time to heat up. Hosts should watch for [[M109]] or use a local timer. Most G-Code files have only a single [[M109]] command near the top, so this can usually be interpreted as the total print time, not including the time to heat up. Hosts should watch for [[M109]] or use a local timer.

@ -1,11 +1,13 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Start printing another G-Code file and resume after finishing. A way to include G-Code files in other G-Code files. Start printing another G-Code file and resume after finishing. A way to include G-Code files in other G-Code files.
==== Examples ==== = Examples =
M32 !/MISCEL~1/ARMCHAIR/ARMCHA~1.GCO# M32 !/MISCEL~1/ARMCHAIR/ARMCHA~1.GCO#
M32 S1226 !fishnetw.gco# M32 S1226 !fishnetw.gco#
==== Arguments ==== = Arguments =
S<position> S<position>
<filename> The full DOS 8.3 path to the file. The path is case-insensitive. <filename> The full DOS 8.3 path to the file. The path is case-insensitive.

@ -1,11 +1,10 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
==== Description ==== = Description =
Wait for all moves to finish. Wait for all moves to finish.
==== Example ==== = Example =
M400 M400
==== Discussion ==== = Discussion =
<code>M400</code> is used to keep the next command from execution until the printer finishes all movement (i.e., the planner queue is empty). This command should rarely be needed for normal printing, but it can be useful as a workaround for badly-behaved commands, or to ensure that a command definitely happens in sequence with movement. This should be used sparingly because it can cause a small pause, potentially affecting print quality. <code>M400</code> is used to keep the next command from execution until the printer finishes all movement (i.e., the planner queue is empty). This command should rarely be needed for normal printing, but it can be useful as a workaround for badly-behaved commands, or to ensure that a command definitely happens in sequence with movement. This should be used sparingly because it can cause a small pause, potentially affecting print quality.

@ -1,3 +1,5 @@
'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description = = Description =
Directly change a hardware pin's state. If no pin is specified, the LED pin is assumed. Directly change a hardware pin's state. If no pin is specified, the LED pin is assumed.
= Example = = Example =

@ -1,9 +1,12 @@
'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Measure Z Probe repeatability and print to serial output. Measure Z Probe repeatability and print to serial output.
==== Example ==== = Example =
M48 P4 X100 Y100 V2 E L2 M48 P4 X100 Y100 V2 E L2
==== Arguments ==== = Arguments =
P<int> Number of sampled points (4-50, default 10) P<int> Number of sampled points (4-50, default 10)
X<float> Sample X position (current X if omitted) X<float> Sample X position (current X if omitted)
Y<float> Sample Y position (current Y if omitted) Y<float> Sample Y position (current Y if omitted)
@ -11,7 +14,7 @@ Measure Z Probe repeatability and print to serial output.
E Engage probe for each reading if this parameter is included at all E Engage probe for each reading if this parameter is included at all
L<int> Legs of movement for each probe (0-15) L<int> Legs of movement for each probe (0-15)
==== Discussion ==== = Discussion =
This procedure tests the repeatability of your Z probe by doing multiple probes at the same position and comparing them. A good Z probe will read the same each time. This procedure tests the repeatability of your Z probe by doing multiple probes at the same position and comparing them. A good Z probe will read the same each time.
==== Notes ==== ==== Notes ====

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Store current settings to EEPROM. Store current settings to EEPROM.
==== Examples ==== = Examples =
M500 M500
==== Discussion ==== = Discussion =
This command is used to save adjusted settings to EEPROM. The next time the board powers up the stored settings will automatically be used. This command is used to save adjusted settings to EEPROM. The next time the board powers up the stored settings will automatically be used.
==== Notes ==== ==== Notes ====

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Load stored settings from EEPROM. Load stored settings from EEPROM.
==== Examples ==== = Examples =
M501 M501
==== Discussion ==== = Discussion =
This command gets the stored settings from EEPROM and immediately applies them. This command gets the stored settings from EEPROM and immediately applies them.
==== Notes ==== ==== Notes ====

@ -1,14 +1,16 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Print current settings to the serial output. Use <code>S0</code> for plain G-code output that can be run to restore all settings. Print current settings to the serial output. Use <code>S0</code> for plain G-code output that can be run to restore all settings.
==== Examples ==== = Examples =
M503 ; Print current settings M503 ; Print current settings
M503 S0 ; Print current settings as replayable G-code M503 S0 ; Print current settings as replayable G-code
==== Arguments ==== = Arguments =
S<flag> S0 to display minimal G-code output. S<flag> S0 to display minimal G-code output.
==== Discussion ==== = Discussion =
This command displays the current value of all the parameters which can be stored in EEPROM. These are not the settings stored in EEPROM! Use [[M500]] to store these settings in EEPROM. This command displays the current value of all the parameters which can be stored in EEPROM. These are not the settings stored in EEPROM! Use [[M500]] to store these settings in EEPROM.
==== Notes ==== ==== Notes ====

@ -1,13 +1,15 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Set the state of the [[ABORT_ON_ENDSTOP_HIT_FEATURE_ENABLED|Abort on Endstop Hit]] flag. Set the state of the [[ABORT_ON_ENDSTOP_HIT_FEATURE_ENABLED|Abort on Endstop Hit]] flag.
==== Example ==== = Example =
M540 S1 M540 S1
==== Arguments ==== = Arguments =
S<bool> The new state of the endstop abort flag, 0=Off, 1=On S<bool> The new state of the endstop abort flag, 0=Off, 1=On
==== Discussion ==== = Discussion =
Normally when printing from SD an axis can hit an endstop and the print will continue. Set this flag if you prefer to stop the print if an endstop is hit. Normally when printing from SD an axis can hit an endstop and the print will continue. Set this flag if you prefer to stop the print if an endstop is hit.
==== Notes ==== ==== Notes ====

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Turn on the power supply. Requires the [[POWER_SUPPLY]] option. Turn on the power supply. Requires the [[POWER_SUPPLY]] option.
==== Example ==== = Example =
M80 M80
==== Discussion ==== = Discussion =
This command turns on the high voltage (usually 12V) power supply used for motors, hot ends, and the heated bed. ATX power supply units and some other power supplies include a lead that acts as a switch to turn the power supply on (or off) when connected to ground. These power-switch leads can be connected to pins on the controller board to turn the voltage on and off with software control. This command turns on the high voltage (usually 12V) power supply used for motors, hot ends, and the heated bed. ATX power supply units and some other power supplies include a lead that acts as a switch to turn the power supply on (or off) when connected to ground. These power-switch leads can be connected to pins on the controller board to turn the voltage on and off with software control.
==== Notes ==== ==== Notes ====

@ -1,10 +1,12 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Turn off the power supply. Requires the [[POWER_SUPPLY]] option. Turn off the power supply. Requires the [[POWER_SUPPLY]] option.
==== Example ==== = Example =
M81 M81
==== Discussion ==== = Discussion =
This command turns off the high voltage (usually 12V) power supply used for motors, hot ends, and the heated bed. ATX power supply units and some other power supplies include a lead that acts as a switch to turn the power supply on (or off) when connected to ground. These power-switch leads can be connected to pins on the controller board to turn the voltage on and off with software control. This command turns off the high voltage (usually 12V) power supply used for motors, hot ends, and the heated bed. ATX power supply units and some other power supplies include a lead that acts as a switch to turn the power supply on (or off) when connected to ground. These power-switch leads can be connected to pins on the controller board to turn the voltage on and off with software control.
==== Notes ==== ==== Notes ====

@ -1,13 +1,18 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Disable steppers immediately or set the Stepper Inactivity Timeout for "idle hold." Disable steppers immediately or set the Stepper Inactivity Timeout for "idle hold."
==== Examples ==== = Examples =
M84 ; Disable steppers immediately (until the next move). M84 ; Disable steppers immediately (until the next move).
M84 S2 ; Set the timeout to disable steppers after 2 seconds of idle. M84 S2 ; Set the timeout to disable steppers after 2 seconds of idle.
M84 S0 ; Clear the disable timeout so steppers stay on while idling. M84 S0 ; Clear the disable timeout so steppers stay on while idling.
==== Arguments ==== = Arguments =
S<sec> Stepper Inactive Time value (0 to disable) S<sec> Stepper Inactive Time value (0 to disable)
If the "S" argument is present, the following arguments will be ignored:
X Flag to disable the X axis X Flag to disable the X axis
Y Flag to disable the Y axis Y Flag to disable the Y axis
Z Flag to disable the Z axis Z Flag to disable the Z axis
@ -15,7 +20,7 @@ Disable steppers immediately or set the Stepper Inactivity Timeout for "idle hol
If none of the axis flags are included then all axes will be disabled. If none of the axis flags are included then all axes will be disabled.
==== Discussion ==== = Discussion =
This command is used both to disable steppers (<code>M18</code>) and to disable stepper "idle hold." Stepper motors can "ring" while stopped due to the oscillating current to the motor. This ringing can be prevented by disabling stepper motors when they're idle. This command shouldn't be used during printing because motors may lose position and reduce print quality. This command is used both to disable steppers (<code>M18</code>) and to disable stepper "idle hold." Stepper motors can "ring" while stopped due to the oscillating current to the motor. This ringing can be prevented by disabling stepper motors when they're idle. This command shouldn't be used during printing because motors may lose position and reduce print quality.
==== Notes ==== ==== Notes ====

@ -1,11 +1,13 @@
==== Description ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
= Description =
Open a new or existing file on the SD card for logging. Open a new or existing file on the SD card for logging.
==== Example ==== = Example =
M928 path/to/logfile.gco M928 path/to/logfile.gco
==== Arguments ==== = Arguments =
<filename> The full DOS 8.3 path to the file. The actual path will be saved in upper-case. <filename> The full DOS 8.3 path to the file. The actual path will be saved in upper-case.
==== Description ==== = Discussion =
M928 creates a file for logging and turns on logging. All commands sent until the next [[M29]] will be written to the log file before being processed. [[M29]] closes the file and turns off logging. M928 creates a file for logging and turns on logging. All commands sent until the next [[M29]] will be written to the log file before being processed. [[M29]] closes the file and turns off logging.

@ -1,12 +1,12 @@
==== DO NOT EDIT ==== '''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.<br/>Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.'''''
This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information.
= Description =
Resume after an error Stop. Resume after an error Stop.
==== Examples ==== = Examples =
M999 M999
==== Discussion ==== = Discussion =
Marlin may do an emergency stop under a couple of circumstances: Marlin may do an emergency stop under a couple of circumstances:
* A dangerous temperature condition occurred, so the print was aborted and heaters disabled * A dangerous temperature condition occurred, so the print was aborted and heaters disabled
* A servo probe failed to engage or stow * A servo probe failed to engage or stow