3D-printing/klipper
1
0
Fork 0
mirror of https://github.com/Klipper3d/klipper.git synced 2025-08-09 06:45:26 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Deploying to gh-pages from @ Klipper3d/klipper@050bc33241 🚀

Browse source
This commit is contained in:
KevinOConnor 2025-04-07 19:28:49 +00:00
parent d8bc4a9531
commit 1d93e1a43e
14 changed files with 368 additions and 368 deletions
Download patch file Download diff file Expand all files Collapse all files

734
G-Codes.html
View file

@ -1546,41 +1546,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#load_cell" class="md-nav__link">
[load_cell]
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_diagnostic" class="md-nav__link">
LOAD_CELL_DIAGNOSTIC
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_calibrate" class="md-nav__link">
LOAD_CELL_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_tare" class="md-nav__link">
LOAD_CELL_TARE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_read-load_cellname" class="md-nav__link">
LOAD_CELL_READ load_cell="name"
</a>
</li>
<li class="md-nav__item">
@ -1655,6 +1620,68 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
[led]
</a>
<nav class="md-nav" aria-label="[led]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#set_led" class="md-nav__link">
SET_LED
</a>
</li>
<li class="md-nav__item">
<a href="#set_led_template" class="md-nav__link">
SET_LED_TEMPLATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#load_cell" class="md-nav__link">
[load_cell]
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_diagnostic" class="md-nav__link">
LOAD_CELL_DIAGNOSTIC
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_calibrate" class="md-nav__link">
LOAD_CELL_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_tare" class="md-nav__link">
LOAD_CELL_TARE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_read-load_cellname" class="md-nav__link">
LOAD_CELL_READ load_cell="name"
</a>
</li>
<li class="md-nav__item">
@ -1729,33 +1756,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
[led]
</a>
<nav class="md-nav" aria-label="[led]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#set_led" class="md-nav__link">
SET_LED
</a>
</li>
<li class="md-nav__item">
<a href="#set_led_template" class="md-nav__link">
SET_LED_TEMPLATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1824,26 +1824,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pid_calibrate" class="md-nav__link">
[pid_calibrate]
</a>
<nav class="md-nav" aria-label="[pid_calibrate]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pid_calibrate_1" class="md-nav__link">
PID_CALIBRATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1885,6 +1865,26 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pid_calibrate" class="md-nav__link">
[pid_calibrate]
</a>
<nav class="md-nav" aria-label="[pid_calibrate]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pid_calibrate_1" class="md-nav__link">
PID_CALIBRATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -2316,6 +2316,54 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe" class="md-nav__link">
[temperature_probe]
</a>
<nav class="md-nav" aria-label="[temperature_probe]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#temperature_probe_calibrate" class="md-nav__link">
TEMPERATURE_PROBE_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_next" class="md-nav__link">
TEMPERATURE_PROBE_NEXT
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_complete" class="md-nav__link">
TEMPERATURE_PROBE_COMPLETE:
</a>
</li>
<li class="md-nav__item">
<a href="#abort" class="md-nav__link">
ABORT
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_enable" class="md-nav__link">
TEMPERATURE_PROBE_ENABLE
</a>
</li>
<li class="md-nav__item">
@ -2464,54 +2512,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe" class="md-nav__link">
[temperature_probe]
</a>
<nav class="md-nav" aria-label="[temperature_probe]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#temperature_probe_calibrate" class="md-nav__link">
TEMPERATURE_PROBE_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_next" class="md-nav__link">
TEMPERATURE_PROBE_NEXT
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_complete" class="md-nav__link">
TEMPERATURE_PROBE_COMPLETE:
</a>
</li>
<li class="md-nav__item">
<a href="#abort" class="md-nav__link">
ABORT
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_enable" class="md-nav__link">
TEMPERATURE_PROBE_ENABLE
</a>
</li>
</ul>
@ -3842,41 +3842,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#load_cell" class="md-nav__link">
[load_cell]
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_diagnostic" class="md-nav__link">
LOAD_CELL_DIAGNOSTIC
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_calibrate" class="md-nav__link">
LOAD_CELL_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_tare" class="md-nav__link">
LOAD_CELL_TARE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_read-load_cellname" class="md-nav__link">
LOAD_CELL_READ load_cell="name"
</a>
</li>
<li class="md-nav__item">
@ -3951,6 +3916,68 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
[led]
</a>
<nav class="md-nav" aria-label="[led]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#set_led" class="md-nav__link">
SET_LED
</a>
</li>
<li class="md-nav__item">
<a href="#set_led_template" class="md-nav__link">
SET_LED_TEMPLATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#load_cell" class="md-nav__link">
[load_cell]
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_diagnostic" class="md-nav__link">
LOAD_CELL_DIAGNOSTIC
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_calibrate" class="md-nav__link">
LOAD_CELL_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_tare" class="md-nav__link">
LOAD_CELL_TARE
</a>
</li>
<li class="md-nav__item">
<a href="#load_cell_read-load_cellname" class="md-nav__link">
LOAD_CELL_READ load_cell="name"
</a>
</li>
<li class="md-nav__item">
@ -4025,33 +4052,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
[led]
</a>
<nav class="md-nav" aria-label="[led]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#set_led" class="md-nav__link">
SET_LED
</a>
</li>
<li class="md-nav__item">
<a href="#set_led_template" class="md-nav__link">
SET_LED_TEMPLATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -4120,26 +4120,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pid_calibrate" class="md-nav__link">
[pid_calibrate]
</a>
<nav class="md-nav" aria-label="[pid_calibrate]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pid_calibrate_1" class="md-nav__link">
PID_CALIBRATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -4181,6 +4161,26 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pid_calibrate" class="md-nav__link">
[pid_calibrate]
</a>
<nav class="md-nav" aria-label="[pid_calibrate]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pid_calibrate_1" class="md-nav__link">
PID_CALIBRATE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -4612,6 +4612,54 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe" class="md-nav__link">
[temperature_probe]
</a>
<nav class="md-nav" aria-label="[temperature_probe]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#temperature_probe_calibrate" class="md-nav__link">
TEMPERATURE_PROBE_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_next" class="md-nav__link">
TEMPERATURE_PROBE_NEXT
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_complete" class="md-nav__link">
TEMPERATURE_PROBE_COMPLETE:
</a>
</li>
<li class="md-nav__item">
<a href="#abort" class="md-nav__link">
ABORT
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_enable" class="md-nav__link">
TEMPERATURE_PROBE_ENABLE
</a>
</li>
<li class="md-nav__item">
@ -4760,54 +4808,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe" class="md-nav__link">
[temperature_probe]
</a>
<nav class="md-nav" aria-label="[temperature_probe]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#temperature_probe_calibrate" class="md-nav__link">
TEMPERATURE_PROBE_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_next" class="md-nav__link">
TEMPERATURE_PROBE_NEXT
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_complete" class="md-nav__link">
TEMPERATURE_PROBE_COMPLETE:
</a>
</li>
<li class="md-nav__item">
<a href="#abort" class="md-nav__link">
ABORT
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#temperature_probe_enable" class="md-nav__link">
TEMPERATURE_PROBE_ENABLE
</a>
</li>
</ul>
@ -5438,34 +5438,6 @@ and RAW sensor value for calibration points.</p>
<p><code>ENABLE_FILAMENT_WIDTH_LOG</code>: Turn on diameter logging.</p>
<h4 id="disable_filament_width_log">DISABLE_FILAMENT_WIDTH_LOG<a class="headerlink" href="#disable_filament_width_log" title="Permanent link">&para;</a></h4>
<p><code>DISABLE_FILAMENT_WIDTH_LOG</code>: Turn off diameter logging.</p>
<h3 id="load_cell">[load_cell]<a class="headerlink" href="#load_cell" title="Permanent link">&para;</a></h3>
<p>The following commands are enabled if a
<a href="Config_Reference.html#load_cell">load_cell config section</a> has been enabled.</p>
<h3 id="load_cell_diagnostic">LOAD_CELL_DIAGNOSTIC<a class="headerlink" href="#load_cell_diagnostic" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_DIAGNOSTIC [LOAD_CELL=&lt;config_name&gt;]</code>: This command collects 10
seconds of load cell data and reports statistics that can help you verify proper
operation of the load cell. This command can be run on both calibrated and
uncalibrated load cells.</p>
<h3 id="load_cell_calibrate">LOAD_CELL_CALIBRATE<a class="headerlink" href="#load_cell_calibrate" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_CALIBRATE [LOAD_CELL=&lt;config_name&gt;]</code>: Start the guided calibration
utility. Calibration is a 3 step process:</p>
<ol>
<li>First you remove all load from the load cell and run the <code>TARE</code> command</li>
<li>Next you apply a known load to the load cell and run the
<code>CALIBRATE GRAMS=nnn</code> command</li>
<li>Finally use the <code>ACCEPT</code> command to save the results</li>
</ol>
<p>You can cancel the calibration process at any time with <code>ABORT</code>.</p>
<h3 id="load_cell_tare">LOAD_CELL_TARE<a class="headerlink" href="#load_cell_tare" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_TARE [LOAD_CELL=&lt;config_name&gt;]</code>: This works just like the tare button
on digital scale. It sets the current raw reading of the load cell to be the
zero point reference value. The response is the percentage of the sensors range
that was read and the raw value in counts.</p>
<h3 id="load_cell_read-load_cellname">LOAD_CELL_READ load_cell="name"<a class="headerlink" href="#load_cell_read-load_cellname" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_READ [LOAD_CELL=&lt;config_name&gt;]</code>:
This command takes a reading from the load cell. The response is the percentage
of the sensors range that was read and the raw value in counts. If the load cell
is calibrated a force in grams is also reported.</p>
<h3 id="heaters">[heaters]<a class="headerlink" href="#heaters" title="Permanent link">&para;</a></h3>
<p>The heaters module is automatically loaded if a heater is defined in
the config file.</p>
@ -5500,6 +5472,73 @@ been configured in [input_shaper] section. SHAPER_TYPE cannot be used
together with either of SHAPER_TYPE_X and SHAPER_TYPE_Y parameters.
See <a href="Config_Reference.html#input_shaper">config reference</a> for more
details on each of these parameters.</p>
<h3 id="led">[led]<a class="headerlink" href="#led" title="Permanent link">&para;</a></h3>
<p>The following command is available when any of the
<a href="Config_Reference.html#leds">led config sections</a> are enabled.</p>
<h4 id="set_led">SET_LED<a class="headerlink" href="#set_led" title="Permanent link">&para;</a></h4>
<p><code>SET_LED LED=&lt;config_name&gt; RED=&lt;value&gt; GREEN=&lt;value&gt; BLUE=&lt;value&gt;
WHITE=&lt;value&gt; [INDEX=&lt;index&gt;] [TRANSMIT=0] [SYNC=1]</code>: This sets the
LED output. Each color <code>&lt;value&gt;</code> must be between 0.0 and 1.0. The
WHITE option is only valid on RGBW LEDs. If the LED supports multiple
chips in a daisy-chain then one may specify INDEX to alter the color
of just the given chip (1 for the first chip, 2 for the second,
etc.). If INDEX is not provided then all LEDs in the daisy-chain will
be set to the provided color. If TRANSMIT=0 is specified then the
color change will only be made on the next SET_LED command that does
not specify TRANSMIT=0; this may be useful in combination with the
INDEX parameter to batch multiple updates in a daisy-chain. By
default, the SET_LED command will sync it's changes with other ongoing
gcode commands. This can lead to undesirable behavior if LEDs are
being set while the printer is not printing as it will reset the idle
timeout. If careful timing is not needed, the optional SYNC=0
parameter can be specified to apply the changes without resetting the
idle timeout.</p>
<h4 id="set_led_template">SET_LED_TEMPLATE<a class="headerlink" href="#set_led_template" title="Permanent link">&para;</a></h4>
<p><code>SET_LED_TEMPLATE LED=&lt;led_name&gt; TEMPLATE=&lt;template_name&gt;
[&lt;param_x&gt;=&lt;literal&gt;] [INDEX=&lt;index&gt;]</code>: Assign a
<a href="Config_Reference.html#display_template">display_template</a> to a given
<a href="Config_Reference.html#leds">LED</a>. For example, if one defined a
<code>[display_template my_led_template]</code> config section then one could
assign <code>TEMPLATE=my_led_template</code> here. The display_template should
produce a comma separated string containing four floating point
numbers corresponding to red, green, blue, and white color settings.
The template will be continuously evaluated and the LED will be
automatically set to the resulting colors. One may set
display_template parameters to use during template evaluation
(parameters will be parsed as Python literals). If INDEX is not
specified then all chips in the LED's daisy-chain will be set to the
template, otherwise only the chip with the given index will be
updated. If TEMPLATE is an empty string then this command will clear
any previous template assigned to the LED (one can then use <code>SET_LED</code>
commands to manage the LED's color settings).</p>
<h3 id="load_cell">[load_cell]<a class="headerlink" href="#load_cell" title="Permanent link">&para;</a></h3>
<p>The following commands are enabled if a
<a href="Config_Reference.html#load_cell">load_cell config section</a> has been enabled.</p>
<h3 id="load_cell_diagnostic">LOAD_CELL_DIAGNOSTIC<a class="headerlink" href="#load_cell_diagnostic" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_DIAGNOSTIC [LOAD_CELL=&lt;config_name&gt;]</code>: This command collects 10
seconds of load cell data and reports statistics that can help you verify proper
operation of the load cell. This command can be run on both calibrated and
uncalibrated load cells.</p>
<h3 id="load_cell_calibrate">LOAD_CELL_CALIBRATE<a class="headerlink" href="#load_cell_calibrate" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_CALIBRATE [LOAD_CELL=&lt;config_name&gt;]</code>: Start the guided calibration
utility. Calibration is a 3 step process:</p>
<ol>
<li>First you remove all load from the load cell and run the <code>TARE</code> command</li>
<li>Next you apply a known load to the load cell and run the
<code>CALIBRATE GRAMS=nnn</code> command</li>
<li>Finally use the <code>ACCEPT</code> command to save the results</li>
</ol>
<p>You can cancel the calibration process at any time with <code>ABORT</code>.</p>
<h3 id="load_cell_tare">LOAD_CELL_TARE<a class="headerlink" href="#load_cell_tare" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_TARE [LOAD_CELL=&lt;config_name&gt;]</code>: This works just like the tare button
on digital scale. It sets the current raw reading of the load cell to be the
zero point reference value. The response is the percentage of the sensors range
that was read and the raw value in counts.</p>
<h3 id="load_cell_read-load_cellname">LOAD_CELL_READ load_cell="name"<a class="headerlink" href="#load_cell_read-load_cellname" title="Permanent link">&para;</a></h3>
<p><code>LOAD_CELL_READ [LOAD_CELL=&lt;config_name&gt;]</code>:
This command takes a reading from the load cell. The response is the percentage
of the sensors range that was read and the raw value in counts. If the load cell
is calibrated a force in grams is also reported.</p>
<h3 id="manual_probe">[manual_probe]<a class="headerlink" href="#manual_probe" title="Permanent link">&para;</a></h3>
<p>The manual_probe module is automatically loaded.</p>
<h4 id="manual_probe_1">MANUAL_PROBE<a class="headerlink" href="#manual_probe_1" title="Permanent link">&para;</a></h4>
@ -5560,45 +5599,6 @@ change the current value of the digipot. This value should typically
be between 0.0 and 1.0, unless a 'scale' is defined in the config.
When 'scale' is defined, then this value should be between 0.0 and
'scale'.</p>
<h3 id="led">[led]<a class="headerlink" href="#led" title="Permanent link">&para;</a></h3>
<p>The following command is available when any of the
<a href="Config_Reference.html#leds">led config sections</a> are enabled.</p>
<h4 id="set_led">SET_LED<a class="headerlink" href="#set_led" title="Permanent link">&para;</a></h4>
<p><code>SET_LED LED=&lt;config_name&gt; RED=&lt;value&gt; GREEN=&lt;value&gt; BLUE=&lt;value&gt;
WHITE=&lt;value&gt; [INDEX=&lt;index&gt;] [TRANSMIT=0] [SYNC=1]</code>: This sets the
LED output. Each color <code>&lt;value&gt;</code> must be between 0.0 and 1.0. The
WHITE option is only valid on RGBW LEDs. If the LED supports multiple
chips in a daisy-chain then one may specify INDEX to alter the color
of just the given chip (1 for the first chip, 2 for the second,
etc.). If INDEX is not provided then all LEDs in the daisy-chain will
be set to the provided color. If TRANSMIT=0 is specified then the
color change will only be made on the next SET_LED command that does
not specify TRANSMIT=0; this may be useful in combination with the
INDEX parameter to batch multiple updates in a daisy-chain. By
default, the SET_LED command will sync it's changes with other ongoing
gcode commands. This can lead to undesirable behavior if LEDs are
being set while the printer is not printing as it will reset the idle
timeout. If careful timing is not needed, the optional SYNC=0
parameter can be specified to apply the changes without resetting the
idle timeout.</p>
<h4 id="set_led_template">SET_LED_TEMPLATE<a class="headerlink" href="#set_led_template" title="Permanent link">&para;</a></h4>
<p><code>SET_LED_TEMPLATE LED=&lt;led_name&gt; TEMPLATE=&lt;template_name&gt;
[&lt;param_x&gt;=&lt;literal&gt;] [INDEX=&lt;index&gt;]</code>: Assign a
<a href="Config_Reference.html#display_template">display_template</a> to a given
<a href="Config_Reference.html#leds">LED</a>. For example, if one defined a
<code>[display_template my_led_template]</code> config section then one could
assign <code>TEMPLATE=my_led_template</code> here. The display_template should
produce a comma separated string containing four floating point
numbers corresponding to red, green, blue, and white color settings.
The template will be continuously evaluated and the LED will be
automatically set to the resulting colors. One may set
display_template parameters to use during template evaluation
(parameters will be parsed as Python literals). If INDEX is not
specified then all chips in the LED's daisy-chain will be set to the
template, otherwise only the chip with the given index will be
updated. If TEMPLATE is an empty string then this command will clear
any previous template assigned to the LED (one can then use <code>SET_LED</code>
commands to manage the LED's color settings).</p>
<h3 id="output_pin">[output_pin]<a class="headerlink" href="#output_pin" title="Permanent link">&para;</a></h3>
<p>The following command is available when an
<a href="Config_Reference.html#output_pin">output_pin config section</a> or
@ -5650,17 +5650,6 @@ 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 <strong>Smart Load</strong> directly on the Palette 2 screen after
the filament load is complete.</p>
<h3 id="pid_calibrate">[pid_calibrate]<a class="headerlink" href="#pid_calibrate" title="Permanent link">&para;</a></h3>
<p>The pid_calibrate module is automatically loaded if a heater is defined
in the config file.</p>
<h4 id="pid_calibrate_1">PID_CALIBRATE<a class="headerlink" href="#pid_calibrate_1" title="Permanent link">&para;</a></h4>
<p><code>PID_CALIBRATE HEATER=&lt;config_name&gt; TARGET=&lt;temperature&gt;
[WRITE_FILE=1]</code>: 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.</p>
<h3 id="pause_resume">[pause_resume]<a class="headerlink" href="#pause_resume" title="Permanent link">&para;</a></h3>
<p>The following commands are available when the
<a href="Config_Reference.html#pause_resume">pause_resume config section</a> is
@ -5680,6 +5669,17 @@ PAUSE. It is recommended to add this to your start gcode to make sure
the paused state is fresh for each print.</p>
<h4 id="cancel_print">CANCEL_PRINT<a class="headerlink" href="#cancel_print" title="Permanent link">&para;</a></h4>
<p><code>CANCEL_PRINT</code>: Cancels the current print.</p>
<h3 id="pid_calibrate">[pid_calibrate]<a class="headerlink" href="#pid_calibrate" title="Permanent link">&para;</a></h3>
<p>The pid_calibrate module is automatically loaded if a heater is defined
in the config file.</p>
<h4 id="pid_calibrate_1">PID_CALIBRATE<a class="headerlink" href="#pid_calibrate_1" title="Permanent link">&para;</a></h4>
<p><code>PID_CALIBRATE HEATER=&lt;config_name&gt; TARGET=&lt;temperature&gt;
[WRITE_FILE=1]</code>: 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.</p>
<h3 id="print_stats">[print_stats]<a class="headerlink" href="#print_stats" title="Permanent link">&para;</a></h3>
<p>The print_stats module is automatically loaded.</p>
<h4 id="set_print_stats_info">SET_PRINT_STATS_INFO<a class="headerlink" href="#set_print_stats_info" title="Permanent link">&para;</a></h4>
@ -5988,6 +5988,35 @@ is enabled.</p>
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.</p>
<h3 id="temperature_probe">[temperature_probe]<a class="headerlink" href="#temperature_probe" title="Permanent link">&para;</a></h3>
<p>The following commands are available when a
<a href="Config_Reference.html#temperature_probe">temperature_probe config section</a>
is enabled.</p>
<h4 id="temperature_probe_calibrate">TEMPERATURE_PROBE_CALIBRATE<a class="headerlink" href="#temperature_probe_calibrate" title="Permanent link">&para;</a></h4>
<p><code>TEMPERATURE_PROBE_CALIBRATE [PROBE=&lt;probe name&gt;] [TARGET=&lt;value&gt;] [STEP=&lt;value&gt;]</code>:
Initiates probe drift calibration for eddy current based probes. The <code>TARGET</code>
is a target temperature for the last sample. When the temperature recorded
during a sample exceeds the <code>TARGET</code> calibration will complete. The <code>STEP</code>
parameter sets temperature delta (in C) between samples. After a sample has
been taken, this delta is used to schedule a call to <code>TEMPERATURE_PROBE_NEXT</code>.
The default <code>STEP</code> is 2.</p>
<h4 id="temperature_probe_next">TEMPERATURE_PROBE_NEXT<a class="headerlink" href="#temperature_probe_next" title="Permanent link">&para;</a></h4>
<p><code>TEMPERATURE_PROBE_NEXT</code>: After calibration has started this command is run to
take the next sample. It is automatically scheduled to run when the delta
specified by <code>STEP</code> has been reached, however its also possible to manually run
this command to force a new sample. This command is only available during
calibration.</p>
<h4 id="temperature_probe_complete">TEMPERATURE_PROBE_COMPLETE:<a class="headerlink" href="#temperature_probe_complete" title="Permanent link">&para;</a></h4>
<p><code>TEMPERATURE_PROBE_COMPLETE</code>: Can be used to end calibration and save the
current result before the <code>TARGET</code> temperature is reached. This command
is only available during calibration.</p>
<h4 id="abort">ABORT<a class="headerlink" href="#abort" title="Permanent link">&para;</a></h4>
<p><code>ABORT</code>: Aborts the calibration process, discarding the current results.
This command is only available during drift calibration.</p>
<h3 id="temperature_probe_enable">TEMPERATURE_PROBE_ENABLE<a class="headerlink" href="#temperature_probe_enable" title="Permanent link">&para;</a></h3>
<p><code>TEMPERATURE_PROBE_ENABLE ENABLE=[0|1]</code>: Sets temperature drift
compensation on or off. If ENABLE is set to 0, drift compensation
will be disabled, if set to 1 it is enabled.</p>
<h3 id="tmcxxxx">[tmcXXXX]<a class="headerlink" href="#tmcxxxx" title="Permanent link">&para;</a></h3>
<p>The following commands are available when any of the
<a href="Config_Reference.html#tmc-stepper-driver-configuration">tmcXXXX config sections</a>
@ -6105,35 +6134,6 @@ independent adjustments to each Z stepper to compensate for tilt. See
the PROBE command for details on the optional probe parameters. The
optional <code>RETRIES</code>, <code>RETRY_TOLERANCE</code>, and <code>HORIZONTAL_MOVE_Z</code> values
override those options specified in the config file.</p>
<h3 id="temperature_probe">[temperature_probe]<a class="headerlink" href="#temperature_probe" title="Permanent link">&para;</a></h3>
<p>The following commands are available when a
<a href="Config_Reference.html#temperature_probe">temperature_probe config section</a>
is enabled.</p>
<h4 id="temperature_probe_calibrate">TEMPERATURE_PROBE_CALIBRATE<a class="headerlink" href="#temperature_probe_calibrate" title="Permanent link">&para;</a></h4>
<p><code>TEMPERATURE_PROBE_CALIBRATE [PROBE=&lt;probe name&gt;] [TARGET=&lt;value&gt;] [STEP=&lt;value&gt;]</code>:
Initiates probe drift calibration for eddy current based probes. The <code>TARGET</code>
is a target temperature for the last sample. When the temperature recorded
during a sample exceeds the <code>TARGET</code> calibration will complete. The <code>STEP</code>
parameter sets temperature delta (in C) between samples. After a sample has
been taken, this delta is used to schedule a call to <code>TEMPERATURE_PROBE_NEXT</code>.
The default <code>STEP</code> is 2.</p>
<h4 id="temperature_probe_next">TEMPERATURE_PROBE_NEXT<a class="headerlink" href="#temperature_probe_next" title="Permanent link">&para;</a></h4>
<p><code>TEMPERATURE_PROBE_NEXT</code>: After calibration has started this command is run to
take the next sample. It is automatically scheduled to run when the delta
specified by <code>STEP</code> has been reached, however its also possible to manually run
this command to force a new sample. This command is only available during
calibration.</p>
<h4 id="temperature_probe_complete">TEMPERATURE_PROBE_COMPLETE:<a class="headerlink" href="#temperature_probe_complete" title="Permanent link">&para;</a></h4>
<p><code>TEMPERATURE_PROBE_COMPLETE</code>: Can be used to end calibration and save the
current result before the <code>TARGET</code> temperature is reached. This command
is only available during calibration.</p>
<h4 id="abort">ABORT<a class="headerlink" href="#abort" title="Permanent link">&para;</a></h4>
<p><code>ABORT</code>: Aborts the calibration process, discarding the current results.
This command is only available during drift calibration.</p>
<h3 id="temperature_probe_enable">TEMPERATURE_PROBE_ENABLE<a class="headerlink" href="#temperature_probe_enable" title="Permanent link">&para;</a></h3>
<p><code>TEMPERATURE_PROBE_ENABLE ENABLE=[0|1]</code>: Sets temperature drift
compensation on or off. If ENABLE is set to 0, drift compensation
will be disabled, if set to 1 it is enabled.</p>
</article>