From ee00347c2fe13729fd06e382c9ae35e2ef6c8497 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Tue, 22 Mar 2016 18:17:20 -0700 Subject: [PATCH] Clean up obsolete GCode pages, add Do Not Edit message --- G0.md | 5 ++--- G1.mediawiki | 11 +++++------ G2.mediawiki | 11 +++++------ G28.mediawiki | 10 ++++++---- G29.mediawiki | 10 ++++++---- G3.mediawiki | 11 +++++------ G4.mediawiki | 9 ++++----- G92.mediawiki | 9 ++++----- M0.mediawiki | 11 +++++------ M1.mediawiki | 3 +-- M104.mediawiki | 10 ++++++---- M109.mediawiki | 10 ++++++---- M110.mediawiki | 10 ++++++---- M140.mediawiki | 10 ++++++---- M17.mediawiki | 6 ++++-- M18.md | 5 ++++- M190.mediawiki | 10 ++++++---- M20.mediawiki | 8 +++++--- M200.mediawiki | 10 ++++++---- M21.mediawiki | 8 +++++--- M22.mediawiki | 8 +++++--- M23.mediawiki | 10 ++++++---- M24.mediawiki | 8 +++++--- M25.mediawiki | 8 +++++--- M26.mediawiki | 8 +++++--- M27.mediawiki | 8 +++++--- M28.mediawiki | 10 ++++++---- M29.mediawiki | 8 +++++--- M30.mediawiki | 10 ++++++---- M31.mediawiki | 8 +++++--- M32.mediawiki | 8 +++++--- M400.mediawiki | 9 ++++----- M42.mediawiki | 2 ++ M48.mediawiki | 9 ++++++--- M500.mediawiki | 8 +++++--- M501.mediawiki | 8 +++++--- M503.mediawiki | 10 ++++++---- M540.mediawiki | 10 ++++++---- M80.mediawiki | 8 +++++--- M81.mediawiki | 8 +++++--- M84.mediawiki | 13 +++++++++---- M928.mediawiki | 10 ++++++---- M999.mediawiki | 8 ++++---- 43 files changed, 218 insertions(+), 156 deletions(-) diff --git a/G0.md b/G0.md index f2ceac5..852e6c4 100644 --- a/G0.md +++ b/G0.md @@ -1,5 +1,4 @@ -# DO NOT EDIT -This page has been ported into the new documentation system. Please read [#3088](https://github.com/MarlinFirmware/Marlin/issues/3088) for more information. -*** +**__DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [Issue #3088 "New Documentation"](https://github.com/MarlinFirmware/Marlin/issues/3088) for more information.__** +# Description In Marlin G0 is exactly the same as [[G1]]. \ No newline at end of file diff --git a/G1.mediawiki b/G1.mediawiki index 52cf1c7..5d0f8a4 100644 --- a/G1.mediawiki +++ b/G1.mediawiki @@ -1,20 +1,19 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' -==== Description ==== += Description = Coordinated Movement of specified axes. This command tells the planner to queue a move to a given position X Y Z E with a given feedrate F. -==== Example ==== += Example = G1 X10 Y11.5 E112.11 F5000 -==== Arguments ==== += Arguments = X A coordinate on the X axis Y A coordinate on the Y axis Z A coordinate on the Z axis E A coordinate on the E axis F 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. ==== Notes ==== diff --git a/G2.mediawiki b/G2.mediawiki index 9df1864..99a9051 100644 --- a/G2.mediawiki +++ b/G2.mediawiki @@ -1,17 +1,16 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' -==== Description ==== += Description = 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: G2 X125 Y32 I10.5 J10.5 Move in a complete clockwise circle with the center offset from the current position by 20, 20: G2 I20 J20 -==== Arguments ==== += Arguments = X A coordinate on the X axis Y A coordinate on the Y axis Z 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 An offset from the current Y position to use as the arc center F 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. ==== Notes ==== diff --git a/G28.mediawiki b/G28.mediawiki index ca8767b..789f978 100644 --- a/G28.mediawiki +++ b/G28.mediawiki @@ -1,21 +1,23 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Home one or more axes. -==== Examples ==== += Examples = G28 ; Home X, Y, and Z axes G28 XYZ ; Same as G28 G28 X ; Home the X axis only G28 X0 ; Same as G28 X G28 XY ; Home X and Y axes -==== Arguments ==== += Arguments = X Home the X axis Y Home the Y axis Z Home the Z axis 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. ==== Notes ==== diff --git a/G29.mediawiki b/G29.mediawiki index 50377a4..0f8667f 100644 --- a/G29.mediawiki +++ b/G29.mediawiki @@ -1,11 +1,13 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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]]. -==== Examples ==== += Examples = G29 ; Probe the bed using default settings G29 P3 ; Probe the bed at 3 x 3 points -==== Arguments ==== += Arguments = 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. @@ -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. 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. ==== Notes ==== diff --git a/G3.mediawiki b/G3.mediawiki index 7e7dc01..41589c9 100644 --- a/G3.mediawiki +++ b/G3.mediawiki @@ -1,17 +1,16 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' -==== Description ==== += Description = 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: 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: G3 I20 J20 -==== Arguments ==== += Arguments = X A coordinate on the X axis Y A coordinate on the Y axis Z 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 An offset from the current Y position to use as the arc center F 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. ==== Notes ==== diff --git a/G4.mediawiki b/G4.mediawiki index 9f6c90b..2c8054c 100644 --- a/G4.mediawiki +++ b/G4.mediawiki @@ -1,14 +1,13 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' -==== Description ==== += Description = Dwell pauses the command queue, and waits for a given period of time. -==== Arguments ==== += Arguments = S Amount of time (in seconds) to dwell P Amount of time (in milliseconds) to dwell -==== Example ==== += Example = G4 P500 ; Dwell for 1/2 second ==== Notes ==== diff --git a/G92.mediawiki b/G92.mediawiki index d30b1a0..26cb883 100644 --- a/G92.mediawiki +++ b/G92.mediawiki @@ -1,14 +1,13 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' -==== Description ==== += Description = Set the current position of one or more axes. -==== Examples ==== += Examples = G92 X10 ; Set the X position to 10 G92 X0 Y0 Z0 ; Make the current position the home position -==== Arguments ==== += Arguments = X A coordinate on the X axis Y A coordinate on the Y axis Z A coordinate on the Z axis diff --git a/M0.mediawiki b/M0.mediawiki index 2e7fe38..698ea58 100644 --- a/M0.mediawiki +++ b/M0.mediawiki @@ -1,15 +1,14 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' -==== Description ==== += Description = Pause and wait for a user reply, with an optional prompt message to display on the LCD controller screen. -==== Arguments ==== += Arguments = S Maximum time (in seconds) to wait before resuming P Maximum time (in milliseconds) to wait before resuming A string to display on the LCD screen -==== Examples ==== += Examples = M0 Click When Ready * Display '''Click When Ready''' on the LCD screen * 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 * Wait 10 seconds for a controller button press, then continue -==== Discussion ==== += Discussion = ==== Notes ==== * M1 is a deprecated alias for M0. diff --git a/M1.mediawiki b/M1.mediawiki index a226089..e14d604 100644 --- a/M1.mediawiki +++ b/M1.mediawiki @@ -1,4 +1,3 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' M1 is a deprecated alias for [[M0]]. \ No newline at end of file diff --git a/M104.mediawiki b/M104.mediawiki index 28c383b..00193db 100644 --- a/M104.mediawiki +++ b/M104.mediawiki @@ -1,12 +1,14 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Set the target temperature for a hotend. -==== Example ==== += Example = M104 S190 ; Set the current extruder's hotend temperature M104 T1 S220 ; Set the hotend temperature for Extruder 1 -==== Arguments ==== += Arguments = S Required. The temperature to set. T 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. ==== 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. diff --git a/M109.mediawiki b/M109.mediawiki index d5bbc73..2fbbc99 100644 --- a/M109.mediawiki +++ b/M109.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Examples ==== += Examples = M109 ; Wait for the current extruder's hotend to reach target temperature M109 S190 ; Set the current extruder's hotend temperature and wait M109 T1 S220 ; Set the hotend temperature for Extruder 1 and wait -==== Arguments ==== += Arguments = S Optional. The temperature to set and wait for. Don't wait if cooling down. R Optional. The temperature to set and wait for. Always wait. T An optional extruder number. @@ -13,7 +15,7 @@ Optionally set the target temperature for an extruder, then wait in a loop until S Minimum temperature B Maximum temperature 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]]. ==== Notes ==== * If both S and R parameters are given, S takes precedence. diff --git a/M110.mediawiki b/M110.mediawiki index 2323937..1421a54 100644 --- a/M110.mediawiki +++ b/M110.mediawiki @@ -1,17 +1,19 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Set the current Line Number. -==== Examples ==== += Examples = 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) M110 N500 ; Set the Line Number to 500 (short form, no checksum required) -==== Arguments ==== += Arguments = N The new Line Number If no arguments are given, the Line Number will be set to the Line Number in the N 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. ==== Notes ==== diff --git a/M140.mediawiki b/M140.mediawiki index 6e5e3db..3f1f227 100644 --- a/M140.mediawiki +++ b/M140.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = M140 S70 ; Set the bed temperature -==== Arguments ==== += Arguments = S 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. ==== 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. diff --git a/M17.mediawiki b/M17.mediawiki index f930c37..5d2a03d 100644 --- a/M17.mediawiki +++ b/M17.mediawiki @@ -1,7 +1,9 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Enable all stepper motors. -==== Example ==== += Example = M17 ==== Notes ==== diff --git a/M18.md b/M18.md index d36e568..dd27712 100644 --- a/M18.md +++ b/M18.md @@ -1 +1,4 @@ -Is in Marlin exactly the same as [[M84]]. \ No newline at end of file +**__DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [Issue #3088 "New Documentation"](https://github.com/MarlinFirmware/Marlin/issues/3088) for more information.__** + +# Description +M18 is an alias for [[M84]]. \ No newline at end of file diff --git a/M190.mediawiki b/M190.mediawiki index cb1e551..fa41d72 100644 --- a/M190.mediawiki +++ b/M190.mediawiki @@ -1,12 +1,14 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Examples ==== += Examples = M190 ; Wait for the heated bed to reach target temperature M190 S190 ; Set the heated bed temperature and wait -==== Arguments ==== += Arguments = S Optional. The temperature to set and wait for. Don't wait if cooling down. R 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]]. ==== Notes ==== * If both S and R parameters are given, S takes precedence. diff --git a/M20.mediawiki b/M20.mediawiki index 097380f..3f7948c 100644 --- a/M20.mediawiki +++ b/M20.mediawiki @@ -1,7 +1,9 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = M20 This command produces output in DOS filename format similar to: 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~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.) ==== Notes ==== diff --git a/M200.mediawiki b/M200.mediawiki index 14e7027..846aefd 100644 --- a/M200.mediawiki +++ b/M200.mediawiki @@ -1,12 +1,14 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = M200 D2.9 -==== Arguments ==== += Arguments = T Extruder number. If omitted, uses the active extruder. D 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. diff --git a/M21.mediawiki b/M21.mediawiki index c1e9b4f..b54574a 100644 --- a/M21.mediawiki +++ b/M21.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Initialize the SD card reader. -==== Example ==== += Example = 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. 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. diff --git a/M22.mediawiki b/M22.mediawiki index 9a4e37e..2967d09 100644 --- a/M22.mediawiki +++ b/M22.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Release the SD card. -==== Example ==== += Example = M22 -==== Discussion ==== += Discussion = M22 tells the firmware to make the card reader unavailable for reading and printing. ==== Notes ==== diff --git a/M23.mediawiki b/M23.mediawiki index 65ebedb..e5fdaaf 100644 --- a/M23.mediawiki +++ b/M23.mediawiki @@ -1,12 +1,14 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Examples ==== += Examples = M23 /MISCEL~1/ARMCHAIR/ARMCHA~1.GCO M23 fishnetw.gco -==== Arguments ==== += Arguments = 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. diff --git a/M24.mediawiki b/M24.mediawiki index e70c648..151f010 100644 --- a/M24.mediawiki +++ b/M24.mediawiki @@ -1,8 +1,10 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Start printing the file selected with [[M23]]. -==== Example ==== += Example = 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. diff --git a/M25.mediawiki b/M25.mediawiki index f15e25f..7a79510 100644 --- a/M25.mediawiki +++ b/M25.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = 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) ==== Notes ==== diff --git a/M26.mediawiki b/M26.mediawiki index 9cafe2c..12fe047 100644 --- a/M26.mediawiki +++ b/M26.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = 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]]. ==== Notes ==== diff --git a/M27.mediawiki b/M27.mediawiki index 8251db4..696827e 100644 --- a/M27.mediawiki +++ b/M27.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Print the current SD file position. -==== Example ==== += Example = M27 '''SD printing byte 1242/23928''' -==== Description ==== += Description = The file must have been opened for reading with [[M23]] or writing with [[M28]]. diff --git a/M28.mediawiki b/M28.mediawiki index 250a470..a32ab50 100644 --- a/M28.mediawiki +++ b/M28.mediawiki @@ -1,11 +1,13 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = M28 path/to/newfile.gco -==== Arguments ==== += Arguments = 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. diff --git a/M29.mediawiki b/M29.mediawiki index e54b2eb..a046891 100644 --- a/M29.mediawiki +++ b/M29.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Examples ==== += Examples = M29 -==== Description ==== += Description = M29 finishes a file write begun with [[M28]]. ==== Notes ==== diff --git a/M30.mediawiki b/M30.mediawiki index 4f8b4ad..d339ecb 100644 --- a/M30.mediawiki +++ b/M30.mediawiki @@ -1,12 +1,14 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Delete a file on the SD card. -==== Examples ==== += Examples = M30 /MISCEL~1/ARMCHAIR/ARMCHA~1.GCO M30 auto0.g -==== Arguments ==== += Arguments = The full DOS 8.3 path to the file. The path is case-insensitive. -==== Discussion ==== += Discussion = M30 immediately deletes the file. Use with caution. diff --git a/M31.mediawiki b/M31.mediawiki index 56231f4..3d3b895 100644 --- a/M31.mediawiki +++ b/M31.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Examples ==== += Examples = M31 '''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. diff --git a/M32.mediawiki b/M32.mediawiki index cb596a1..cbd8737 100644 --- a/M32.mediawiki +++ b/M32.mediawiki @@ -1,11 +1,13 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Examples ==== += Examples = M32 !/MISCEL~1/ARMCHAIR/ARMCHA~1.GCO# M32 S1226 !fishnetw.gco# -==== Arguments ==== += Arguments = S The full DOS 8.3 path to the file. The path is case-insensitive. diff --git a/M400.mediawiki b/M400.mediawiki index 618de65..29f3e8c 100644 --- a/M400.mediawiki +++ b/M400.mediawiki @@ -1,11 +1,10 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' -==== Description ==== += Description = Wait for all moves to finish. -==== Example ==== += Example = M400 -==== Discussion ==== += Discussion = M400 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. diff --git a/M42.mediawiki b/M42.mediawiki index a019749..94c219f 100644 --- a/M42.mediawiki +++ b/M42.mediawiki @@ -1,3 +1,5 @@ +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + = Description = Directly change a hardware pin's state. If no pin is specified, the LED pin is assumed. = Example = diff --git a/M48.mediawiki b/M48.mediawiki index 880a720..cd42ca2 100644 --- a/M48.mediawiki +++ b/M48.mediawiki @@ -1,9 +1,12 @@ +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = M48 P4 X100 Y100 V2 E L2 -==== Arguments ==== += Arguments = P Number of sampled points (4-50, default 10) X Sample X position (current X if omitted) Y 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 L 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. ==== Notes ==== diff --git a/M500.mediawiki b/M500.mediawiki index 8512e2c..ca1d0aa 100644 --- a/M500.mediawiki +++ b/M500.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Store current settings to EEPROM. -==== Examples ==== += Examples = 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. ==== Notes ==== diff --git a/M501.mediawiki b/M501.mediawiki index eaa79d9..a9e1c10 100644 --- a/M501.mediawiki +++ b/M501.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' + += Description = Load stored settings from EEPROM. -==== Examples ==== += Examples = M501 -==== Discussion ==== += Discussion = This command gets the stored settings from EEPROM and immediately applies them. ==== Notes ==== diff --git a/M503.mediawiki b/M503.mediawiki index 41c96cf..8e46bba 100644 --- a/M503.mediawiki +++ b/M503.mediawiki @@ -1,14 +1,16 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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 S0 for plain G-code output that can be run to restore all settings. -==== Examples ==== += Examples = M503 ; Print current settings M503 S0 ; Print current settings as replayable G-code -==== Arguments ==== += Arguments = S 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. ==== Notes ==== diff --git a/M540.mediawiki b/M540.mediawiki index b5448d8..64c7eed 100644 --- a/M540.mediawiki +++ b/M540.mediawiki @@ -1,13 +1,15 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = M540 S1 -==== Arguments ==== += Arguments = S 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. ==== Notes ==== diff --git a/M80.mediawiki b/M80.mediawiki index a59846e..da05e58 100644 --- a/M80.mediawiki +++ b/M80.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = 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. ==== Notes ==== diff --git a/M81.mediawiki b/M81.mediawiki index e58a16a..c749aba 100644 --- a/M81.mediawiki +++ b/M81.mediawiki @@ -1,10 +1,12 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = 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. ==== Notes ==== diff --git a/M84.mediawiki b/M84.mediawiki index 30c3b9f..2908df2 100644 --- a/M84.mediawiki +++ b/M84.mediawiki @@ -1,13 +1,18 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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." -==== Examples ==== += Examples = M84 ; Disable steppers immediately (until the next move). 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. -==== Arguments ==== += Arguments = S 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 Y Flag to disable the Y 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. -==== Discussion ==== += Discussion = This command is used both to disable steppers (M18) 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 ==== diff --git a/M928.mediawiki b/M928.mediawiki index e063037..81293f3 100644 --- a/M928.mediawiki +++ b/M928.mediawiki @@ -1,11 +1,13 @@ -==== Description ==== +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
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. -==== Example ==== += Example = M928 path/to/logfile.gco -==== Arguments ==== += Arguments = 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. diff --git a/M999.mediawiki b/M999.mediawiki index 3ad6bd6..77c56bf 100644 --- a/M999.mediawiki +++ b/M999.mediawiki @@ -1,12 +1,12 @@ -==== DO NOT EDIT ==== -This page has been ported into the new documentation system. Please read [https://github.com/MarlinFirmware/Marlin/issues/3088 #3088] for more information. +'''''DO NOT EDIT THIS PAGE. The wiki is being ported to a new documentation system.
Please see [https://github.com/MarlinFirmware/Marlin/issues/3088 Issue #3088 "New Documentation"] for more information.''''' += Description = Resume after an error Stop. -==== Examples ==== += Examples = M999 -==== Discussion ==== += Discussion = 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 servo probe failed to engage or stow