My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

gcode.h 30KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /**
  23. * gcode.h - Temporary container for all gcode handlers
  24. */
  25. /**
  26. * -----------------
  27. * G-Codes in Marlin
  28. * -----------------
  29. *
  30. * Helpful G-code references:
  31. * - http://marlinfw.org/meta/gcode
  32. * - https://reprap.org/wiki/G-code
  33. * - http://linuxcnc.org/docs/html/gcode.html
  34. *
  35. * Help to document Marlin's G-codes online:
  36. * - https://github.com/MarlinFirmware/MarlinDocumentation
  37. *
  38. * -----------------
  39. *
  40. * "G" Codes
  41. *
  42. * G0 -> G1
  43. * G1 - Coordinated Movement X Y Z E
  44. * G2 - CW ARC
  45. * G3 - CCW ARC
  46. * G4 - Dwell S<seconds> or P<milliseconds>
  47. * G5 - Cubic B-spline with XYZE destination and IJPQ offsets
  48. * G10 - Retract filament according to settings of M207 (Requires FWRETRACT)
  49. * G11 - Retract recover filament according to settings of M208 (Requires FWRETRACT)
  50. * G12 - Clean tool (Requires NOZZLE_CLEAN_FEATURE)
  51. * G17 - Select Plane XY (Requires CNC_WORKSPACE_PLANES)
  52. * G18 - Select Plane ZX (Requires CNC_WORKSPACE_PLANES)
  53. * G19 - Select Plane YZ (Requires CNC_WORKSPACE_PLANES)
  54. * G20 - Set input units to inches (Requires INCH_MODE_SUPPORT)
  55. * G21 - Set input units to millimeters (Requires INCH_MODE_SUPPORT)
  56. * G26 - Mesh Validation Pattern (Requires G26_MESH_VALIDATION)
  57. * G27 - Park Nozzle (Requires NOZZLE_PARK_FEATURE)
  58. * G28 - Home one or more axes
  59. * G29 - Start or continue the bed leveling probe procedure (Requires bed leveling)
  60. * G30 - Single Z probe, probes bed at X Y location (defaults to current XY location)
  61. * G31 - Dock sled (Z_PROBE_SLED only)
  62. * G32 - Undock sled (Z_PROBE_SLED only)
  63. * G33 - Delta Auto-Calibration (Requires DELTA_AUTO_CALIBRATION)
  64. * G34 - Z Stepper automatic alignment using probe: I<iterations> T<accuracy> A<amplification> (Requires Z_STEPPER_AUTO_ALIGN)
  65. * G38 - Probe in any direction using the Z_MIN_PROBE (Requires G38_PROBE_TARGET)
  66. * G42 - Coordinated move to a mesh point (Requires MESH_BED_LEVELING, AUTO_BED_LEVELING_BLINEAR, or AUTO_BED_LEVELING_UBL)
  67. * G80 - Cancel current motion mode (Requires GCODE_MOTION_MODES)
  68. * G90 - Use Absolute Coordinates
  69. * G91 - Use Relative Coordinates
  70. * G92 - Set current position to coordinates given
  71. *
  72. * "M" Codes
  73. *
  74. * M0 - Unconditional stop - Wait for user to press a button on the LCD (Only if ULTRA_LCD is enabled)
  75. * M1 -> M0
  76. * M3 - Turn ON Laser | Spindle (clockwise), set Power | Speed. (Requires SPINDLE_FEATURE or LASER_FEATURE)
  77. * M4 - Turn ON Laser | Spindle (counter-clockwise), set Power | Speed. (Requires SPINDLE_FEATURE or LASER_FEATURE)
  78. * M5 - Turn OFF Laser | Spindle. (Requires SPINDLE_FEATURE or LASER_FEATURE)
  79. * M7 - Turn mist coolant ON. (Requires COOLANT_CONTROL)
  80. * M8 - Turn flood coolant ON. (Requires COOLANT_CONTROL)
  81. * M9 - Turn coolant OFF. (Requires COOLANT_CONTROL)
  82. * M12 - Set up closed loop control system. (Requires EXTERNAL_CLOSED_LOOP_CONTROLLER)
  83. * M17 - Enable/Power all stepper motors
  84. * M18 - Disable all stepper motors; same as M84
  85. * M20 - List SD card. (Requires SDSUPPORT)
  86. * M21 - Init SD card. (Requires SDSUPPORT)
  87. * M22 - Release SD card. (Requires SDSUPPORT)
  88. * M23 - Select SD file: "M23 /path/file.gco". (Requires SDSUPPORT)
  89. * M24 - Start/resume SD print. (Requires SDSUPPORT)
  90. * M25 - Pause SD print. (Requires SDSUPPORT)
  91. * M26 - Set SD position in bytes: "M26 S12345". (Requires SDSUPPORT)
  92. * M27 - Report SD print status. (Requires SDSUPPORT)
  93. * OR, with 'S<seconds>' set the SD status auto-report interval. (Requires AUTO_REPORT_SD_STATUS)
  94. * OR, with 'C' get the current filename.
  95. * M28 - Start SD write: "M28 /path/file.gco". (Requires SDSUPPORT)
  96. * M29 - Stop SD write. (Requires SDSUPPORT)
  97. * M30 - Delete file from SD: "M30 /path/file.gco"
  98. * M31 - Report time since last M109 or SD card start to serial.
  99. * M32 - Select file and start SD print: "M32 [S<bytepos>] !/path/file.gco#". (Requires SDSUPPORT)
  100. * Use P to run other files as sub-programs: "M32 P !filename#"
  101. * The '#' is necessary when calling from within sd files, as it stops buffer prereading
  102. * M33 - Get the longname version of a path. (Requires LONG_FILENAME_HOST_SUPPORT)
  103. * M34 - Set SD Card sorting options. (Requires SDCARD_SORT_ALPHA)
  104. * M42 - Change pin status via gcode: M42 P<pin> S<value>. LED pin assumed if P is omitted.
  105. * M43 - Display pin status, watch pins for changes, watch endstops & toggle LED, Z servo probe test, toggle pins
  106. * M48 - Measure Z Probe repeatability: M48 P<points> X<pos> Y<pos> V<level> E<engage> L<legs> S<chizoid>. (Requires Z_MIN_PROBE_REPEATABILITY_TEST)
  107. * M73 - Set the progress percentage. (Requires LCD_SET_PROGRESS_MANUALLY)
  108. * M75 - Start the print job timer.
  109. * M76 - Pause the print job timer.
  110. * M77 - Stop the print job timer.
  111. * M78 - Show statistical information about the print jobs. (Requires PRINTCOUNTER)
  112. * M80 - Turn on Power Supply. (Requires POWER_SUPPLY > 0)
  113. * M81 - Turn off Power Supply. (Requires POWER_SUPPLY > 0)
  114. * M82 - Set E codes absolute (default).
  115. * M83 - Set E codes relative while in Absolute (G90) mode.
  116. * M84 - Disable steppers until next move, or use S<seconds> to specify an idle
  117. * duration after which steppers should turn off. S0 disables the timeout.
  118. * M85 - Set inactivity shutdown timer with parameter S<seconds>. To disable set zero (default)
  119. * M92 - Set planner.settings.axis_steps_per_mm for one or more axes.
  120. * M100 - Watch Free Memory (for debugging) (Requires M100_FREE_MEMORY_WATCHER)
  121. * M104 - Set extruder target temp.
  122. * M105 - Report current temperatures.
  123. * M106 - Set print fan speed.
  124. * M107 - Print fan off.
  125. * M108 - Break out of heating loops (M109, M190, M303). With no controller, breaks out of M0/M1. (Requires EMERGENCY_PARSER)
  126. * M109 - S<temp> Wait for extruder current temp to reach target temp. ** Wait only when heating! **
  127. * R<temp> Wait for extruder current temp to reach target temp. ** Wait for heating or cooling. **
  128. * If AUTOTEMP is enabled, S<mintemp> B<maxtemp> F<factor>. Exit autotemp by any M109 without F
  129. * M110 - Set the current line number. (Used by host printing)
  130. * M111 - Set debug flags: "M111 S<flagbits>". See flag bits defined in enum.h.
  131. * M112 - Emergency stop.
  132. * M113 - Get or set the timeout interval for Host Keepalive "busy" messages. (Requires HOST_KEEPALIVE_FEATURE)
  133. * M114 - Report current position.
  134. * M115 - Report capabilities. (Extended capabilities requires EXTENDED_CAPABILITIES_REPORT)
  135. * M117 - Display a message on the controller screen. (Requires an LCD)
  136. * M118 - Display a message in the host console.
  137. * M119 - Report endstops status.
  138. * M120 - Enable endstops detection.
  139. * M121 - Disable endstops detection.
  140. * M122 - Debug stepper (Requires at least one _DRIVER_TYPE defined as TMC2130/2160/5130/5160/2208/2209/2660 or L6470)
  141. * M125 - Save current position and move to filament change position. (Requires PARK_HEAD_ON_PAUSE)
  142. * M126 - Solenoid Air Valve Open. (Requires BARICUDA)
  143. * M127 - Solenoid Air Valve Closed. (Requires BARICUDA)
  144. * M128 - EtoP Open. (Requires BARICUDA)
  145. * M129 - EtoP Closed. (Requires BARICUDA)
  146. * M140 - Set bed target temp. S<temp>
  147. * M141 - Set heated chamber target temp. S<temp> (Requires a chamber heater)
  148. * M145 - Set heatup values for materials on the LCD. H<hotend> B<bed> F<fan speed> for S<material> (0=PLA, 1=ABS)
  149. * M149 - Set temperature units. (Requires TEMPERATURE_UNITS_SUPPORT)
  150. * M150 - Set Status LED Color as R<red> U<green> B<blue> P<bright>. Values 0-255. (Requires BLINKM, RGB_LED, RGBW_LED, NEOPIXEL_LED, PCA9533, or PCA9632).
  151. * M155 - Auto-report temperatures with interval of S<seconds>. (Requires AUTO_REPORT_TEMPERATURES)
  152. * M163 - Set a single proportion for a mixing extruder. (Requires MIXING_EXTRUDER)
  153. * M164 - Commit the mix and save to a virtual tool (current, or as specified by 'S'). (Requires MIXING_EXTRUDER)
  154. * M165 - Set the mix for the mixing extruder (and current virtual tool) with parameters ABCDHI. (Requires MIXING_EXTRUDER and DIRECT_MIXING_IN_G1)
  155. * M166 - Set the Gradient Mix for the mixing extruder. (Requires GRADIENT_MIX)
  156. * M190 - S<temp> Wait for bed current temp to reach target temp. ** Wait only when heating! **
  157. * R<temp> Wait for bed current temp to reach target temp. ** Wait for heating or cooling. **
  158. * M200 - Set filament diameter, D<diameter>, setting E axis units to cubic. (Use S0 to revert to linear units.)
  159. * M201 - Set max acceleration in units/s^2 for print moves: "M201 X<accel> Y<accel> Z<accel> E<accel>"
  160. * M202 - Set max acceleration in units/s^2 for travel moves: "M202 X<accel> Y<accel> Z<accel> E<accel>" ** UNUSED IN MARLIN! **
  161. * M203 - Set maximum feedrate: "M203 X<fr> Y<fr> Z<fr> E<fr>" in units/sec.
  162. * M204 - Set default acceleration in units/sec^2: P<printing> R<extruder_only> T<travel>
  163. * M205 - Set advanced settings. Current units apply:
  164. S<print> T<travel> minimum speeds
  165. B<minimum segment time>
  166. X<max X jerk>, Y<max Y jerk>, Z<max Z jerk>, E<max E jerk>
  167. * M206 - Set additional homing offset. (Disabled by NO_WORKSPACE_OFFSETS or DELTA)
  168. * M207 - Set Retract Length: S<length>, Feedrate: F<units/min>, and Z lift: Z<distance>. (Requires FWRETRACT)
  169. * M208 - Set Recover (unretract) Additional (!) Length: S<length> and Feedrate: F<units/min>. (Requires FWRETRACT)
  170. * M209 - Turn Automatic Retract Detection on/off: S<0|1> (For slicers that don't support G10/11). (Requires FWRETRACT_AUTORETRACT)
  171. Every normal extrude-only move will be classified as retract depending on the direction.
  172. * M211 - Enable, Disable, and/or Report software endstops: S<0|1> (Requires MIN_SOFTWARE_ENDSTOPS or MAX_SOFTWARE_ENDSTOPS)
  173. * M217 - Set filament swap parameters: "M217 S<length> P<feedrate> R<feedrate>". (Requires SINGLENOZZLE)
  174. * M218 - Set/get a tool offset: "M218 T<index> X<offset> Y<offset>". (Requires 2 or more extruders)
  175. * M220 - Set Feedrate Percentage: "M220 S<percent>" (i.e., "FR" on the LCD)
  176. * M221 - Set Flow Percentage: "M221 S<percent>"
  177. * M226 - Wait until a pin is in a given state: "M226 P<pin> S<state>"
  178. * M240 - Trigger a camera to take a photograph. (Requires PHOTO_GCODE)
  179. * M250 - Set LCD contrast: "M250 C<contrast>" (0-63). (Requires LCD support)
  180. * M260 - i2c Send Data (Requires EXPERIMENTAL_I2CBUS)
  181. * M261 - i2c Request Data (Requires EXPERIMENTAL_I2CBUS)
  182. * M280 - Set servo position absolute: "M280 P<index> S<angle|µs>". (Requires servos)
  183. * M281 - Set servo min|max position: "M281 P<index> L<min> U<max>". (Requires EDITABLE_SERVO_ANGLES)
  184. * M290 - Babystepping (Requires BABYSTEPPING)
  185. * M300 - Play beep sound S<frequency Hz> P<duration ms>
  186. * M301 - Set PID parameters P I and D. (Requires PIDTEMP)
  187. * M302 - Allow cold extrudes, or set the minimum extrude S<temperature>. (Requires PREVENT_COLD_EXTRUSION)
  188. * M303 - PID relay autotune S<temperature> sets the target temperature. Default 150C. (Requires PIDTEMP)
  189. * M304 - Set bed PID parameters P I and D. (Requires PIDTEMPBED)
  190. * M305 - Set user thermistor parameters R T and P. (Requires TEMP_SENSOR_x 1000)
  191. * M350 - Set microstepping mode. (Requires digital microstepping pins.)
  192. * M351 - Toggle MS1 MS2 pins directly. (Requires digital microstepping pins.)
  193. * M355 - Set Case Light on/off and set brightness. (Requires CASE_LIGHT_PIN)
  194. * M380 - Activate solenoid on active extruder. (Requires EXT_SOLENOID)
  195. * M381 - Disable all solenoids. (Requires EXT_SOLENOID)
  196. * M400 - Finish all moves.
  197. * M401 - Deploy and activate Z probe. (Requires a probe)
  198. * M402 - Deactivate and stow Z probe. (Requires a probe)
  199. * M403 - Set filament type for PRUSA MMU2
  200. * M404 - Display or set the Nominal Filament Width: "W<diameter>". (Requires FILAMENT_WIDTH_SENSOR)
  201. * M405 - Enable Filament Sensor flow control. "M405 D<delay_cm>". (Requires FILAMENT_WIDTH_SENSOR)
  202. * M406 - Disable Filament Sensor flow control. (Requires FILAMENT_WIDTH_SENSOR)
  203. * M407 - Display measured filament diameter in millimeters. (Requires FILAMENT_WIDTH_SENSOR)
  204. * M410 - Quickstop. Abort all planned moves.
  205. * M412 - Enable / Disable Filament Runout Detection. (Requires FILAMENT_RUNOUT_SENSOR)
  206. * M413 - Enable / Disable Power-Loss Recovery. (Requires POWER_LOSS_RECOVERY)
  207. * M420 - Enable/Disable Leveling (with current values) S1=enable S0=disable (Requires MESH_BED_LEVELING or ABL)
  208. * M421 - Set a single Z coordinate in the Mesh Leveling grid. X<units> Y<units> Z<units> (Requires MESH_BED_LEVELING, AUTO_BED_LEVELING_BILINEAR, or AUTO_BED_LEVELING_UBL)
  209. * M422 - Set Z Stepper automatic alignment position using probe. X<units> Y<units> A<axis> (Requires Z_STEPPER_AUTO_ALIGN)
  210. * M425 - Enable/Disable and tune backlash correction. (Requires BACKLASH_COMPENSATION and BACKLASH_GCODE)
  211. * M428 - Set the home_offset based on the current_position. Nearest edge applies. (Disabled by NO_WORKSPACE_OFFSETS or DELTA)
  212. * M500 - Store parameters in EEPROM. (Requires EEPROM_SETTINGS)
  213. * M501 - Restore parameters from EEPROM. (Requires EEPROM_SETTINGS)
  214. * M502 - Revert to the default "factory settings". ** Does not write them to EEPROM! **
  215. * M503 - Print the current settings (in memory): "M503 S<verbose>". S0 specifies compact output.
  216. * M504 - Validate EEPROM contents. (Requires EEPROM_SETTINGS)
  217. * M524 - Abort the current SD print job started with M24. (Requires SDSUPPORT)
  218. * M540 - Enable/disable SD card abort on endstop hit: "M540 S<state>". (Requires SD_ABORT_ON_ENDSTOP_HIT)
  219. * M569 - Enable stealthChop on an axis. (Requires at least one _DRIVER_TYPE to be TMC2130/2160/2208/2209/5130/5160)
  220. * M600 - Pause for filament change: "M600 X<pos> Y<pos> Z<raise> E<first_retract> L<later_retract>". (Requires ADVANCED_PAUSE_FEATURE)
  221. * M603 - Configure filament change: "M603 T<tool> U<unload_length> L<load_length>". (Requires ADVANCED_PAUSE_FEATURE)
  222. * M605 - Set Dual X-Carriage movement mode: "M605 S<mode> [X<x_offset>] [R<temp_offset>]". (Requires DUAL_X_CARRIAGE)
  223. * M665 - Set delta configurations: "M665 H<delta height> L<diagonal rod> R<delta radius> S<segments/s> B<calibration radius> X<Alpha angle trim> Y<Beta angle trim> Z<Gamma angle trim> (Requires DELTA)
  224. * M666 - Set/get offsets for delta (Requires DELTA) or dual endstops (Requires [XYZ]_DUAL_ENDSTOPS).
  225. * M701 - Load filament (Requires FILAMENT_LOAD_UNLOAD_GCODES)
  226. * M702 - Unload filament (Requires FILAMENT_LOAD_UNLOAD_GCODES)
  227. * M810-M819 - Define/execute a G-code macro (Requires GCODE_MACROS)
  228. * M851 - Set Z probe's Z offset in current units. (Negative = below the nozzle.)
  229. * M852 - Set skew factors: "M852 [I<xy>] [J<xz>] [K<yz>]". (Requires SKEW_CORRECTION_GCODE, and SKEW_CORRECTION_FOR_Z for IJ)
  230. * M860 - Report the position of position encoder modules.
  231. * M861 - Report the status of position encoder modules.
  232. * M862 - Perform an axis continuity test for position encoder modules.
  233. * M863 - Perform steps-per-mm calibration for position encoder modules.
  234. * M864 - Change position encoder module I2C address.
  235. * M865 - Check position encoder module firmware version.
  236. * M866 - Report or reset position encoder module error count.
  237. * M867 - Enable/disable or toggle error correction for position encoder modules.
  238. * M868 - Report or set position encoder module error correction threshold.
  239. * M869 - Report position encoder module error.
  240. * M876 - Handle Prompt Response. (Requires HOST_PROMPT_SUPPORT and not EMERGENCY_PARSER)
  241. * M900 - Get or Set Linear Advance K-factor. (Requires LIN_ADVANCE)
  242. * M906 - Set or get motor current in milliamps using axis codes X, Y, Z, E. Report values if no axis codes given. (Requires at least one _DRIVER_TYPE defined as TMC2130/2160/5130/5160/2208/2209/2660 or L6470)
  243. * M907 - Set digital trimpot motor current using axis codes. (Requires a board with digital trimpots)
  244. * M908 - Control digital trimpot directly. (Requires DAC_STEPPER_CURRENT or DIGIPOTSS_PIN)
  245. * M909 - Print digipot/DAC current value. (Requires DAC_STEPPER_CURRENT)
  246. * M910 - Commit digipot/DAC value to external EEPROM via I2C. (Requires DAC_STEPPER_CURRENT)
  247. * M911 - Report stepper driver overtemperature pre-warn condition. (Requires at least one _DRIVER_TYPE defined as TMC2130/2160/5130/5160/2208/2209/2660)
  248. * M912 - Clear stepper driver overtemperature pre-warn condition flag. (Requires at least one _DRIVER_TYPE defined as TMC2130/2160/5130/5160/2208/2209/2660)
  249. * M913 - Set HYBRID_THRESHOLD speed. (Requires HYBRID_THRESHOLD)
  250. * M914 - Set StallGuard sensitivity. (Requires SENSORLESS_HOMING or SENSORLESS_PROBING)
  251. * M916 - L6470 tuning: Increase KVAL_HOLD until thermal warning. (Requires at least one _DRIVER_TYPE L6470)
  252. * M917 - L6470 tuning: Find minimum current thresholds. (Requires at least one _DRIVER_TYPE L6470)
  253. * M918 - L6470 tuning: Increase speed until max or error. (Requires at least one _DRIVER_TYPE L6470)
  254. * M951 - Set Magnetic Parking Extruder parameters. (Requires MAGNETIC_PARKING_EXTRUDER)
  255. * M7219 - Control Max7219 Matrix LEDs. (Requires MAX7219_GCODE)
  256. *
  257. * M360 - SCARA calibration: Move to cal-position ThetaA (0 deg calibration)
  258. * M361 - SCARA calibration: Move to cal-position ThetaB (90 deg calibration - steps per degree)
  259. * M362 - SCARA calibration: Move to cal-position PsiA (0 deg calibration)
  260. * M363 - SCARA calibration: Move to cal-position PsiB (90 deg calibration - steps per degree)
  261. * M364 - SCARA calibration: Move to cal-position PSIC (90 deg to Theta calibration position)
  262. *
  263. * ************ Custom codes - This can change to suit future G-code regulations
  264. * G425 - Calibrate using a conductive object. (Requires CALIBRATION_GCODE)
  265. * M928 - Start SD logging: "M928 filename.gco". Stop with M29. (Requires SDSUPPORT)
  266. * M997 - Perform in-application firmware update
  267. * M999 - Restart after being stopped by error
  268. *
  269. * "T" Codes
  270. *
  271. * T0-T3 - Select an extruder (tool) by index: "T<n> F<units/min>"
  272. *
  273. */
  274. #pragma once
  275. #include "../inc/MarlinConfig.h"
  276. #include "parser.h"
  277. #if ENABLED(I2C_POSITION_ENCODERS)
  278. #include "../feature/I2CPositionEncoder.h"
  279. #endif
  280. class GcodeSuite {
  281. public:
  282. GcodeSuite() {}
  283. static bool axis_relative_modes[];
  284. #if ENABLED(CNC_WORKSPACE_PLANES)
  285. /**
  286. * Workspace planes only apply to G2/G3 moves
  287. * (and "canned cycles" - not a current feature)
  288. */
  289. enum WorkspacePlane : char { PLANE_XY, PLANE_ZX, PLANE_YZ };
  290. static WorkspacePlane workspace_plane;
  291. #endif
  292. #define MAX_COORDINATE_SYSTEMS 9
  293. #if ENABLED(CNC_COORDINATE_SYSTEMS)
  294. static int8_t active_coordinate_system;
  295. static float coordinate_system[MAX_COORDINATE_SYSTEMS][XYZ];
  296. static bool select_coordinate_system(const int8_t _new);
  297. #endif
  298. static millis_t previous_move_ms;
  299. FORCE_INLINE static void reset_stepper_timeout() { previous_move_ms = millis(); }
  300. static int8_t get_target_extruder_from_command();
  301. static int8_t get_target_e_stepper_from_command();
  302. static void get_destination_from_command();
  303. static void process_parsed_command(const bool no_ok=false);
  304. static void process_next_command();
  305. // Execute G-code in-place, preserving current G-code parameters
  306. static void process_subcommands_now_P(PGM_P pgcode);
  307. static void process_subcommands_now(char * gcode);
  308. static inline void home_all_axes() { process_subcommands_now_P(PSTR("G28")); }
  309. #if ENABLED(HOST_KEEPALIVE_FEATURE)
  310. /**
  311. * States for managing Marlin and host communication
  312. * Marlin sends messages if blocked or busy
  313. */
  314. enum MarlinBusyState : char {
  315. NOT_BUSY, // Not in a handler
  316. IN_HANDLER, // Processing a GCode
  317. IN_PROCESS, // Known to be blocking command input (as in G29)
  318. PAUSED_FOR_USER, // Blocking pending any input
  319. PAUSED_FOR_INPUT // Blocking pending text input (concept)
  320. };
  321. static MarlinBusyState busy_state;
  322. static uint8_t host_keepalive_interval;
  323. static void host_keepalive();
  324. #define KEEPALIVE_STATE(n) gcode.busy_state = gcode.n
  325. #else
  326. #define KEEPALIVE_STATE(n) NOOP
  327. #endif
  328. static void dwell(millis_t time);
  329. private:
  330. static void G0_G1(
  331. #if IS_SCARA || defined(G0_FEEDRATE)
  332. bool fast_move=false
  333. #endif
  334. );
  335. #if ENABLED(ARC_SUPPORT)
  336. static void G2_G3(const bool clockwise);
  337. #endif
  338. static void G4();
  339. #if ENABLED(BEZIER_CURVE_SUPPORT)
  340. static void G5();
  341. #endif
  342. #if ENABLED(FWRETRACT)
  343. static void G10();
  344. static void G11();
  345. #endif
  346. #if ENABLED(NOZZLE_CLEAN_FEATURE)
  347. static void G12();
  348. #endif
  349. #if ENABLED(CNC_WORKSPACE_PLANES)
  350. static void G17();
  351. static void G18();
  352. static void G19();
  353. #endif
  354. #if ENABLED(INCH_MODE_SUPPORT)
  355. static void G20();
  356. static void G21();
  357. #endif
  358. #if ENABLED(G26_MESH_VALIDATION)
  359. static void G26();
  360. #endif
  361. #if ENABLED(NOZZLE_PARK_FEATURE)
  362. static void G27();
  363. #endif
  364. static void G28(const bool always_home_all);
  365. #if HAS_LEVELING
  366. #if ENABLED(G29_RETRY_AND_RECOVER)
  367. static void G29_with_retry();
  368. #define G29_TYPE bool
  369. #else
  370. #define G29_TYPE void
  371. #endif
  372. static G29_TYPE G29();
  373. #endif
  374. #if HAS_BED_PROBE
  375. static void G30();
  376. #if ENABLED(Z_PROBE_SLED)
  377. static void G31();
  378. static void G32();
  379. #endif
  380. #endif
  381. #if ENABLED(DELTA_AUTO_CALIBRATION)
  382. static void G33();
  383. #endif
  384. #if ENABLED(Z_STEPPER_AUTO_ALIGN)
  385. static void G34();
  386. static void M422();
  387. #endif
  388. #if ENABLED(G38_PROBE_TARGET)
  389. static void G38(const int8_t subcode);
  390. #endif
  391. #if HAS_MESH
  392. static void G42();
  393. #endif
  394. #if ENABLED(CNC_COORDINATE_SYSTEMS)
  395. static void G53();
  396. static void G54();
  397. static void G55();
  398. static void G56();
  399. static void G57();
  400. static void G58();
  401. static void G59();
  402. #endif
  403. #if ENABLED(GCODE_MOTION_MODES)
  404. static void G80();
  405. #endif
  406. static void G92();
  407. #if ENABLED(CALIBRATION_GCODE)
  408. static void G425();
  409. #endif
  410. #if HAS_RESUME_CONTINUE
  411. static void M0_M1();
  412. #endif
  413. #if HAS_CUTTER
  414. static void M3_M4(const bool is_M4);
  415. static void M5();
  416. #endif
  417. #if ENABLED(COOLANT_CONTROL)
  418. #if ENABLED(COOLANT_MIST)
  419. static void M7();
  420. #endif
  421. #if ENABLED(COOLANT_FLOOD)
  422. static void M8();
  423. #endif
  424. static void M9();
  425. #endif
  426. #if ENABLED(EXTERNAL_CLOSED_LOOP_CONTROLLER)
  427. static void M12();
  428. #endif
  429. static void M17();
  430. static void M18_M84();
  431. #if ENABLED(SDSUPPORT)
  432. static void M20();
  433. static void M21();
  434. static void M22();
  435. static void M23();
  436. static void M24();
  437. static void M25();
  438. static void M26();
  439. static void M27();
  440. static void M28();
  441. static void M29();
  442. static void M30();
  443. #endif
  444. static void M31();
  445. #if ENABLED(SDSUPPORT)
  446. static void M32();
  447. #if ENABLED(LONG_FILENAME_HOST_SUPPORT)
  448. static void M33();
  449. #endif
  450. #if BOTH(SDCARD_SORT_ALPHA, SDSORT_GCODE)
  451. static void M34();
  452. #endif
  453. #endif
  454. static void M42();
  455. #if ENABLED(PINS_DEBUGGING)
  456. static void M43();
  457. #endif
  458. #if ENABLED(Z_MIN_PROBE_REPEATABILITY_TEST)
  459. static void M48();
  460. #endif
  461. #if ENABLED(LCD_SET_PROGRESS_MANUALLY)
  462. static void M73();
  463. #endif
  464. static void M75();
  465. static void M76();
  466. static void M77();
  467. #if ENABLED(PRINTCOUNTER)
  468. static void M78();
  469. #endif
  470. #if HAS_POWER_SWITCH
  471. static void M80();
  472. #endif
  473. static void M81();
  474. static void M82();
  475. static void M83();
  476. static void M85();
  477. static void M92();
  478. #if ENABLED(M100_FREE_MEMORY_WATCHER)
  479. static void M100();
  480. #endif
  481. static void M104();
  482. static void M105();
  483. static void M106();
  484. static void M107();
  485. #if DISABLED(EMERGENCY_PARSER)
  486. static void M108();
  487. static void M112();
  488. static void M410();
  489. #if ENABLED(HOST_PROMPT_SUPPORT)
  490. static void M876();
  491. #endif
  492. #endif
  493. static void M109();
  494. static void M110();
  495. static void M111();
  496. #if ENABLED(HOST_KEEPALIVE_FEATURE)
  497. static void M113();
  498. #endif
  499. static void M114();
  500. static void M115();
  501. static void M117();
  502. static void M118();
  503. static void M119();
  504. static void M120();
  505. static void M121();
  506. #if ENABLED(PARK_HEAD_ON_PAUSE)
  507. static void M125();
  508. #endif
  509. #if ENABLED(BARICUDA)
  510. #if HAS_HEATER_1
  511. static void M126();
  512. static void M127();
  513. #endif
  514. #if HAS_HEATER_2
  515. static void M128();
  516. static void M129();
  517. #endif
  518. #endif
  519. #if HAS_HEATED_BED
  520. static void M140();
  521. static void M190();
  522. #endif
  523. #if HAS_HEATED_CHAMBER
  524. static void M141();
  525. //static void M191();
  526. #endif
  527. #if HAS_LCD_MENU
  528. static void M145();
  529. #endif
  530. #if ENABLED(TEMPERATURE_UNITS_SUPPORT)
  531. static void M149();
  532. #endif
  533. #if HAS_COLOR_LEDS
  534. static void M150();
  535. #endif
  536. #if ENABLED(AUTO_REPORT_TEMPERATURES) && HAS_TEMP_SENSOR
  537. static void M155();
  538. #endif
  539. #if ENABLED(MIXING_EXTRUDER)
  540. static void M163();
  541. static void M164();
  542. #if ENABLED(DIRECT_MIXING_IN_G1)
  543. static void M165();
  544. #endif
  545. #if ENABLED(GRADIENT_MIX)
  546. static void M166();
  547. #endif
  548. #endif
  549. static void M200();
  550. static void M201();
  551. #if 0
  552. static void M202(); // Not used for Sprinter/grbl gen6
  553. #endif
  554. static void M203();
  555. static void M204();
  556. static void M205();
  557. #if HAS_M206_COMMAND
  558. static void M206();
  559. #endif
  560. #if ENABLED(FWRETRACT)
  561. static void M207();
  562. static void M208();
  563. #if ENABLED(FWRETRACT_AUTORETRACT)
  564. static void M209();
  565. #endif
  566. #endif
  567. static void M211();
  568. #if EXTRUDERS > 1
  569. static void M217();
  570. #endif
  571. #if HAS_HOTEND_OFFSET
  572. static void M218();
  573. #endif
  574. static void M220();
  575. static void M221();
  576. static void M226();
  577. #if ENABLED(PHOTO_GCODE)
  578. static void M240();
  579. #endif
  580. #if HAS_LCD_CONTRAST
  581. static void M250();
  582. #endif
  583. #if ENABLED(EXPERIMENTAL_I2CBUS)
  584. static void M260();
  585. static void M261();
  586. #endif
  587. #if HAS_SERVOS
  588. static void M280();
  589. #if ENABLED(EDITABLE_SERVO_ANGLES)
  590. static void M281();
  591. #endif
  592. #endif
  593. #if ENABLED(BABYSTEPPING)
  594. static void M290();
  595. #endif
  596. #if HAS_BUZZER
  597. static void M300();
  598. #endif
  599. #if ENABLED(PIDTEMP)
  600. static void M301();
  601. #endif
  602. #if ENABLED(PREVENT_COLD_EXTRUSION)
  603. static void M302();
  604. #endif
  605. #if HAS_PID_HEATING
  606. static void M303();
  607. #endif
  608. #if ENABLED(PIDTEMPBED)
  609. static void M304();
  610. #endif
  611. #if HAS_USER_THERMISTORS
  612. static void M305();
  613. #endif
  614. #if HAS_MICROSTEPS
  615. static void M350();
  616. static void M351();
  617. #endif
  618. #if HAS_CASE_LIGHT
  619. static void M355();
  620. #endif
  621. #if ENABLED(MORGAN_SCARA)
  622. static bool M360();
  623. static bool M361();
  624. static bool M362();
  625. static bool M363();
  626. static bool M364();
  627. #endif
  628. #if EITHER(EXT_SOLENOID, MANUAL_SOLENOID_CONTROL)
  629. static void M380();
  630. static void M381();
  631. #endif
  632. static void M400();
  633. #if HAS_BED_PROBE
  634. static void M401();
  635. static void M402();
  636. #endif
  637. #if ENABLED(PRUSA_MMU2)
  638. static void M403();
  639. #endif
  640. #if ENABLED(FILAMENT_WIDTH_SENSOR)
  641. static void M404();
  642. static void M405();
  643. static void M406();
  644. static void M407();
  645. #endif
  646. #if HAS_FILAMENT_SENSOR
  647. static void M412();
  648. #endif
  649. #if HAS_LEVELING
  650. static void M420();
  651. static void M421();
  652. #endif
  653. #if ENABLED(BACKLASH_GCODE)
  654. static void M425();
  655. #endif
  656. #if HAS_M206_COMMAND
  657. static void M428();
  658. #endif
  659. static void M500();
  660. static void M501();
  661. static void M502();
  662. #if DISABLED(DISABLE_M503)
  663. static void M503();
  664. #endif
  665. #if ENABLED(EEPROM_SETTINGS)
  666. static void M504();
  667. #endif
  668. #if ENABLED(SDSUPPORT)
  669. static void M524();
  670. #endif
  671. #if ENABLED(SD_ABORT_ON_ENDSTOP_HIT)
  672. static void M540();
  673. #endif
  674. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  675. static void M600();
  676. static void M603();
  677. #endif
  678. #if HAS_DUPLICATION_MODE
  679. static void M605();
  680. #endif
  681. #if IS_KINEMATIC
  682. static void M665();
  683. #endif
  684. #if ENABLED(DELTA) || HAS_EXTRA_ENDSTOPS
  685. static void M666();
  686. #endif
  687. #if ENABLED(FILAMENT_LOAD_UNLOAD_GCODES)
  688. static void M701();
  689. static void M702();
  690. #endif
  691. #if ENABLED(GCODE_MACROS)
  692. static void M810_819();
  693. #endif
  694. #if HAS_BED_PROBE
  695. static void M851();
  696. #endif
  697. #if ENABLED(SKEW_CORRECTION_GCODE)
  698. static void M852();
  699. #endif
  700. #if ENABLED(I2C_POSITION_ENCODERS)
  701. FORCE_INLINE static void M860() { I2CPEM.M860(); }
  702. FORCE_INLINE static void M861() { I2CPEM.M861(); }
  703. FORCE_INLINE static void M862() { I2CPEM.M862(); }
  704. FORCE_INLINE static void M863() { I2CPEM.M863(); }
  705. FORCE_INLINE static void M864() { I2CPEM.M864(); }
  706. FORCE_INLINE static void M865() { I2CPEM.M865(); }
  707. FORCE_INLINE static void M866() { I2CPEM.M866(); }
  708. FORCE_INLINE static void M867() { I2CPEM.M867(); }
  709. FORCE_INLINE static void M868() { I2CPEM.M868(); }
  710. FORCE_INLINE static void M869() { I2CPEM.M869(); }
  711. #endif
  712. #if ENABLED(LIN_ADVANCE)
  713. static void M900();
  714. #endif
  715. #if HAS_TRINAMIC
  716. static void M122();
  717. static void M906();
  718. #if HAS_STEALTHCHOP
  719. static void M569();
  720. #endif
  721. #if ENABLED(MONITOR_DRIVER_STATUS)
  722. static void M911();
  723. static void M912();
  724. #endif
  725. #if ENABLED(HYBRID_THRESHOLD)
  726. static void M913();
  727. #endif
  728. #if USE_SENSORLESS
  729. static void M914();
  730. #endif
  731. #endif
  732. #if HAS_DRIVER(L6470)
  733. static void M122();
  734. static void M906();
  735. static void M916();
  736. static void M917();
  737. static void M918();
  738. #endif
  739. #if HAS_DIGIPOTSS || HAS_MOTOR_CURRENT_PWM || EITHER(DIGIPOT_I2C, DAC_STEPPER_CURRENT)
  740. static void M907();
  741. #if HAS_DIGIPOTSS || ENABLED(DAC_STEPPER_CURRENT)
  742. static void M908();
  743. #if ENABLED(DAC_STEPPER_CURRENT)
  744. static void M909();
  745. static void M910();
  746. #endif
  747. #endif
  748. #endif
  749. #if ENABLED(SDSUPPORT)
  750. static void M928();
  751. #endif
  752. #if ENABLED(MAGNETIC_PARKING_EXTRUDER)
  753. static void M951();
  754. #endif
  755. #if ENABLED(PLATFORM_M997_SUPPORT)
  756. static void M997();
  757. #endif
  758. static void M999();
  759. #if ENABLED(POWER_LOSS_RECOVERY)
  760. static void M413();
  761. static void M1000();
  762. #endif
  763. #if ENABLED(MAX7219_GCODE)
  764. static void M7219();
  765. #endif
  766. static void T(const uint8_t tool_index);
  767. };
  768. extern GcodeSuite gcode;