From 736548ba56bf43ac90ab2f3e5b192bf3467a176b Mon Sep 17 00:00:00 2001 From: Costas Basdekis Date: Wed, 9 Feb 2022 09:43:18 +0000 Subject: [PATCH] Update documentation --- .../static/js/all_codes.js | 3159 ++--------------- 1 file changed, 210 insertions(+), 2949 deletions(-) diff --git a/octoprint_marlingcodedocumentation/static/js/all_codes.js b/octoprint_marlingcodedocumentation/static/js/all_codes.js index d30cf54..d2bdc80 100644 --- a/octoprint_marlingcodedocumentation/static/js/all_codes.js +++ b/octoprint_marlingcodedocumentation/static/js/all_codes.js @@ -10,692 +10,246 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "This command terminates the manual probing tool", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" + "url": "https://www.klipper3d.org/G-Codes.html#manual_probe_1" } ], - "ACCELEROMETER_DEBUG_READ": [ + "ACCEPT": [ { - "brief": "queries ADXL345 register", + "brief": "This command accepts the current Z position and concludes the manual probing tool.", "codes": [ - "ACCELEROMETER_DEBUG_READ" + "ACCEPT" ], - "id": "Klipper.ACCELEROMETER_DEBUG_READ[0]", - "parameters": [ - { - "description": "", - "label": "CHIP=", - "optional": true, - "tag": "CHIP", - "values": [] - }, - { - "description": "", - "label": "REG=", - "optional": false, - "tag": "REG", - "values": [] - } + "id": "Klipper.ACCEPT[0]", + "parameters": [], + "related": [], + "source": "Klipper", + "title": "This command accepts the current Z position and concludes the manual probing tool", + "url": "https://www.klipper3d.org/G-Codes.html#manual_probe_1" + } + ], + "FACTOR": [ + { + "brief": "and", + "codes": [ + "FACTOR" ], + "id": "Klipper.FACTOR[0]", + "parameters": [], "related": [], "source": "Klipper", - "title": "queries ADXL345 register", - "url": "https://www.klipper3d.org/G-Codes.html#adxl345-accelerometer-commands" + "title": "and", + "url": "https://www.klipper3d.org/G-Codes.html#tuning_tower_1" } ], - "ACCELEROMETER_DEBUG_WRITE": [ + "G0": [ { - "brief": "writes raw", + "brief": "Add a straight line movement to the planner", "codes": [ - "ACCELEROMETER_DEBUG_WRITE" + "G0", + "G1" ], - "id": "Klipper.ACCELEROMETER_DEBUG_WRITE[0]", + "id": "Marlin.G0[0]", "parameters": [ { - "description": "", - "label": "CHIP=", + "description": "An absolute or relative coordinate on the X axis (in current units).", + "label": "[X]", "optional": true, - "tag": "CHIP", - "values": [] + "tag": "X", + "values": [ + { + "tag": "pos", + "type": "float" + } + ] }, { - "description": "", - "label": "REG=", - "optional": false, - "tag": "REG", - "values": [] + "description": "An absolute or relative coordinate on the Y axis (in current units).", + "label": "[Y]", + "optional": true, + "tag": "Y", + "values": [ + { + "tag": "pos", + "type": "float" + } + ] }, { - "description": "", - "label": "VAL=", - "optional": false, - "tag": "VAL", - "values": [] + "description": "An absolute or relative coordinate on the Z axis (in current units).", + "label": "[Z]", + "optional": true, + "tag": "Z", + "values": [ + { + "tag": "pos", + "type": "float" + } + ] + }, + { + "description": "An absolute or relative coordinate on the E (extruder) axis (in current units). The E axis describes the position of the filament in terms of input to the extruder feeder.", + "label": "[E]", + "optional": true, + "tag": "E", + "values": [ + { + "tag": "pos", + "type": "float" + } + ] + }, + { + "description": "The maximum movement rate of the move between the start and end point. The feedrate set here applies to subsequent moves that omit this parameter.", + "label": "[F]", + "optional": true, + "tag": "F", + "values": [ + { + "tag": "rate", + "type": "float" + } + ] } ], - "related": [], - "source": "Klipper", - "title": "writes raw", - "url": "https://www.klipper3d.org/G-Codes.html#adxl345-accelerometer-commands" - } - ], - "ACCELEROMETER_MEASURE": [ + "related": [ + "G2", + "G3", + "G5", + "M82", + "M83", + "G91" + ], + "source": "Marlin", + "title": "Linear Move", + "url": "https://marlinfw.org/docs/gcode/G000-G001" + }, { - "brief": "Starts accelerometer measurements at the requested number of samples per second. If CHIP is not specified it defaults to \"adxl345\". The command works in a start-stop mode: when executed for the first time, it starts the measurements, next execution stops them. The results of measurements are written to a file named", + "brief": "* G0 : Rapid Move\n* G1 : Linear Move", "codes": [ - "ACCELEROMETER_MEASURE" + "G0", + "G1" ], - "id": "Klipper.ACCELEROMETER_MEASURE[0]", + "id": "RepRap.G0[0]", "parameters": [ { - "description": "", - "label": "CHIP=", + "description": " The position to move to on the X axis", + "label": "Xnnn", "optional": true, - "tag": "CHIP", + "tag": "X", "values": [] }, { - "description": "", - "label": "NAME=", + "description": " The position to move to on the Y axis", + "label": "Ynnn", "optional": true, - "tag": "NAME", + "tag": "Y", "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Starts accelerometer measurements at the requested number of samples per second", - "url": "https://www.klipper3d.org/G-Codes.html#adxl345-accelerometer-commands" - } - ], - "ACCELEROMETER_QUERY": [ - { - "brief": "queries accelerometer for the current value. If CHIP is not specified it defaults to \"adxl345\". If RATE is not specified, the default value is used. This command is useful to test the connection to the ADXL345 accelerometer: one of the returned values should be a free-fall acceleration (+/- some noise of the chip).", - "codes": [ - "ACCELEROMETER_QUERY" - ], - "id": "Klipper.ACCELEROMETER_QUERY[0]", - "parameters": [ + }, { - "description": "", - "label": "CHIP=", + "description": " The position to move to on the Z axis", + "label": "Znnn", "optional": true, - "tag": "CHIP", + "tag": "Z", "values": [] }, { - "description": "", - "label": "RATE=", + "description": " The amount to extrude between the starting point and ending point", + "label": "Ennn", "optional": true, - "tag": "RATE", + "tag": "E", "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "queries accelerometer for the current value", - "url": "https://www.klipper3d.org/G-Codes.html#adxl345-accelerometer-commands" - } - ], - "ACCEPT": [ - { - "brief": "This command accepts the current Z position andconcludes the manual probing tool.", - "codes": [ - "ACCEPT" - ], - "id": "Klipper.ACCEPT[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command accepts the current Z position andconcludes the manual probing tool", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "ACTIVATE_EXTRUDER": [ - { - "brief": "In a printer with multiple extruders this command is used to change the active extruder.", - "codes": [ - "ACTIVATE_EXTRUDER" - ], - "id": "Klipper.ACTIVATE_EXTRUDER[0]", - "parameters": [ + }, { - "description": "", - "label": "EXTRUDER=", - "optional": false, - "tag": "EXTRUDER", + "description": " The feedrate per minute of the move between the starting point and ending point (if supplied)", + "label": "Fnnn", + "optional": true, + "tag": "F", "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "In a printer with multiple extruders this command is used to change the active extruder", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "BED_MESH_CALIBRATE": [ - { - "brief": "This command probes the bed using generated points specified by the parameters in the config. After probing, a mesh is generated and z-movement is adjusted according to the mesh. See the PROBE command for details on the optional probe parameters. If METHOD=manual is specified then the manual probing tool is activated - see the MANUAL_PROBE command above for details on the additional commands available while this tool is active.", - "codes": [ - "BED_MESH_CALIBRATE" - ], - "id": "Klipper.BED_MESH_CALIBRATE[0]", - "parameters": [ + }, { - "description": "", - "label": "METHOD=manual", + "description": " (RepRapFirmware) Flag to check if an endstop was hit (H1 to check, H0 to ignore, other see note, default is H0)", + "label": "Hnnn", "optional": true, - "tag": "METHODmanual", + "tag": "H", "values": [] }, { - "description": "", - "label": "=", + "description": " (RepRapFirmware) Restore point number ", + "label": "Rnnn", "optional": true, - "tag": "probe_parameter=value", + "tag": "R", "values": [] }, { - "description": "", - "label": "=", + "description": " Laser cutter/engraver power. In RepRapFirmware, when not in laser mode S in interpreted the same as H.", + "label": "Snnn", "optional": true, - "tag": "mesh_parameter=value", + "tag": "S", "values": [] } ], "related": [], - "source": "Klipper", - "title": "This command probes the bed using generated points specified by the parameters in the config", - "url": "https://www.klipper3d.org/G-Codes.html#mesh-bed-leveling" - } - ], - "BED_MESH_CLEAR": [ - { - "brief": "This command clears the mesh and removes all z adjustment. It is recommended to put this in your end-gcode.", - "codes": [ - "BED_MESH_CLEAR" - ], - "id": "Klipper.BED_MESH_CLEAR[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command clears the mesh and removes all z adjustment", - "url": "https://www.klipper3d.org/G-Codes.html#mesh-bed-leveling" - } - ], - "BED_MESH_MAP": [ - { - "brief": "Like to BED_MESH_OUTPUT, this command prints the current state of the mesh to the terminal. Instead of printing the values in a human readable format, the state is serialized in json format. This allows octoprint plugins to easily capture the data and generate height maps approximating the bed's surface.", - "codes": [ - "BED_MESH_MAP" - ], - "id": "Klipper.BED_MESH_MAP[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Like to BED_MESH_OUTPUT, this command prints the current state of the mesh to the terminal", - "url": "https://www.klipper3d.org/G-Codes.html#mesh-bed-leveling" + "source": "RepRap", + "title": "G0 & G1: Move", + "url": "https://reprap.org/wiki/G-code#G0_.26_G1:_Move" } ], - "BED_MESH_OFFSET": [ + "G1": [ { - "brief": "Applies X and/or Y offsets to the mesh lookup. This is useful for printers with independent extruders, as an offset is necessary to produce correct Z adjustment after a tool change.", + "brief": "", "codes": [ - "BED_MESH_OFFSET" + "G1" ], - "id": "Klipper.BED_MESH_OFFSET[0]", + "id": "Klipper.G1[0]", "parameters": [ { "description": "", - "label": "X=", + "label": "[X]", "optional": true, "tag": "X", "values": [] }, { "description": "", - "label": "Y=", + "label": "[Y]", "optional": true, "tag": "Y", "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Applies X and/or Y offsets to the mesh lookup", - "url": "https://www.klipper3d.org/G-Codes.html#mesh-bed-leveling" - } - ], - "BED_MESH_OUTPUT": [ - { - "brief": "This command outputs the current probed z values and current mesh values to the terminal. If PGP=1 is specified the X, Y coordinates generated by bed_mesh, along with their associated indices, will be output to the terminal.", - "codes": [ - "BED_MESH_OUTPUT" - ], - "id": "Klipper.BED_MESH_OUTPUT[0]", - "parameters": [ + }, { "description": "", - "label": "PGP=<0:1>", + "label": "[Z]", "optional": true, - "tag": "PGP", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command outputs the current probed z values and current mesh values to the terminal", - "url": "https://www.klipper3d.org/G-Codes.html#mesh-bed-leveling" - } - ], - "BED_MESH_PROFILE": [ - { - "brief": "This command provides profile management for mesh state. LOAD will restore the mesh state from the profile matching the supplied name. SAVE will save the current mesh state to a profile matching the supplied name. Remove will delete the profile matching the supplied name from persistent memory. Note that after SAVE or REMOVE operations have been run the SAVE_CONFIG gcode must be run to make the changes to peristent memory permanent.", - "codes": [ - "BED_MESH_PROFILE" - ], - "id": "Klipper.BED_MESH_PROFILE[0]", - "parameters": [ - { - "description": "", - "label": "LOAD=", - "optional": false, - "tag": "LOAD", + "tag": "Z", "values": [] }, { "description": "", - "label": "SAVE=", - "optional": false, - "tag": "SAVE", + "label": "[E]", + "optional": true, + "tag": "E", "values": [] }, { "description": "", - "label": "REMOVE=", - "optional": false, - "tag": "REMOVE", + "label": "[F]", + "optional": true, + "tag": "F", "values": [] } ], "related": [], "source": "Klipper", - "title": "This command provides profile management for mesh state", - "url": "https://www.klipper3d.org/G-Codes.html#mesh-bed-leveling" - } - ], - "BED_SCREWS_ADJUST": [ - { - "brief": "This command will invoke the bed screws adjustment tool. It will command the nozzle to different locations (as defined in the config file) and allow one to make adjustments to the bed screws so that the bed is a constant distance from the nozzle.", - "codes": [ - "BED_SCREWS_ADJUST" - ], - "id": "Klipper.BED_SCREWS_ADJUST[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command will invoke the bed screws adjustment tool", - "url": "https://www.klipper3d.org/G-Codes.html#bed-screws-helper" - } - ], - "BED_TILT_CALIBRATE": [ - { - "brief": "This command will probe the points specified in the config and then recommend updated x and y tilt adjustments. See the PROBE command for details on the optional probe parameters. If METHOD=manual is specified then the manual probing tool is activated - see the MANUAL_PROBE command above for details on the additional commands available while this tool is active.", - "codes": [ - "BED_TILT_CALIBRATE" - ], - "id": "Klipper.BED_TILT_CALIBRATE[0]", - "parameters": [ - { - "description": "", - "label": "METHOD=manual", - "optional": true, - "tag": "METHODmanual", - "values": [] - }, - { - "description": "", - "label": "=", - "optional": true, - "tag": "probe_parameter=value", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will probe the points specified in the config and then recommend updated x and y tilt adjustments", - "url": "https://www.klipper3d.org/G-Codes.html#bed-tilt" - } - ], - "BLTOUCH_DEBUG": [ - { - "brief": "This sends a command to the BLTouch. It may be useful for debugging. Available commands are", - "codes": [ - "BLTOUCH_DEBUG" - ], - "id": "Klipper.BLTOUCH_DEBUG[0]", - "parameters": [ - { - "description": "", - "label": "COMMAND=", - "optional": false, - "tag": "COMMAND", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This sends a command to the BLTouch", - "url": "https://www.klipper3d.org/G-Codes.html#bltouch" - } - ], - "BLTOUCH_STORE": [ - { - "brief": "This stores an output mode in the EEPROM of a BLTouch V3.1 Available output_modes are", - "codes": [ - "BLTOUCH_STORE" - ], - "id": "Klipper.BLTOUCH_STORE[0]", - "parameters": [ - { - "description": "", - "label": "MODE=", - "optional": false, - "tag": "MODE", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This stores an output mode in the EEPROM of a BLTouch V3", - "url": "https://www.klipper3d.org/G-Codes.html#bltouch" - } - ], - "CALC_MEASURED_SKEW": [ - { - "brief": "Calculates and reports the skew (in radians and degrees) based on a measured print. This can be useful for determining the printer's current skew after correction has been applied. It may also be useful before correction is applied to determine if skew correction is necessary. See", - "codes": [ - "CALC_MEASURED_SKEW" - ], - "id": "Klipper.CALC_MEASURED_SKEW[0]", - "parameters": [ - { - "description": "", - "label": "AC=", - "optional": true, - "tag": "AC", - "values": [] - }, - { - "description": "", - "label": "BD=", - "optional": true, - "tag": "BD", - "values": [] - }, - { - "description": "", - "label": "AD=", - "optional": true, - "tag": "AD", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Calculates and reports the skew (in radians and degrees) based on a measured print", - "url": "https://www.klipper3d.org/G-Codes.html#skew-correction" - } - ], - "CANCEL_PRINT": [ - { - "brief": "Cancels the current print.", - "codes": [ - "CANCEL_PRINT" - ], - "id": "Klipper.CANCEL_PRINT[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Cancels the current print", - "url": "https://www.klipper3d.org/G-Codes.html#pause-resume" - } - ], - "CLEAR_PAUSE": [ - { - "brief": "Clears the current paused state without resuming the print. This is useful if one decides to cancel a print after a PAUSE. It is recommended to add this to your start gcode to make sure the paused state is fresh for each print.", - "codes": [ - "CLEAR_PAUSE" - ], - "id": "Klipper.CLEAR_PAUSE[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Clears the current paused state without resuming the print", - "url": "https://www.klipper3d.org/G-Codes.html#pause-resume" - } - ], - "DELTA_ANALYZE": [ - { - "brief": "This command is used during enhanced delta calibration. See", - "codes": [ - "DELTA_ANALYZE" - ], - "id": "Klipper.DELTA_ANALYZE[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command is used during enhanced delta calibration", - "url": "https://www.klipper3d.org/G-Codes.html#delta-calibration" - } - ], - "DELTA_CALIBRATE": [ - { - "brief": "This command will probe seven points on the bed and recommend updated endstop positions, tower angles, and radius. See the PROBE command for details on the optional probe parameters. If METHOD=manual is specified then the manual probing tool is activated - see the MANUAL_PROBE command above for details on the additional commands available while this tool is active.", - "codes": [ - "DELTA_CALIBRATE" - ], - "id": "Klipper.DELTA_CALIBRATE[0]", - "parameters": [ - { - "description": "", - "label": "METHOD=manual", - "optional": true, - "tag": "METHODmanual", - "values": [] - }, - { - "description": "", - "label": "=", - "optional": true, - "tag": "probe_parameter=value", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will probe seven points on the bed and recommend updated endstop positions, tower angles, and radius", - "url": "https://www.klipper3d.org/G-Codes.html#delta-calibration" - } - ], - "DISABLE_FILAMENT_WIDTH_LOG": [ - { - "brief": "- Turn off diameter logging", - "codes": [ - "DISABLE_FILAMENT_WIDTH_LOG" - ], - "id": "Klipper.DISABLE_FILAMENT_WIDTH_LOG[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "- Turn off diameter logging", - "url": "https://www.klipper3d.org/G-Codes.html#hall-filament-width-sensor-commands" - } - ], - "DISABLE_FILAMENT_WIDTH_SENSOR": [ - { - "brief": "- Turn off the filament width sensor and stop using it for flow control", - "codes": [ - "DISABLE_FILAMENT_WIDTH_SENSOR" - ], - "id": "Klipper.DISABLE_FILAMENT_WIDTH_SENSOR[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "- Turn off the filament width sensor and stop using it for flow control", - "url": "https://www.klipper3d.org/G-Codes.html#filament-width-sensor-commands" - } - ], - "DUMP_TMC": [ - { - "brief": "This command will read the TMC driver registers and report their values.", - "codes": [ - "DUMP_TMC" - ], - "id": "Klipper.DUMP_TMC[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": false, - "tag": "STEPPER", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will read the TMC driver registers and report their values", - "url": "https://www.klipper3d.org/G-Codes.html#tmc-stepper-drivers" - } - ], - "ENABLE_FILAMENT_WIDTH_LOG": [ - { - "brief": "- Turn on diameter logging", - "codes": [ - "ENABLE_FILAMENT_WIDTH_LOG" - ], - "id": "Klipper.ENABLE_FILAMENT_WIDTH_LOG[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "- Turn on diameter logging", - "url": "https://www.klipper3d.org/G-Codes.html#hall-filament-width-sensor-commands" - } - ], - "ENABLE_FILAMENT_WIDTH_SENSOR": [ - { - "brief": "- Turn on the filament width sensor and start using it for flow control", - "codes": [ - "ENABLE_FILAMENT_WIDTH_SENSOR" - ], - "id": "Klipper.ENABLE_FILAMENT_WIDTH_SENSOR[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "- Turn on the filament width sensor and start using it for flow control", - "url": "https://www.klipper3d.org/G-Codes.html#filament-width-sensor-commands" - } - ], - "ENDSTOP_PHASE_CALIBRATE": [ - { - "brief": "If no STEPPER parameter is provided then this command will reports statistics on endstop stepper phases during past homing operations. When a STEPPER parameter is provided it arranges for the given endstop phase setting to be written to the config file (in conjunction with the SAVE_CONFIG command).", - "codes": [ - "ENDSTOP_PHASE_CALIBRATE" - ], - "id": "Klipper.ENDSTOP_PHASE_CALIBRATE[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": true, - "tag": "STEPPER", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "If no STEPPER parameter is provided then this command will reports statistics on endstop stepper phases during past homing operations", - "url": "https://www.klipper3d.org/G-Codes.html#endstop-adjustments-by-stepper-phase" - } - ], - "FACTOR": [ - { - "brief": "and", - "codes": [ - "FACTOR" - ], - "id": "Klipper.FACTOR[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "and", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "FIRMWARE_RESTART": [ - { - "brief": "This is similar to a RESTART command, but it also clears any error state from the micro-controller.", - "codes": [ - "FIRMWARE_RESTART" - ], - "id": "Klipper.FIRMWARE_RESTART[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This is similar to a RESTART command, but it also clears any error state from the micro-controller", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "FORCE_MOVE": [ - { - "brief": "This command will forcibly move the given stepper the given distance (in mm) at the given constant velocity (in mm/s). If ACCEL is specified and is greater than zero, then the given acceleration (in mm/s^2) will be used; otherwise no acceleration is performed. No boundary checks are performed; no kinematic updates are made; other parallel steppers on an axis will not be moved. Use caution as an incorrect command could cause damage! Using this command will almost certainly place the low-level kinematics in an incorrect state; issue a G28 afterwards to reset the kinematics. This command is intended for low-level diagnostics and debugging.", - "codes": [ - "FORCE_MOVE" - ], - "id": "Klipper.FORCE_MOVE[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": false, - "tag": "STEPPER", - "values": [] - }, - { - "description": "", - "label": "DISTANCE=", - "optional": false, - "tag": "DISTANCE", - "values": [] - }, - { - "description": "", - "label": "VELOCITY=", - "optional": false, - "tag": "VELOCITY", - "values": [] - }, - { - "description": "", - "label": "ACCEL=", - "optional": true, - "tag": "ACCEL", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will forcibly move the given stepper the given distance (in mm) at the given constant velocity (in mm/s)", - "url": "https://www.klipper3d.org/G-Codes.html#force-movement" - } - ], - "G0": [ + "title": "", + "url": "https://www.klipper3d.org/G-Codes.html#g-code-commands" + }, { "brief": "Add a straight line movement to the planner", "codes": [ "G0", "G1" ], - "id": "Marlin.G0[0]", + "id": "Marlin.G1[0]", "parameters": [ { "description": "An absolute or relative coordinate on the X axis (in current units).", @@ -776,7 +330,7 @@ window.AllGcodes = { "G0", "G1" ], - "id": "RepRap.G0[0]", + "id": "RepRap.G1[0]", "parameters": [ { "description": " The position to move to on the X axis", @@ -841,226 +395,25 @@ window.AllGcodes = { "url": "https://reprap.org/wiki/G-code#G0_.26_G1:_Move" } ], - "G1": [ + "G10": [ { "brief": "", "codes": [ - "G1" + "G10" ], - "id": "Klipper.G1[0]", - "parameters": [ - { - "description": "", - "label": "[X]", - "optional": true, - "tag": "X", - "values": [] - }, - { - "description": "", - "label": "[Y]", - "optional": true, - "tag": "Y", - "values": [] - }, - { - "description": "", - "label": "[Z]", - "optional": true, - "tag": "Z", - "values": [] - }, - { - "description": "", - "label": "[E]", - "optional": true, - "tag": "E", - "values": [] - }, - { - "description": "", - "label": "[F]", - "optional": true, - "tag": "F", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-commands" - }, - { - "brief": "Add a straight line movement to the planner", - "codes": [ - "G0", - "G1" - ], - "id": "Marlin.G1[0]", - "parameters": [ - { - "description": "An absolute or relative coordinate on the X axis (in current units).", - "label": "[X]", - "optional": true, - "tag": "X", - "values": [ - { - "tag": "pos", - "type": "float" - } - ] - }, - { - "description": "An absolute or relative coordinate on the Y axis (in current units).", - "label": "[Y]", - "optional": true, - "tag": "Y", - "values": [ - { - "tag": "pos", - "type": "float" - } - ] - }, - { - "description": "An absolute or relative coordinate on the Z axis (in current units).", - "label": "[Z]", - "optional": true, - "tag": "Z", - "values": [ - { - "tag": "pos", - "type": "float" - } - ] - }, - { - "description": "An absolute or relative coordinate on the E (extruder) axis (in current units). The E axis describes the position of the filament in terms of input to the extruder feeder.", - "label": "[E]", - "optional": true, - "tag": "E", - "values": [ - { - "tag": "pos", - "type": "float" - } - ] - }, - { - "description": "The maximum movement rate of the move between the start and end point. The feedrate set here applies to subsequent moves that omit this parameter.", - "label": "[F]", - "optional": true, - "tag": "F", - "values": [ - { - "tag": "rate", - "type": "float" - } - ] - } - ], - "related": [ - "G2", - "G3", - "G5", - "M82", - "M83", - "G91" - ], - "source": "Marlin", - "title": "Linear Move", - "url": "https://marlinfw.org/docs/gcode/G000-G001" - }, - { - "brief": "* G0 : Rapid Move\n* G1 : Linear Move", - "codes": [ - "G0", - "G1" - ], - "id": "RepRap.G1[0]", - "parameters": [ - { - "description": " The position to move to on the X axis", - "label": "Xnnn", - "optional": true, - "tag": "X", - "values": [] - }, - { - "description": " The position to move to on the Y axis", - "label": "Ynnn", - "optional": true, - "tag": "Y", - "values": [] - }, - { - "description": " The position to move to on the Z axis", - "label": "Znnn", - "optional": true, - "tag": "Z", - "values": [] - }, - { - "description": " The amount to extrude between the starting point and ending point", - "label": "Ennn", - "optional": true, - "tag": "E", - "values": [] - }, - { - "description": " The feedrate per minute of the move between the starting point and ending point (if supplied)", - "label": "Fnnn", - "optional": true, - "tag": "F", - "values": [] - }, - { - "description": " (RepRapFirmware) Flag to check if an endstop was hit (H1 to check, H0 to ignore, other see note, default is H0)", - "label": "Hnnn", - "optional": true, - "tag": "H", - "values": [] - }, - { - "description": " (RepRapFirmware) Restore point number ", - "label": "Rnnn", - "optional": true, - "tag": "R", - "values": [] - }, - { - "description": " Laser cutter/engraver power. In RepRapFirmware, when not in laser mode S in interpreted the same as H.", - "label": "Snnn", - "optional": true, - "tag": "S", - "values": [] - } - ], - "related": [], - "source": "RepRap", - "title": "G0 & G1: Move", - "url": "https://reprap.org/wiki/G-code#G0_.26_G1:_Move" - } - ], - "G10": [ - { - "brief": "", - "codes": [ - "G10" - ], - "id": "Klipper.G10[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#firmware-retraction" - }, - { - "brief": "Retract the filament", - "codes": [ - "G10" - ], - "id": "Marlin.G10[0]", + "id": "Klipper.G10[0]", + "parameters": [], + "related": [], + "source": "Klipper", + "title": "", + "url": "https://www.klipper3d.org/G-Codes.html#firmware_retraction_1" + }, + { + "brief": "Retract the filament", + "codes": [ + "G10" + ], + "id": "Marlin.G10[0]", "parameters": [ { "description": "Use `G10 S1` to do a swap retraction, before changing extruders. The subsequent [`G11`](/docs/gcode/G011.html) (after tool change) will do a swap recover. (Requires `EXTRUDERS` > 1)", @@ -1223,7 +576,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#firmware-retraction" + "url": "https://www.klipper3d.org/G-Codes.html#firmware_retraction_1" }, { "brief": "Recover the filament with firmware-based retract.", @@ -1708,7 +1061,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-arcs" + "url": "https://www.klipper3d.org/G-Codes.html#gcode_arcs" }, { "brief": "Add an arc or circle movement to the planner", @@ -6475,92 +5828,14 @@ window.AllGcodes = { "url": "https://reprap.org/wiki/G-code#G99:_Deactivate_farm_mode" } ], - "GET_CURRENT_SKEW": [ - { - "brief": "Reports the current printer skew for each plane in both radians and degrees. The skew is calculated based on parameters provided via the", - "codes": [ - "GET_CURRENT_SKEW" - ], - "id": "Klipper.GET_CURRENT_SKEW[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Reports the current printer skew for each plane in both radians and degrees", - "url": "https://www.klipper3d.org/G-Codes.html#skew-correction" - } - ], - "GET_POSITION": [ - { - "brief": "Return information on the current location of the toolhead.", - "codes": [ - "GET_POSITION" - ], - "id": "Klipper.GET_POSITION[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Return information on the current location of the toolhead", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "GET_RETRACTION": [ - { - "brief": "Queries the current parameters used by firmware retraction and displays them on the terminal.", - "codes": [ - "GET_RETRACTION" - ], - "id": "Klipper.GET_RETRACTION[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Queries the current parameters used by firmware retraction and displays them on the terminal", - "url": "https://www.klipper3d.org/G-Codes.html#firmware-retraction" - } - ], - "HELP": [ - { - "brief": "Report the list of available extended G-Code commands.", - "codes": [ - "HELP" - ], - "id": "Klipper.HELP[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Report the list of available extended G-Code commands", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "INIT_TMC": [ + "M0": [ { - "brief": "This command will intitialize the TMC registers. Needed to re-enable the driver if power to the chip is turned off then back on.", + "brief": "Stop and wait for user", "codes": [ - "INIT_TMC" + "M0", + "M1" ], - "id": "Klipper.INIT_TMC[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": false, - "tag": "STEPPER", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will intitialize the TMC registers", - "url": "https://www.klipper3d.org/G-Codes.html#tmc-stepper-drivers" - } - ], - "M0": [ - { - "brief": "Stop and wait for user", - "codes": [ - "M0", - "M1" - ], - "id": "Marlin.M0[0]", + "id": "Marlin.M0[0]", "parameters": [ { "description": "Expire time, in seconds", @@ -7923,7 +7198,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-display-commands" + "url": "https://www.klipper3d.org/G-Codes.html#display_status" }, { "brief": "Set the message line on the LCD.", @@ -7988,7 +7263,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#send-message-respond-to-host" + "url": "https://www.klipper3d.org/G-Codes.html#respond" }, { "brief": "Send text to serial", @@ -8092,7 +7367,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#other-available-g-code-commands" + "url": "https://www.klipper3d.org/G-Codes.html#query_endstops" }, { "brief": "Report endstop and probe states to the host.", @@ -10560,7 +9835,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" + "url": "https://www.klipper3d.org/G-Codes.html#virtual_sdcard" }, { "brief": "List the contents of the SD Card.", @@ -11765,7 +11040,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" + "url": "https://www.klipper3d.org/G-Codes.html#virtual_sdcard" }, { "brief": "Attempt to detect an SD card in the slot.", @@ -12593,7 +11868,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" + "url": "https://www.klipper3d.org/G-Codes.html#virtual_sdcard" }, { "brief": "Select an SD file to be executed", @@ -12682,7 +11957,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" + "url": "https://www.klipper3d.org/G-Codes.html#virtual_sdcard" }, { "brief": "Start or resume a file selected with [`M23`](/docs/gcode/M023.html)", @@ -12972,7 +12247,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" + "url": "https://www.klipper3d.org/G-Codes.html#virtual_sdcard" }, { "brief": "Pause printing from the SD card", @@ -13110,7 +12385,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" + "url": "https://www.klipper3d.org/G-Codes.html#virtual_sdcard" }, { "brief": "Set the SD read position", @@ -13331,7 +12606,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" + "url": "https://www.klipper3d.org/G-Codes.html#virtual_sdcard" }, { "brief": "Print SD progress to serial", @@ -21599,7 +20874,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-display-commands" + "url": "https://www.klipper3d.org/G-Codes.html#display_status" }, { "brief": "Set current print progress percentage for LCD.", @@ -26973,1755 +26248,63 @@ window.AllGcodes = { "related": [], "source": "Marlin", "title": "STOP Restart", - "url": "https://marlinfw.org/docs/gcode/M999" - }, - { - "brief": "", - "codes": [ - "M999" - ], - "id": "RepRap.M999[0]", - "parameters": [ - { - "description": " Reset flags", - "label": "Pnnn", - "optional": true, - "tag": "P", - "values": [] - }, - { - "description": " CAN address of the board to reset (RRF only)", - "label": "Bnnn", - "optional": true, - "tag": "B", - "values": [] - } - ], - "related": [], - "source": "RepRap", - "title": "M999: Restart after being stopped by error", - "url": "https://reprap.org/wiki/G-code#M999:_Restart_after_being_stopped_by_error" - } - ], - "MANUAL_PROBE": [ - { - "brief": "Run a helper script useful for measuring the height of the nozzle at a given location. If SPEED is specified, it sets the speed of TESTZ commands (the default is 5mm/s). During a manual probe, the following additional commands are available", - "codes": [ - "MANUAL_PROBE" - ], - "id": "Klipper.MANUAL_PROBE[0]", - "parameters": [ - { - "description": "", - "label": "SPEED=", - "optional": true, - "tag": "SPEED", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Run a helper script useful for measuring the height of the nozzle at a given location", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "MANUAL_STEPPER": [ - { - "brief": "This command will alter the state of the stepper. Use the ENABLE parameter to enable/disable the stepper. Use the SET_POSITION parameter to force the stepper to think it is at the given position. Use the MOVE parameter to request a movement to the given position. If SPEED and/or ACCEL is specified then the given values will be used instead of the defaults specified in the config file. If an ACCEL of zero is specified then no acceleration will be performed. If STOP_ON_ENDSTOP=1 is specified then the move will end early should the endstop report as triggered (use STOP_ON_ENDSTOP=2 to complete the move without error even if the endstop does not trigger, use -1 or -2 to stop when the endstop reports not triggered). Normally future G-Code commands will be scheduled to run after the stepper move completes, however if a manual stepper move uses SYNC=0 then future G-Code movement commands may run in parallel with the stepper movement.", - "codes": [ - "MANUAL_STEPPER" - ], - "id": "Klipper.MANUAL_STEPPER[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=config_name", - "optional": false, - "tag": "STEPPERconfig_name", - "values": [] - }, - { - "description": "", - "label": "ENABLE=0|1", - "optional": true, - "tag": "ENABLE0|1", - "values": [] - }, - { - "description": "", - "label": "SET_POSITION=", - "optional": true, - "tag": "SET_POSITION", - "values": [] - }, - { - "description": "", - "label": "SPEED=", - "optional": true, - "tag": "SPEED", - "values": [] - }, - { - "description": "", - "label": "ACCEL=", - "optional": true, - "tag": "ACCEL", - "values": [] - }, - { - "description": "", - "label": "MOVE=", - "optional": true, - "tag": "MOVE", - "values": [] - }, - { - "description": "", - "label": "STOP_ON_ENDSTOP=1|2|-1|-2", - "optional": true, - "tag": "STOP_ON_ENDSTOP1|2|-1|-2", - "values": [] - }, - { - "description": "", - "label": "SYNC=0", - "optional": true, - "tag": "SYNC0", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will alter the state of the stepper", - "url": "https://www.klipper3d.org/G-Codes.html#manual-stepper-commands" - } - ], - "MEASURE_AXES_NOISE": [ - { - "brief": "Measures and outputs the noise for all axes of all enabled accelerometer chips.", - "codes": [ - "MEASURE_AXES_NOISE" - ], - "id": "Klipper.MEASURE_AXES_NOISE[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Measures and outputs the noise for all axes of all enabled accelerometer chips", - "url": "https://www.klipper3d.org/G-Codes.html#resonance-testing-commands" - } - ], - "PALETTE_CLEAR": [ - { - "brief": "This command instructs the Palette 2 to clear all of the input and output paths of filament.", - "codes": [ - "PALETTE_CLEAR" - ], - "id": "Klipper.PALETTE_CLEAR[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command instructs the Palette 2 to clear all of the input and output paths of filament", - "url": "https://www.klipper3d.org/G-Codes.html#palette-2-commands" - } - ], - "PALETTE_CONNECT": [ - { - "brief": "This command initializes the connection with the Palette 2.", - "codes": [ - "PALETTE_CONNECT" - ], - "id": "Klipper.PALETTE_CONNECT[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command initializes the connection with the Palette 2", - "url": "https://www.klipper3d.org/G-Codes.html#palette-2-commands" - } - ], - "PALETTE_CUT": [ - { - "brief": "This command instructs the Palette 2 to cut the filament currently loaded in the splice core.", - "codes": [ - "PALETTE_CUT" - ], - "id": "Klipper.PALETTE_CUT[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command instructs the Palette 2 to cut the filament currently loaded in the splice core", - "url": "https://www.klipper3d.org/G-Codes.html#palette-2-commands" - } - ], - "PALETTE_DISCONNECT": [ - { - "brief": "This command disconnects from the Palette 2.", - "codes": [ - "PALETTE_DISCONNECT" - ], - "id": "Klipper.PALETTE_DISCONNECT[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command disconnects from the Palette 2", - "url": "https://www.klipper3d.org/G-Codes.html#palette-2-commands" - } - ], - "PALETTE_SMART_LOAD": [ - { - "brief": "This command start the smart load sequence on the Palette 2. Filament is loaded automatically by extruding it the distance calibrated on the device for the printer, and instructs the Palette 2 once the loading has been completed. This command is the same as pressing", - "codes": [ - "PALETTE_SMART_LOAD" - ], - "id": "Klipper.PALETTE_SMART_LOAD[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command start the smart load sequence on the Palette 2", - "url": "https://www.klipper3d.org/G-Codes.html#palette-2-commands" - } - ], - "PAUSE": [ - { - "brief": "Pauses the current print. The current position is captured for restoration upon resume.", - "codes": [ - "PAUSE" - ], - "id": "Klipper.PAUSE[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Pauses the current print", - "url": "https://www.klipper3d.org/G-Codes.html#pause-resume" - } - ], - "PID_CALIBRATE": [ - { - "brief": "Perform a PID calibration test. The specified heater will be enabled until the specified target temperature is reached, and then the heater will be turned off and on for several cycles. If the WRITE_FILE parameter is enabled, then the file /tmp/heattest.txt will be created with a log of all temperature samples taken during the test.", - "codes": [ - "PID_CALIBRATE" - ], - "id": "Klipper.PID_CALIBRATE[0]", - "parameters": [ - { - "description": "", - "label": "HEATER=", - "optional": false, - "tag": "HEATER", - "values": [] - }, - { - "description": "", - "label": "TARGET=", - "optional": false, - "tag": "TARGET", - "values": [] - }, - { - "description": "", - "label": "WRITE_FILE=1", - "optional": true, - "tag": "WRITE_FILE1", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Perform a PID calibration test", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "PROBE": [ - { - "brief": "Move the nozzle downwards until the probe triggers. If any of the optional parameters are provided they override their equivalent setting in the", - "codes": [ - "PROBE" - ], - "id": "Klipper.PROBE[0]", - "parameters": [ - { - "description": "", - "label": "PROBE_SPEED=", - "optional": true, - "tag": "PROBE_SPEED", - "values": [] - }, - { - "description": "", - "label": "LIFT_SPEED=", - "optional": true, - "tag": "LIFT_SPEED", - "values": [] - }, - { - "description": "", - "label": "SAMPLES=", - "optional": true, - "tag": "SAMPLES", - "values": [] - }, - { - "description": "", - "label": "SAMPLE_RETRACT_DIST=", - "optional": true, - "tag": "SAMPLE_RETRACT_DIST", - "values": [] - }, - { - "description": "", - "label": "SAMPLES_TOLERANCE=", - "optional": true, - "tag": "SAMPLES_TOLERANCE", - "values": [] - }, - { - "description": "", - "label": "SAMPLES_TOLERANCE_RETRIES=", - "optional": true, - "tag": "SAMPLES_TOLERANCE_RETRIES", - "values": [] - }, - { - "description": "", - "label": "SAMPLES_RESULT=median|average", - "optional": true, - "tag": "SAMPLES_RESULTmedian|average", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Move the nozzle downwards until the probe triggers", - "url": "https://www.klipper3d.org/G-Codes.html#probe" - } - ], - "PROBE_ACCURACY": [ - { - "brief": "Calculate the maximum, minimum, average, median, and standard deviation of multiple probe samples. By default, 10 SAMPLES are taken. Otherwise the optional parameters default to their equivalent setting in the probe config section.", - "codes": [ - "PROBE_ACCURACY" - ], - "id": "Klipper.PROBE_ACCURACY[0]", - "parameters": [ - { - "description": "", - "label": "PROBE_SPEED=", - "optional": true, - "tag": "PROBE_SPEED", - "values": [] - }, - { - "description": "", - "label": "SAMPLES=", - "optional": true, - "tag": "SAMPLES", - "values": [] - }, - { - "description": "", - "label": "SAMPLE_RETRACT_DIST=", - "optional": true, - "tag": "SAMPLE_RETRACT_DIST", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Calculate the maximum, minimum, average, median, and standard deviation of multiple probe samples", - "url": "https://www.klipper3d.org/G-Codes.html#probe" - } - ], - "PROBE_CALIBRATE": [ - { - "brief": "Run a helper script useful for calibrating the probe's z_offset. See the PROBE command for details on the optional probe parameters. See the MANUAL_PROBE command for details on the SPEED parameter and the additional commands available while the tool is active. Please note, the PROBE_CALIBRATE command uses the speed variable to move in XY direction as well as Z.", - "codes": [ - "PROBE_CALIBRATE" - ], - "id": "Klipper.PROBE_CALIBRATE[0]", - "parameters": [ - { - "description": "", - "label": "SPEED=", - "optional": true, - "tag": "SPEED", - "values": [] - }, - { - "description": "", - "label": "=", - "optional": true, - "tag": "probe_parameter=value", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Run a helper script useful for calibrating the probe's z_offset", - "url": "https://www.klipper3d.org/G-Codes.html#probe" - } - ], - "QUERY_ADC": [ - { - "brief": "Report the last analog value received for a configured analog pin. If NAME is not provided, the list of available adc names are reported. If PULLUP is provided (as a value in Ohms), the raw analog value along with the equivalent resistance given that pullup is reported.", - "codes": [ - "QUERY_ADC" - ], - "id": "Klipper.QUERY_ADC[0]", - "parameters": [ - { - "description": "", - "label": "NAME=", - "optional": true, - "tag": "NAME", - "values": [] - }, - { - "description": "", - "label": "PULLUP=", - "optional": true, - "tag": "PULLUP", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Report the last analog value received for a configured analog pin", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "QUERY_ENDSTOPS": [ - { - "brief": "Probe the axis endstops and report if they are \"triggered\" or in an \"open\" state. This command is typically used to verify that an endstop is working correctly.", - "codes": [ - "QUERY_ENDSTOPS" - ], - "id": "Klipper.QUERY_ENDSTOPS[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Probe the axis endstops and report if they are \"triggered\" or in an \"open\" state", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "QUERY_FILAMENT_SENSOR": [ - { - "brief": "Queries the current status of the filament sensor. The data displayed on the terminal will depend on the sensor type defined in the confguration.", - "codes": [ - "QUERY_FILAMENT_SENSOR" - ], - "id": "Klipper.QUERY_FILAMENT_SENSOR[0]", - "parameters": [ - { - "description": "", - "label": "SENSOR=", - "optional": false, - "tag": "SENSOR", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Queries the current status of the filament sensor", - "url": "https://www.klipper3d.org/G-Codes.html#filament-sensor" - } - ], - "QUERY_FILAMENT_WIDTH": [ - { - "brief": "- Return the current measured filament width", - "codes": [ - "QUERY_FILAMENT_WIDTH" - ], - "id": "Klipper.QUERY_FILAMENT_WIDTH[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "- Return the current measured filament width", - "url": "https://www.klipper3d.org/G-Codes.html#filament-width-sensor-commands" - } - ], - "QUERY_PROBE": [ - { - "brief": "Report the current status of the probe (\"triggered\" or \"open\").", - "codes": [ - "QUERY_PROBE" - ], - "id": "Klipper.QUERY_PROBE[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Report the current status of the probe (\"triggered\" or \"open\")", - "url": "https://www.klipper3d.org/G-Codes.html#probe" - } - ], - "QUERY_RAW_FILAMENT_WIDTH": [ - { - "brief": "- Return the current ADC channel readings and RAW sensor value for calibration points", - "codes": [ - "QUERY_RAW_FILAMENT_WIDTH" - ], - "id": "Klipper.QUERY_RAW_FILAMENT_WIDTH[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "- Return the current ADC channel readings and RAW sensor value for calibration points", - "url": "https://www.klipper3d.org/G-Codes.html#hall-filament-width-sensor-commands" - } - ], - "RESET_FILAMENT_WIDTH_SENSOR": [ - { - "brief": "- Clear all sensor readings. Helpful after filament change", - "codes": [ - "RESET_FILAMENT_WIDTH_SENSOR" - ], - "id": "Klipper.RESET_FILAMENT_WIDTH_SENSOR[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "- Clear all sensor readings", - "url": "https://www.klipper3d.org/G-Codes.html#filament-width-sensor-commands" - } - ], - "RESPOND": [ - { - "brief": "echo the message prepended with", - "codes": [ - "RESPOND" - ], - "id": "Klipper.RESPOND[0]", - "parameters": [ - { - "description": "", - "label": "PREFIX=", - "optional": false, - "tag": "PREFIX", - "values": [] - }, - { - "description": "", - "label": "MSG=\"\"", - "optional": false, - "tag": "MSG\"", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "echo the message prepended with", - "url": "https://www.klipper3d.org/G-Codes.html#send-message-respond-to-host" - } - ], - "RESTART": [ - { - "brief": "This will cause the host software to reload its config and perform an internal reset. This command will not clear error state from the micro-controller (see FIRMWARE_RESTART) nor will it load new software (see", - "codes": [ - "RESTART" - ], - "id": "Klipper.RESTART[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This will cause the host software to reload its config and perform an internal reset", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "RESTORE_GCODE_STATE": [ - { - "brief": "Restore a state previously saved via SAVE_GCODE_STATE. If \"MOVE=1\" is specified then a toolhead move will be issued to move back to the previous XYZ position. If \"MOVE_SPEED\" is specified then the toolhead move will be performed with the given speed (in mm/s); otherwise the toolhead move will use the restored g-code speed.", - "codes": [ - "RESTORE_GCODE_STATE" - ], - "id": "Klipper.RESTORE_GCODE_STATE[0]", - "parameters": [ - { - "description": "", - "label": "NAME=", - "optional": true, - "tag": "NAME", - "values": [] - }, - { - "description": "", - "label": "MOVE=1", - "optional": true, - "tag": "MOVE1", - "values": [] - }, - { - "description": "", - "label": "MOVE_SPEED=", - "optional": true, - "tag": "MOVE_SPEED", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Restore a state previously saved via SAVE_GCODE_STATE", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "RESUME": [ - { - "brief": "Resumes the print from a pause, first restoring the previously captured position. The VELOCITY parameter determines the speed at which the tool should return to the original captured position.", - "codes": [ - "RESUME" - ], - "id": "Klipper.RESUME[0]", - "parameters": [ - { - "description": "", - "label": "VELOCITY=", - "optional": true, - "tag": "VELOCITY", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Resumes the print from a pause, first restoring the previously captured position", - "url": "https://www.klipper3d.org/G-Codes.html#pause-resume" - } - ], - "SAVE_CONFIG": [ - { - "brief": "This command will overwrite the main printer config file and restart the host software. This command is used in conjunction with other calibration commands to store the results of calibration tests.", - "codes": [ - "SAVE_CONFIG" - ], - "id": "Klipper.SAVE_CONFIG[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "This command will overwrite the main printer config file and restart the host software", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SAVE_GCODE_STATE": [ - { - "brief": "Save the current g-code coordinate parsing state. Saving and restoring the g-code state is useful in scripts and macros. This command saves the current g-code absolute coordinate mode (G90/G91), absolute extrude mode (M82/M83), origin (G92), offset (SET_GCODE_OFFSET), speed override (M220), extruder override (M221), move speed, current XYZ position, and relative extruder \"E\" position. If NAME is provided it allows one to name the saved state to the given string. If NAME is not provided it defaults to \"default\".", - "codes": [ - "SAVE_GCODE_STATE" - ], - "id": "Klipper.SAVE_GCODE_STATE[0]", - "parameters": [ - { - "description": "", - "label": "NAME=", - "optional": true, - "tag": "NAME", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Save the current g-code coordinate parsing state", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SAVE_VARIABLE": [ - { - "brief": "Saves the variable to disk so that it can be used across restarts. All stored variables are loaded into the", - "codes": [ - "SAVE_VARIABLE" - ], - "id": "Klipper.SAVE_VARIABLE[0]", - "parameters": [ - { - "description": "", - "label": "VARIABLE=", - "optional": false, - "tag": "VARIABLE", - "values": [] - }, - { - "description": "", - "label": "VALUE=", - "optional": false, - "tag": "VALUE", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Saves the variable to disk so that it can be used across restarts", - "url": "https://www.klipper3d.org/G-Codes.html#save-variables" - } - ], - "SCREWS_TILT_CALCULATE": [ - { - "brief": "This command will invoke the bed screws adjustment tool. It will command the nozzle to different locations (as defined in the config file) probing the z height and calculate the number of knob turns to adjust the bed level. If DIRECTION is specified, the knob turns will all be in the same direction, clockwise (CW) or counterclockwise (CCW). See the PROBE command for details on the optional probe parameters. IMPORTANT: You MUST always do a G28 before using this command.", - "codes": [ - "SCREWS_TILT_CALCULATE" - ], - "id": "Klipper.SCREWS_TILT_CALCULATE[0]", - "parameters": [ - { - "description": "", - "label": "DIRECTION=CW|CCW", - "optional": true, - "tag": "DIRECTIONCW|CCW", - "values": [] - }, - { - "description": "", - "label": "=", - "optional": true, - "tag": "probe_parameter=value", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will invoke the bed screws adjustment tool", - "url": "https://www.klipper3d.org/G-Codes.html#bed-screws-tilt-adjust-helper" - } - ], - "SDCARD_LOOP_BEGIN": [ - { - "brief": "Begin a looped section in the SD print. A count of 0 indicates that the section should be looped indefinately.", - "codes": [ - "SDCARD_LOOP_BEGIN" - ], - "id": "Klipper.SDCARD_LOOP_BEGIN[0]", - "parameters": [ - { - "description": "", - "label": "COUNT=", - "optional": false, - "tag": "COUNT", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Begin a looped section in the SD print", - "url": "https://www.klipper3d.org/G-Codes.html#sdcard-loop" - } - ], - "SDCARD_LOOP_DESIST": [ - { - "brief": "Complete existing loops without further iterations.", - "codes": [ - "SDCARD_LOOP_DESIST" - ], - "id": "Klipper.SDCARD_LOOP_DESIST[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Complete existing loops without further iterations", - "url": "https://www.klipper3d.org/G-Codes.html#sdcard-loop" - } - ], - "SDCARD_LOOP_END": [ - { - "brief": "End a looped section in the SD print.", - "codes": [ - "SDCARD_LOOP_END" - ], - "id": "Klipper.SDCARD_LOOP_END[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "End a looped section in the SD print", - "url": "https://www.klipper3d.org/G-Codes.html#sdcard-loop" - } - ], - "SDCARD_PRINT_FILE": [ - { - "brief": "", - "codes": [ - "SDCARD_PRINT_FILE" - ], - "id": "Klipper.SDCARD_PRINT_FILE[0]", - "parameters": [ - { - "description": "", - "label": "FILENAME=", - "optional": false, - "tag": "FILENAME", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" - } - ], - "SDCARD_RESET_FILE": [ - { - "brief": "", - "codes": [ - "SDCARD_RESET_FILE" - ], - "id": "Klipper.SDCARD_RESET_FILE[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-sd-card-commands" - } - ], - "SET_DISPLAY_GROUP": [ - { - "brief": "Set the active display group of an lcd display. This allows to define multiple display data groups in the config, e.g.", - "codes": [ - "SET_DISPLAY_GROUP" - ], - "id": "Klipper.SET_DISPLAY_GROUP[0]", - "parameters": [ - { - "description": "", - "label": "DISPLAY=", - "optional": true, - "tag": "DISPLAY", - "values": [] - }, - { - "description": "", - "label": "GROUP=", - "optional": false, - "tag": "GROUP", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Set the active display group of an lcd display", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SET_DUAL_CARRIAGE": [ - { - "brief": "This command will set the active carriage. It is typically invoked from the activate_gcode and deactivate_gcode fields in a multiple extruder configuration.", - "codes": [ - "SET_DUAL_CARRIAGE" - ], - "id": "Klipper.SET_DUAL_CARRIAGE[0]", - "parameters": [ - { - "description": "", - "label": "CARRIAGE=0|1", - "optional": true, - "tag": "CARRIAGE0|1", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will set the active carriage", - "url": "https://www.klipper3d.org/G-Codes.html#dual-carriages" - } - ], - "SET_EXTRUDER_STEP_DISTANCE": [ - { - "brief": "Set a new value for the provided extruder's \"step distance\". The \"step distance\" is", - "codes": [ - "SET_EXTRUDER_STEP_DISTANCE" - ], - "id": "Klipper.SET_EXTRUDER_STEP_DISTANCE[0]", - "parameters": [ - { - "description": "", - "label": "EXTRUDER=", - "optional": true, - "tag": "EXTRUDER", - "values": [] - }, - { - "description": "", - "label": "DISTANCE=", - "optional": true, - "tag": "DISTANCE", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Set a new value for the provided extruder's \"step distance\"", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SET_FAN_SPEED": [ - { - "brief": "This command sets the speed of a fan.", - "codes": [ - "SET_FAN_SPEED" - ], - "id": "Klipper.SET_FAN_SPEED[0]", - "parameters": [ - { - "description": "", - "label": "FAN=config_name", - "optional": false, - "tag": "FANconfig_name", - "values": [] - }, - { - "description": "", - "label": "SPEED=", - "optional": false, - "tag": "SPEED", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command sets the speed of a fan", - "url": "https://www.klipper3d.org/G-Codes.html#manually-controlled-fans-commands" - } - ], - "SET_FILAMENT_SENSOR": [ - { - "brief": "Sets the filament sensor on/off. If ENABLE is set to 0, the filament sensor will be disabled, if set to 1 it is enabled.", - "codes": [ - "SET_FILAMENT_SENSOR" - ], - "id": "Klipper.SET_FILAMENT_SENSOR[0]", - "parameters": [ - { - "description": "", - "label": "SENSOR=", - "optional": false, - "tag": "SENSOR", - "values": [] - }, - { - "description": "", - "label": "ENABLE=0|1", - "optional": true, - "tag": "ENABLE0|1", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Sets the filament sensor on/off", - "url": "https://www.klipper3d.org/G-Codes.html#filament-sensor" - } - ], - "SET_GCODE_OFFSET": [ - { - "brief": "Set a positional offset to apply to future G-Code commands. This is commonly used to virtually change the Z bed offset or to set nozzle XY offsets when switching extruders. For example, if \"SET_GCODE_OFFSET Z=0.2\" is sent, then future G-Code moves will have 0.2mm added to their Z height. If the X_ADJUST style parameters are used, then the adjustment will be added to any existing offset (eg, \"SET_GCODE_OFFSET Z=-0.2\" followed by \"SET_GCODE_OFFSET Z_ADJUST=0.3\" would result in a total Z offset of 0.1). If \"MOVE=1\" is specified then a toolhead move will be issued to apply the given offset (otherwise the offset will take effect on the next absolute G-Code move that specifies the given axis). If \"MOVE_SPEED\" is specified then the toolhead move will be performed with the given speed (in mm/s); otherwise the toolhead move will use the last specified G-Code speed.", - "codes": [ - "SET_GCODE_OFFSET" - ], - "id": "Klipper.SET_GCODE_OFFSET[0]", - "parameters": [ - { - "description": "", - "label": "X=|X_ADJUST=", - "optional": true, - "tag": "X", - "values": [] - }, - { - "description": "", - "label": "Y=|Y_ADJUST=", - "optional": true, - "tag": "Y", - "values": [] - }, - { - "description": "", - "label": "Z=|Z_ADJUST=", - "optional": true, - "tag": "Z", - "values": [] - }, - { - "description": "", - "label": "MOVE=1", - "optional": true, - "tag": "MOVE1", - "values": [] - }, - { - "description": "", - "label": "MOVE_SPEED=", - "optional": true, - "tag": "MOVE_SPEED", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Set a positional offset to apply to future G-Code commands", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SET_GCODE_VARIABLE": [ - { - "brief": "This command allows one to change the value of a gcode_macro variable at run-time. The provided VALUE is parsed as a Python literal.", - "codes": [ - "SET_GCODE_VARIABLE" - ], - "id": "Klipper.SET_GCODE_VARIABLE[0]", - "parameters": [ - { - "description": "", - "label": "MACRO=", - "optional": false, - "tag": "MACRO", - "values": [] - }, - { - "description": "", - "label": "VARIABLE=", - "optional": false, - "tag": "VARIABLE", - "values": [] - }, - { - "description": "", - "label": "VALUE=", - "optional": false, - "tag": "VALUE", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command allows one to change the value of a gcode_macro variable at run-time", - "url": "https://www.klipper3d.org/G-Codes.html#g-code-macro-commands" - } - ], - "SET_HEATER_TEMPERATURE": [ - { - "brief": "Sets the target temperature for a heater. If a target temperature is not supplied, the target is 0.", - "codes": [ - "SET_HEATER_TEMPERATURE" - ], - "id": "Klipper.SET_HEATER_TEMPERATURE[0]", - "parameters": [ - { - "description": "", - "label": "HEATER=", - "optional": false, - "tag": "HEATER", - "values": [] - }, - { - "description": "", - "label": "TARGET=", - "optional": true, - "tag": "TARGET", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Sets the target temperature for a heater", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SET_IDLE_TIMEOUT": [ - { - "brief": "Allows the user to set the idle timeout (in seconds).", - "codes": [ - "SET_IDLE_TIMEOUT" - ], - "id": "Klipper.SET_IDLE_TIMEOUT[0]", - "parameters": [ - { - "description": "", - "label": "TIMEOUT=", - "optional": true, - "tag": "TIMEOUT", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Allows the user to set the idle timeout (in seconds)", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SET_INPUT_SHAPER": [ - { - "brief": "Modify input shaper parameters. Note that SHAPER_TYPE parameter resets input shaper for both X and Y axes even if different shaper types have been configured in [input_shaper] section. SHAPER_TYPE cannot be used together with either of SHAPER_TYPE_X and SHAPER_TYPE_Y parameters. See", - "codes": [ - "SET_INPUT_SHAPER" - ], - "id": "Klipper.SET_INPUT_SHAPER[0]", - "parameters": [ - { - "description": "", - "label": "SHAPER_FREQ_X=", - "optional": true, - "tag": "SHAPER_FREQ_X", - "values": [] - }, - { - "description": "", - "label": "SHAPER_FREQ_Y=", - "optional": true, - "tag": "SHAPER_FREQ_Y", - "values": [] - }, - { - "description": "", - "label": "DAMPING_RATIO_X=", - "optional": true, - "tag": "DAMPING_RATIO_X", - "values": [] - }, - { - "description": "", - "label": "DAMPING_RATIO_Y=", - "optional": true, - "tag": "DAMPING_RATIO_Y", - "values": [] - }, - { - "description": "", - "label": "SHAPER_TYPE=", - "optional": true, - "tag": "SHAPER_TYPE", - "values": [] - }, - { - "description": "", - "label": "SHAPER_TYPE_X=", - "optional": true, - "tag": "SHAPER_TYPE_X", - "values": [] - }, - { - "description": "", - "label": "SHAPER_TYPE_Y=", - "optional": true, - "tag": "SHAPER_TYPE_Y", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Modify input shaper parameters", - "url": "https://www.klipper3d.org/G-Codes.html#resonance-compensation" - } - ], - "SET_KINEMATIC_POSITION": [ - { - "brief": "Force the low-level kinematic code to believe the toolhead is at the given cartesian position. This is a diagnostic and debugging command; use SET_GCODE_OFFSET and/or G92 for regular axis transformations. If an axis is not specified then it will default to the position that the head was last commanded to. Setting an incorrect or invalid position may lead to internal software errors. This command may invalidate future boundary checks; issue a G28 afterwards to reset the kinematics.", - "codes": [ - "SET_KINEMATIC_POSITION" - ], - "id": "Klipper.SET_KINEMATIC_POSITION[0]", - "parameters": [ - { - "description": "", - "label": "X=", - "optional": true, - "tag": "X", - "values": [] - }, - { - "description": "", - "label": "Y=", - "optional": true, - "tag": "Y", - "values": [] - }, - { - "description": "", - "label": "Z=", - "optional": true, - "tag": "Z", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Force the low-level kinematic code to believe the toolhead is at the given cartesian position", - "url": "https://www.klipper3d.org/G-Codes.html#force-movement" - } - ], - "SET_LED": [ - { - "brief": "This sets the LED output. Each color", - "codes": [ - "SET_LED" - ], - "id": "Klipper.SET_LED[0]", - "parameters": [ - { - "description": "", - "label": "LED=", - "optional": false, - "tag": "LED", - "values": [] - }, - { - "description": "", - "label": "RED=", - "optional": false, - "tag": "RED", - "values": [] - }, - { - "description": "", - "label": "GREEN=", - "optional": false, - "tag": "GREEN", - "values": [] - }, - { - "description": "", - "label": "BLUE=", - "optional": false, - "tag": "BLUE", - "values": [] - }, - { - "description": "", - "label": "WHITE=", - "optional": false, - "tag": "WHITE", - "values": [] - }, - { - "description": "", - "label": "INDEX=", - "optional": true, - "tag": "INDEX", - "values": [] - }, - { - "description": "", - "label": "TRANSMIT=0", - "optional": true, - "tag": "TRANSMIT0", - "values": [] - }, - { - "description": "", - "label": "SYNC=1", - "optional": true, - "tag": "SYNC1", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This sets the LED output", - "url": "https://www.klipper3d.org/G-Codes.html#neopixel-and-dotstar-commands" - } - ], - "SET_PIN": [ - { - "brief": "", - "codes": [ - "SET_PIN" - ], - "id": "Klipper.SET_PIN[0]", - "parameters": [ - { - "description": "", - "label": "PIN=config_name", - "optional": false, - "tag": "PINconfig_name", - "values": [] - }, - { - "description": "", - "label": "VALUE=", - "optional": false, - "tag": "VALUE", - "values": [] - }, - { - "description": "", - "label": "CYCLE_TIME=", - "optional": false, - "tag": "CYCLE_TIME", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "", - "url": "https://www.klipper3d.org/G-Codes.html#custom-pin-commands" - } - ], - "SET_PRESSURE_ADVANCE": [ - { - "brief": "Set pressure advance parameters. If EXTRUDER is not specified, it defaults to the active extruder.", - "codes": [ - "SET_PRESSURE_ADVANCE" - ], - "id": "Klipper.SET_PRESSURE_ADVANCE[0]", - "parameters": [ - { - "description": "", - "label": "EXTRUDER=", - "optional": true, - "tag": "EXTRUDER", - "values": [] - }, - { - "description": "", - "label": "ADVANCE=", - "optional": true, - "tag": "ADVANCE", - "values": [] - }, - { - "description": "", - "label": "SMOOTH_TIME=", - "optional": true, - "tag": "SMOOTH_TIME", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Set pressure advance parameters", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SET_RETRACTION": [ - { - "brief": "Adjust the parameters used by firmware retraction. RETRACT_LENGTH determines the length of filament to retract and unretract. The speed of retraction is adjusted via RETRACT_SPEED, and is typically set relatively high. The speed of unretraction is adjusted via UNRETRACT_SPEED, and is not particularly critical, although often lower than RETRACT_SPEED. In some cases it is useful to add a small amount of additional length on unretraction, and this is set via UNRETRACT_EXTRA_LENGTH. SET_RETRACTION is commonly set as part of slicer per-filament configuration, as different filaments require different parameter settings.", - "codes": [ - "SET_RETRACTION" - ], - "id": "Klipper.SET_RETRACTION[0]", - "parameters": [ - { - "description": "", - "label": "RETRACT_LENGTH=", - "optional": true, - "tag": "RETRACT_LENGTH", - "values": [] - }, - { - "description": "", - "label": "RETRACT_SPEED=", - "optional": true, - "tag": "RETRACT_SPEED", - "values": [] - }, - { - "description": "", - "label": "UNRETRACT_EXTRA_LENGTH=", - "optional": true, - "tag": "UNRETRACT_EXTRA_LENGTH", - "values": [] - }, - { - "description": "", - "label": "UNRETRACT_SPEED=", - "optional": true, - "tag": "UNRETRACT_SPEED", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Adjust the parameters used by firmware retraction", - "url": "https://www.klipper3d.org/G-Codes.html#firmware-retraction" - } - ], - "SET_SERVO": [ - { - "brief": "Set the servo position to the given angle (in degrees) or pulse width (in seconds). Use", - "codes": [ - "SET_SERVO" - ], - "id": "Klipper.SET_SERVO[0]", - "parameters": [ - { - "description": "", - "label": "SERVO=config_name", - "optional": false, - "tag": "SERVOconfig_name", - "values": [] - }, - { - "description": "", - "label": "ANGLE=", - "optional": true, - "tag": "ANGLE", - "values": [] - }, - { - "description": "", - "label": "|", - "optional": false, - "tag": "|", - "values": [] - }, - { - "description": "", - "label": "WIDTH=", - "optional": true, - "tag": "WIDTH", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Set the servo position to the given angle (in degrees) or pulse width (in seconds)", - "url": "https://www.klipper3d.org/G-Codes.html#servo-commands" - } - ], - "SET_SKEW": [ - { - "brief": "Configures the [skew_correction] module with measurements (in mm) taken from a calibration print. One may enter measurements for any combination of planes, planes not entered will retain their current value. If", - "codes": [ - "SET_SKEW" - ], - "id": "Klipper.SET_SKEW[0]", - "parameters": [ - { - "description": "", - "label": "XY=", - "optional": true, - "tag": "XY", - "values": [] - }, - { - "description": "", - "label": "XZ=", - "optional": true, - "tag": "XZ", - "values": [] - }, - { - "description": "", - "label": "YZ=", - "optional": true, - "tag": "YZ", - "values": [] - }, - { - "description": "", - "label": "CLEAR=<0|1>", - "optional": true, - "tag": "CLEAR", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Configures the [skew_correction] module with measurements (in mm) taken from a calibration print", - "url": "https://www.klipper3d.org/G-Codes.html#skew-correction" - } - ], - "SET_STEPPER_ENABLE": [ - { - "brief": "Enable or disable only the given stepper. This is a diagnostic and debugging tool and must be used with care. Disabling an axis motor does not reset the homing information. Manually moving a disabled stepper may cause the machine to operate the motor outside of safe limits. This can lead to damage to axis components, hot ends, and print surface.", - "codes": [ - "SET_STEPPER_ENABLE" - ], - "id": "Klipper.SET_STEPPER_ENABLE[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": false, - "tag": "STEPPER", - "values": [] - }, - { - "description": "", - "label": "ENABLE=0|1", - "optional": true, - "tag": "ENABLE0|1", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Enable or disable only the given stepper", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SET_TEMPERATURE_FAN_TARGET": [ - { - "brief": "Sets the target temperature for a temperature_fan. If a target is not supplied, it is set to the specified temperature in the config file. If speeds are not supplied, no change is applied.", - "codes": [ - "SET_TEMPERATURE_FAN_TARGET" - ], - "id": "Klipper.SET_TEMPERATURE_FAN_TARGET[0]", - "parameters": [ - { - "description": "", - "label": "temperature_fan=", - "optional": false, - "tag": "temperature_fan", - "values": [] - }, - { - "description": "", - "label": "target=", - "optional": true, - "tag": "target", - "values": [] - }, - { - "description": "", - "label": "min_speed=", - "optional": true, - "tag": "min_speed", - "values": [] - }, - { - "description": "", - "label": "max_speed=", - "optional": true, - "tag": "max_speed", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Sets the target temperature for a temperature_fan", - "url": "https://www.klipper3d.org/G-Codes.html#temperature-fan-commands" - } - ], - "SET_TMC_CURRENT": [ - { - "brief": "This will adjust the run and hold currents of the TMC driver. (HOLDCURRENT is not applicable to tmc2660 drivers.)", - "codes": [ - "SET_TMC_CURRENT" - ], - "id": "Klipper.SET_TMC_CURRENT[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": false, - "tag": "STEPPER", - "values": [] - }, - { - "description": "", - "label": "CURRENT=", - "optional": false, - "tag": "CURRENT", - "values": [] - }, - { - "description": "", - "label": "HOLDCURRENT=", - "optional": false, - "tag": "HOLDCURRENT", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This will adjust the run and hold currents of the TMC driver", - "url": "https://www.klipper3d.org/G-Codes.html#tmc-stepper-drivers" - } - ], - "SET_TMC_FIELD": [ - { - "brief": "This will alter the value of the specified register field of the TMC driver. This command is intended for low-level diagnostics and debugging only because changing the fields during run-time can lead to undesired and potentially dangerous behavior of your printer. Permanent changes should be made using the printer configuration file instead. No sanity checks are performed for the given values.", - "codes": [ - "SET_TMC_FIELD" - ], - "id": "Klipper.SET_TMC_FIELD[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": false, - "tag": "STEPPER", - "values": [] - }, - { - "description": "", - "label": "FIELD=", - "optional": false, - "tag": "FIELD", - "values": [] - }, - { - "description": "", - "label": "VALUE=", - "optional": false, - "tag": "VALUE", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This will alter the value of the specified register field of the TMC driver", - "url": "https://www.klipper3d.org/G-Codes.html#tmc-stepper-drivers" - } - ], - "SET_VELOCITY_LIMIT": [ - { - "brief": "Modify the printer's velocity limits.", - "codes": [ - "SET_VELOCITY_LIMIT" - ], - "id": "Klipper.SET_VELOCITY_LIMIT[0]", - "parameters": [ - { - "description": "", - "label": "VELOCITY=", - "optional": true, - "tag": "VELOCITY", - "values": [] - }, - { - "description": "", - "label": "ACCEL=", - "optional": true, - "tag": "ACCEL", - "values": [] - }, - { - "description": "", - "label": "ACCEL_TO_DECEL=", - "optional": true, - "tag": "ACCEL_TO_DECEL", - "values": [] - }, - { - "description": "", - "label": "SQUARE_CORNER_VELOCITY=", - "optional": true, - "tag": "SQUARE_CORNER_VELOCITY", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Modify the printer's velocity limits", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SHAPER_CALIBRATE": [ - { - "brief": "Similarly to", - "codes": [ - "SHAPER_CALIBRATE" - ], - "id": "Klipper.SHAPER_CALIBRATE[0]", - "parameters": [ - { - "description": "", - "label": "AXIS=", - "optional": true, - "tag": "AXIS", - "values": [] - }, - { - "description": "", - "label": "NAME=", - "optional": true, - "tag": "NAME", - "values": [] - }, - { - "description": "", - "label": "FREQ_START=", - "optional": true, - "tag": "FREQ_START", - "values": [] - }, - { - "description": "", - "label": "FREQ_END=", - "optional": true, - "tag": "FREQ_END", - "values": [] - }, - { - "description": "", - "label": "HZ_PER_SEC=", - "optional": true, - "tag": "HZ_PER_SEC", - "values": [] - }, - { - "description": "", - "label": "MAX_SMOOTHING=", - "optional": true, - "tag": "MAX_SMOOTHING", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Similarly to", - "url": "https://www.klipper3d.org/G-Codes.html#resonance-testing-commands" - } - ], - "SKEW_PROFILE": [ + "url": "https://marlinfw.org/docs/gcode/M999" + }, { - "brief": "Profile management for skew_correction. LOAD will restore skew state from the profile matching the supplied name. SAVE will save the current skew state to a profile matching the supplied name. Remove will delete the profile matching the supplied name from persistent memory. Note that after SAVE or REMOVE operations have been run the SAVE_CONFIG gcode must be run to make the changes to peristent memory permanent.", + "brief": "", "codes": [ - "SKEW_PROFILE" + "M999" ], - "id": "Klipper.SKEW_PROFILE[0]", + "id": "RepRap.M999[0]", "parameters": [ { - "description": "", - "label": "LOAD=", - "optional": true, - "tag": "LOAD", - "values": [] - }, - { - "description": "", - "label": "SAVE=", + "description": " Reset flags", + "label": "Pnnn", "optional": true, - "tag": "SAVE", + "tag": "P", "values": [] }, { - "description": "", - "label": "REMOVE=", + "description": " CAN address of the board to reset (RRF only)", + "label": "Bnnn", "optional": true, - "tag": "REMOVE", + "tag": "B", "values": [] } ], "related": [], - "source": "Klipper", - "title": "Profile management for skew_correction", - "url": "https://www.klipper3d.org/G-Codes.html#skew-correction" - } - ], - "STATUS": [ - { - "brief": "Report the Klipper host software status.", - "codes": [ - "STATUS" - ], - "id": "Klipper.STATUS[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Report the Klipper host software status", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" + "source": "RepRap", + "title": "M999: Restart after being stopped by error", + "url": "https://reprap.org/wiki/G-code#M999:_Restart_after_being_stopped_by_error" } ], - "STEPPER_BUZZ": [ + "RESPOND": [ { - "brief": "Move the given stepper forward one mm and then backward one mm, repeated 10 times. This is a diagnostic tool to help verify stepper connectivity.", + "brief": "echo the message prepended with", "codes": [ - "STEPPER_BUZZ" + "RESPOND" ], - "id": "Klipper.STEPPER_BUZZ[0]", + "id": "Klipper.RESPOND[0]", "parameters": [ { "description": "", - "label": "STEPPER=", + "label": "PREFIX=", + "optional": false, + "tag": "PREFIX", + "values": [] + }, + { + "description": "", + "label": "MSG=\"\"", "optional": false, - "tag": "STEPPER", + "tag": "MSG\"", "values": [] } ], "related": [], "source": "Klipper", - "title": "Move the given stepper forward one mm and then backward one mm, repeated 10 times", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" + "title": "echo the message prepended with", + "url": "https://www.klipper3d.org/G-Codes.html#respond_1" } ], "STEP_DELTA": [ @@ -28735,36 +26318,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "and", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "SYNC_STEPPER_TO_EXTRUDER": [ - { - "brief": "This command will cause the given extruder STEPPER (as specified in an", - "codes": [ - "SYNC_STEPPER_TO_EXTRUDER" - ], - "id": "Klipper.SYNC_STEPPER_TO_EXTRUDER[0]", - "parameters": [ - { - "description": "", - "label": "STEPPER=", - "optional": false, - "tag": "STEPPER", - "values": [] - }, - { - "description": "", - "label": "EXTRUDER=", - "optional": true, - "tag": "EXTRUDER", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will cause the given extruder STEPPER (as specified in an", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" + "url": "https://www.klipper3d.org/G-Codes.html#tuning_tower_1" } ], "T0": [ @@ -28907,42 +26461,6 @@ window.AllGcodes = { "url": "https://marlinfw.org/docs/gcode/T001-T002" } ], - "TEMPERATURE_WAIT": [ - { - "brief": "Wait until the given temperature sensor is at or above the supplied MINIMUM and/or at or below the supplied MAXIMUM.", - "codes": [ - "TEMPERATURE_WAIT" - ], - "id": "Klipper.TEMPERATURE_WAIT[0]", - "parameters": [ - { - "description": "", - "label": "SENSOR=", - "optional": false, - "tag": "SENSOR", - "values": [] - }, - { - "description": "", - "label": "MINIMUM=", - "optional": true, - "tag": "MINIMUM", - "values": [] - }, - { - "description": "", - "label": "MAXIMUM=", - "optional": true, - "tag": "MAXIMUM", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Wait until the given temperature sensor is at or above the supplied MINIMUM and/or at or below the supplied MAXIMUM", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], "TESTZ": [ { "brief": "This command moves the nozzle up or down by the amount specified in \"value\". For example,", @@ -28962,264 +26480,7 @@ window.AllGcodes = { "related": [], "source": "Klipper", "title": "This command moves the nozzle up or down by the amount specified in \"value\"", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "TEST_RESONANCES": [ - { - "brief": "Runs the resonance test in all configured probe points for the requested", - "codes": [ - "TEST_RESONANCES" - ], - "id": "Klipper.TEST_RESONANCES[0]", - "parameters": [ - { - "description": "", - "label": "AXIS=", - "optional": false, - "tag": "AXIS", - "values": [] - }, - { - "description": "", - "label": "OUTPUT=", - "optional": false, - "tag": "OUTPUT", - "values": [] - }, - { - "description": "", - "label": "NAME=", - "optional": true, - "tag": "NAME", - "values": [] - }, - { - "description": "", - "label": "FREQ_START=", - "optional": true, - "tag": "FREQ_START", - "values": [] - }, - { - "description": "", - "label": "FREQ_END=", - "optional": true, - "tag": "FREQ_END", - "values": [] - }, - { - "description": "", - "label": "HZ_PER_SEC=", - "optional": true, - "tag": "HZ_PER_SEC", - "values": [] - }, - { - "description": "", - "label": "INPUT_SHAPING=<0:1>", - "optional": true, - "tag": "INPUT_SHAPING", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Runs the resonance test in all configured probe points for the requested", - "url": "https://www.klipper3d.org/G-Codes.html#resonance-testing-commands" - } - ], - "TUNING_TOWER": [ - { - "brief": "A tool for tuning a parameter on each Z height during a print. The tool will run the given", - "codes": [ - "TUNING_TOWER" - ], - "id": "Klipper.TUNING_TOWER[0]", - "parameters": [ - { - "description": "", - "label": "COMMAND=", - "optional": false, - "tag": "COMMAND", - "values": [] - }, - { - "description": "", - "label": "PARAMETER=", - "optional": false, - "tag": "PARAMETER", - "values": [] - }, - { - "description": "", - "label": "START=", - "optional": false, - "tag": "START", - "values": [] - }, - { - "description": "", - "label": "SKIP=", - "optional": true, - "tag": "SKIP", - "values": [] - }, - { - "description": "", - "label": "FACTOR=", - "optional": true, - "tag": "FACTOR", - "values": [] - }, - { - "description": "", - "label": "BAND=", - "optional": true, - "tag": "BAND", - "values": [] - }, - { - "description": "", - "label": "|", - "optional": false, - "tag": "|", - "values": [] - }, - { - "description": "", - "label": "STEP_DELTA=", - "optional": true, - "tag": "STEP_DELTA", - "values": [] - }, - { - "description": "", - "label": "STEP_HEIGHT=", - "optional": true, - "tag": "STEP_HEIGHT", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "A tool for tuning a parameter on each Z height during a print", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "TURN_OFF_HEATERS": [ - { - "brief": "Turn off all heaters.", - "codes": [ - "TURN_OFF_HEATERS" - ], - "id": "Klipper.TURN_OFF_HEATERS[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Turn off all heaters", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "UPDATE_DELAYED_GCODE": [ - { - "brief": "Updates the delay duration for the identified [delayed_gcode] and starts the timer for gcode execution. A value of 0 will cancel a pending delayed gcode from executing.", - "codes": [ - "UPDATE_DELAYED_GCODE" - ], - "id": "Klipper.UPDATE_DELAYED_GCODE[0]", - "parameters": [ - { - "description": "", - "label": "ID=", - "optional": true, - "tag": "ID", - "values": [] - }, - { - "description": "", - "label": "DURATION=", - "optional": true, - "tag": "DURATION", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Updates the delay duration for the identified [delayed_gcode] and starts the timer for gcode execution", - "url": "https://www.klipper3d.org/G-Codes.html#delayed-gcode" - } - ], - "Z_ENDSTOP_CALIBRATE": [ - { - "brief": "Run a helper script useful for calibrating a Z position_endstop config setting. See the MANUAL_PROBE command for details on the parameters and the additional commands available while the tool is active.", - "codes": [ - "Z_ENDSTOP_CALIBRATE" - ], - "id": "Klipper.Z_ENDSTOP_CALIBRATE[0]", - "parameters": [ - { - "description": "", - "label": "SPEED=", - "optional": true, - "tag": "SPEED", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "Run a helper script useful for calibrating a Z position_endstop config setting", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "Z_OFFSET_APPLY_ENDSTOP": [ - { - "brief": "Take the current Z Gcode offset (aka, babystepping), and subtract it from the stepper_z endstop_position. This acts to take a frequently used babystepping value, and \"make it permanent\". Requires a", - "codes": [ - "Z_OFFSET_APPLY_ENDSTOP" - ], - "id": "Klipper.Z_OFFSET_APPLY_ENDSTOP[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Take the current Z Gcode offset (aka, babystepping), and subtract it from the stepper_z endstop_position", - "url": "https://www.klipper3d.org/G-Codes.html#extended-g-code-commands" - } - ], - "Z_OFFSET_APPLY_PROBE": [ - { - "brief": "Take the current Z Gcode offset (aka, babystepping), and subtract if from the probe's z_offset. This acts to take a frequently used babystepping value, and \"make it permanent\". Requires a", - "codes": [ - "Z_OFFSET_APPLY_PROBE" - ], - "id": "Klipper.Z_OFFSET_APPLY_PROBE[0]", - "parameters": [], - "related": [], - "source": "Klipper", - "title": "Take the current Z Gcode offset (aka, babystepping), and subtract if from the probe's z_offset", - "url": "https://www.klipper3d.org/G-Codes.html#probe" - } - ], - "Z_TILT_ADJUST": [ - { - "brief": "This command will probe the points specified in the config and then make independent adjustments to each Z stepper to compensate for tilt. See the PROBE command for details on the optional probe parameters.", - "codes": [ - "Z_TILT_ADJUST" - ], - "id": "Klipper.Z_TILT_ADJUST[0]", - "parameters": [ - { - "description": "", - "label": "=", - "optional": true, - "tag": "probe_parameter=value", - "values": [] - } - ], - "related": [], - "source": "Klipper", - "title": "This command will probe the points specified in the config and then make independent adjustments to each Z stepper to compensate for tilt", - "url": "https://www.klipper3d.org/G-Codes.html#z-tilt" + "url": "https://www.klipper3d.org/G-Codes.html#manual_probe_1" } ] } \ No newline at end of file