Deploying to gh-pages from @ Klipper3d/klipper@14a83103c3 🚀

This commit is contained in:
KevinOConnor
2024-09-06 00:04:39 +00:00
parent 6478486f2c
commit 6d8124a0cc
303 changed files with 23968 additions and 2228 deletions

View File

@@ -451,8 +451,8 @@
<li class="md-nav__item">
<a href="OctoPrint.md" class="md-nav__link">
None
<a href="OctoPrint.html" class="md-nav__link">
OctoPrint for Klipper
</a>
</li>
@@ -1020,6 +1020,13 @@
[smart_effector]
</a>
</li>
<li class="md-nav__item">
<a href="#probe_eddy_current" class="md-nav__link">
[probe_eddy_current]
</a>
</li>
<li class="md-nav__item">
@@ -1130,6 +1137,13 @@
[temperature_sensor]
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe" class="md-nav__link">
[temperature_probe]
</a>
</li>
</ul>
@@ -1174,8 +1188,8 @@
</li>
<li class="md-nav__item">
<a href="#bmp280bme280bme680" class="md-nav__link">
BMP280/BME280/BME680 溫度感測器
<a href="#bmp180bmp280bme280bmp388bme680-temperature-sensor" class="md-nav__link">
BMP180/BMP280/BME280/BMP388/BME680 temperature sensor
</a>
</li>
@@ -1192,6 +1206,13 @@
HTU21D 感測器
</a>
</li>
<li class="md-nav__item">
<a href="#sht3x-sensor" class="md-nav__link">
SHT3X sensor
</a>
</li>
<li class="md-nav__item">
@@ -1630,6 +1651,53 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#load-cells" class="md-nav__link">
Load Cells
</a>
<nav class="md-nav" aria-label="Load Cells">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#load_cell" class="md-nav__link">
[load_cell]
</a>
<nav class="md-nav" aria-label="[load_cell]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#xh711" class="md-nav__link">
XH711
</a>
</li>
<li class="md-nav__item">
<a href="#hx717" class="md-nav__link">
HX717
</a>
</li>
<li class="md-nav__item">
<a href="#ads1220" class="md-nav__link">
ADS1220
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -2504,8 +2572,8 @@
<li class="md-nav__item">
<a href="Eddy_Probe.md" class="md-nav__link">
None
<a href="Eddy_Probe.html" class="md-nav__link">
Eddy Current Inductive probe
</a>
</li>
@@ -3046,6 +3114,13 @@
[smart_effector]
</a>
</li>
<li class="md-nav__item">
<a href="#probe_eddy_current" class="md-nav__link">
[probe_eddy_current]
</a>
</li>
<li class="md-nav__item">
@@ -3156,6 +3231,13 @@
[temperature_sensor]
</a>
</li>
<li class="md-nav__item">
<a href="#temperature_probe" class="md-nav__link">
[temperature_probe]
</a>
</li>
</ul>
@@ -3200,8 +3282,8 @@
</li>
<li class="md-nav__item">
<a href="#bmp280bme280bme680" class="md-nav__link">
BMP280/BME280/BME680 溫度感測器
<a href="#bmp180bmp280bme280bmp388bme680-temperature-sensor" class="md-nav__link">
BMP180/BMP280/BME280/BMP388/BME680 temperature sensor
</a>
</li>
@@ -3218,6 +3300,13 @@
HTU21D 感測器
</a>
</li>
<li class="md-nav__item">
<a href="#sht3x-sensor" class="md-nav__link">
SHT3X sensor
</a>
</li>
<li class="md-nav__item">
@@ -3656,6 +3745,53 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#load-cells" class="md-nav__link">
Load Cells
</a>
<nav class="md-nav" aria-label="Load Cells">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#load_cell" class="md-nav__link">
[load_cell]
</a>
<nav class="md-nav" aria-label="[load_cell]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#xh711" class="md-nav__link">
XH711
</a>
</li>
<li class="md-nav__item">
<a href="#hx717" class="md-nav__link">
HX717
</a>
</li>
<li class="md-nav__item">
<a href="#ads1220" class="md-nav__link">
ADS1220
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -4614,6 +4750,13 @@ max_temp:
#adaptive_margin:
# An optional margin (in mm) to be added around the bed area used by
# the defined print objects when generating an adaptive mesh.
#scan_overshoot:
# The maximum amount of travel (in mm) available outside of the mesh.
# For rectangular beds this applies to travel on the X axis, and for round beds
# it applies to the entire radius. The tool must be able to travel the amount
# specified outside of the mesh. This value is used to optimize the travel
# path when performing a &quot;rapid scan&quot;. The minimum value that may be specified
# is 1. The default is no overshoot.
</code></pre></div>
<h3 id="bed_tilt">[bed_tilt]<a class="headerlink" href="#bed_tilt" title="Permanent link">&para;</a></h3>
@@ -4973,6 +5116,8 @@ path:
# be provided.
#on_error_gcode:
# A list of G-Code commands to execute when an error is reported.
# See docs/Command_Templates.md for G-Code format. The default is to
# run TURN_OFF_HEATERS.
</code></pre></div>
<h3 id="sdcard_loop">[sdcard_loop]<a class="headerlink" href="#sdcard_loop" title="Permanent link">&para;</a></h3>
@@ -5375,6 +5520,38 @@ z_offset:
# See the &quot;probe&quot; section for more information on the parameters above.
</code></pre></div>
<h3 id="probe_eddy_current">[probe_eddy_current]<a class="headerlink" href="#probe_eddy_current" title="Permanent link">&para;</a></h3>
<p>Support for eddy current inductive probes. One may define this section (instead of a probe section) to enable this probe. See the <a href="G-Codes.html#probe_eddy_current">command reference</a> for further information.</p>
<div class="highlight"><pre><span></span><code>[probe_eddy_current my_eddy_probe]
sensor_type: ldc1612
# The sensor chip used to perform eddy current measurements. This
# parameter must be provided and must be set to ldc1612.
#intb_pin:
# MCU gpio pin connected to the ldc1612 sensor&#39;s INTB pin (if
# available). The default is to not use the INTB pin.
#z_offset:
# The nominal distance (in mm) between the nozzle and bed that a
# probing attempt should stop at. This parameter must be provided.
#i2c_address:
#i2c_mcu:
#i2c_bus:
#i2c_software_scl_pin:
#i2c_software_sda_pin:
#i2c_speed:
# The i2c settings for the sensor chip. See the &quot;common I2C
# settings&quot; section for a description of the above parameters.
#x_offset:
#y_offset:
#speed:
#lift_speed:
#samples:
#sample_retract_dist:
#samples_result:
#samples_tolerance:
#samples_tolerance_retries:
# See the &quot;probe&quot; section for information on these parameters.
</code></pre></div>
<h3 id="axis_twist_compensation">[axis_twist_compensation]<a class="headerlink" href="#axis_twist_compensation" title="Permanent link">&para;</a></h3>
<p>A tool to compensate for inaccurate probe readings due to twist in X gantry. See the <a href="Axis_Twist_Compensation.html">Axis Twist Compensation Guide</a> for more detailed information regarding symptoms, configuration and setup.</p>
<div class="highlight"><pre><span></span><code>[axis_twist_compensation]
@@ -5623,6 +5800,59 @@ extruder:
# parameter.
</code></pre></div>
<h3 id="temperature_probe">[temperature_probe]<a class="headerlink" href="#temperature_probe" title="Permanent link">&para;</a></h3>
<p>Reports probe coil temperature. Includes optional thermal drift calibration for eddy current based probes. A <code>[temperature_probe]</code> section may be linked to a <code>[probe_eddy_current]</code> by using the same postfix for both sections.</p>
<div class="highlight"><pre><span></span><code>[temperature_probe my_probe]
#sensor_type:
#sensor_pin:
#min_temp:
#max_temp:
# Temperature sensor configuration.
# See the &quot;extruder&quot; section for the definition of the above
# parameters.
#smooth_time:
# A time value (in seconds) over which temperature measurements will
# be smoothed to reduce the impact of measurement noise. The default
# is 2.0 seconds.
#gcode_id:
# See the &quot;heater_generic&quot; section for the definition of this
# parameter.
#speed:
# The travel speed [mm/s] for xy moves during calibration. Default
# is the speed defined by the probe.
#horizontal_move_z:
# The z distance [mm] from the bed at which xy moves will occur
# during calibration. Default is 2mm.
#resting_z:
# The z distance [mm] from the bed at which the tool will rest
# to heat the probe coil during calibration. Default is .4mm
#calibration_position:
# The X, Y, Z position where the tool should be moved when
# probe drift calibration initializes. This is the location
# where the first manual probe will occur. If omitted, the
# default behavior is not to move the tool prior to the first
# manual probe.
#calibration_bed_temp:
# The maximum safe bed temperature (in C) used to heat the probe
# during probe drift calibration. When set, the calibration
# procedure will turn on the bed after the first sample is
# taken. When the calibration procedure is complete the bed
# temperature will be set to zero. When omitted the default
# behavior is not to set the bed temperature.
#calibration_extruder_temp:
# The extruder temperature (in C) set probe during drift calibration.
# When this option is supplied the procedure will wait for until the
# specified temperature is reached before requesting the first manual
# probe. When the calibration procedure is complete the extruder
# temperature will be set to 0. When omitted the default behavior is
# not to set the extruder temperature.
#extruder_heating_z: 50.
# The Z location where extruder heating will occur if the
# &quot;calibration_extruder_temp&quot; option is set. Its recommended to heat
# the extruder some distance from the bed to minimize its impact on
# the probe coil temperature. The default is 50.
</code></pre></div>
<h2 id="_18">溫度傳感器<a class="headerlink" href="#_18" title="Permanent link">&para;</a></h2>
<p>Klipper includes definitions for many types of temperature sensors. These sensors may be used in any config section that requires a temperature sensor (such as an <code>[extruder]</code> or <code>[heater_bed]</code> section).</p>
<h3 id="_19">常見熱敏電阻<a class="headerlink" href="#_19" title="Permanent link">&para;</a></h3>
@@ -5701,12 +5931,12 @@ sensor_pin:
# name in the above list.
</code></pre></div>
<h3 id="bmp280bme280bme680">BMP280/BME280/BME680 溫度感測器<a class="headerlink" href="#bmp280bme280bme680" title="Permanent link">&para;</a></h3>
<p>BMP280/BME280/BME680 兩線介面 (I2C) 環境感測器。注意,這些感測器不適用于擠出機和加熱床。它們可以用於監測環境溫度 (C)、壓力 (hPa)、相對濕度以及氣體水平僅在BME680上。請參閱 <a href="https://github.com/Klipper3d/klipper/blob/master/config/sample-macros.cfg">sample-macros.cfg</a> 以獲取可用於報告壓力和濕度以及溫度的gcode_macro。</p>
<h3 id="bmp180bmp280bme280bmp388bme680-temperature-sensor">BMP180/BMP280/BME280/BMP388/BME680 temperature sensor<a class="headerlink" href="#bmp180bmp280bme280bmp388bme680-temperature-sensor" title="Permanent link">&para;</a></h3>
<p>BMP180/BMP280/BME280/BMP388/BME680 two wire interface (I2C) environmental sensors. Note that these sensors are not intended for use with extruders and heater beds, but rather for monitoring ambient temperature (C), pressure (hPa), relative humidity and in case of the BME680 gas level. See <a href="https://github.com/Klipper3d/klipper/blob/master/config/sample-macros.cfg">sample-macros.cfg</a> for a gcode_macro that may be used to report pressure and humidity in addition to temperature.</p>
<div class="highlight"><pre><span></span><code>sensor_type: BME280
#i2c_address:
# Default is 118 (0x76). Some BME280 sensors have an address of 119
# (0x77).
# Default is 118 (0x76). The BMP180, BMP388 and some BME280 sensors
# have an address of 119 (0x77).
#i2c_mcu:
#i2c_bus:
#i2c_software_scl_pin:
@@ -5761,6 +5991,20 @@ sensor_pin:
# Interval in seconds between readings. Default is 30
</code></pre></div>
<h3 id="sht3x-sensor">SHT3X sensor<a class="headerlink" href="#sht3x-sensor" title="Permanent link">&para;</a></h3>
<p>SHT3X family two wire interface (I2C) environmental sensor. These sensors have a range of -55~125 C, so are usable for e.g. chamber temperature monitoring. They can also function as simple fan/heater controllers.</p>
<div class="highlight"><pre><span></span><code>sensor_type: SHT3X
#i2c_address:
# Default is 68 (0x44).
#i2c_mcu:
#i2c_bus:
#i2c_software_scl_pin:
#i2c_software_sda_pin:
#i2c_speed:
# See the &quot;common I2C settings&quot; section for a description of the
# above parameters.
</code></pre></div>
<h3 id="lm75">LM75 溫度感測器<a class="headerlink" href="#lm75" title="Permanent link">&para;</a></h3>
<p>LM75/LM75A 兩線 (I2C) 連接的溫度傳感器。這些傳感器的範圍為 -55~125 C因此可用於例如室溫度監測。它們還可以用作簡單的風扇/加熱器控制器。</p>
<div class="highlight"><pre><span></span><code>sensor_type: LM75
@@ -6345,6 +6589,18 @@ run_current:
# set, &quot;stealthChop&quot; mode will be enabled if the stepper motor
# velocity is below this value. The default is 0, which disables
# &quot;stealthChop&quot; mode.
#coolstep_threshold:
# The velocity (in mm/s) to set the TMC driver internal &quot;CoolStep&quot;
# threshold to. If set, the coolstep feature will be enabled when
# the stepper motor velocity is near or above this value. Important
# - if coolstep_threshold is set and &quot;sensorless homing&quot; is used,
# then one must ensure that the homing speed is above the coolstep
# threshold! The default is to not enable the coolstep feature.
#high_velocity_threshold:
# The velocity (in mm/s) to set the TMC driver internal &quot;high
# velocity&quot; threshold (THIGH) to. This is typically used to disable
# the &quot;CoolStep&quot; feature at high speeds. The default is to not set a
# TMC &quot;high velocity&quot; threshold.
#driver_MSLUT0: 2863314260
#driver_MSLUT1: 1251300522
#driver_MSLUT2: 608774441
@@ -6375,11 +6631,19 @@ run_current:
#driver_TOFF: 4
#driver_HEND: 7
#driver_HSTRT: 0
#driver_VHIGHFS: 0
#driver_VHIGHCHM: 0
#driver_PWM_AUTOSCALE: True
#driver_PWM_FREQ: 1
#driver_PWM_GRAD: 4
#driver_PWM_AMPL: 128
#driver_SGT: 0
#driver_SEMIN: 0
#driver_SEUP: 0
#driver_SEMAX: 0
#driver_SEDN: 0
#driver_SEIMIN: 0
#driver_SFILT: 0
# Set the given register during the configuration of the TMC2130
# chip. This may be used to set custom motor parameters. The
# defaults for each parameter are next to the parameter name in the
@@ -6464,6 +6728,13 @@ run_current:
#sense_resistor: 0.110
#stealthchop_threshold: 0
# See the &quot;tmc2208&quot; section for the definition of these parameters.
#coolstep_threshold:
# The velocity (in mm/s) to set the TMC driver internal &quot;CoolStep&quot;
# threshold to. If set, the coolstep feature will be enabled when
# the stepper motor velocity is near or above this value. Important
# - if coolstep_threshold is set and &quot;sensorless homing&quot; is used,
# then one must ensure that the homing speed is above the coolstep
# threshold! The default is to not enable the coolstep feature.
#uart_address:
# The address of the TMC2209 chip for UART messages (an integer
# between 0 and 3). This is typically used when multiple TMC2209
@@ -6483,6 +6754,11 @@ run_current:
#driver_PWM_GRAD: 14
#driver_PWM_OFS: 36
#driver_SGTHRS: 0
#driver_SEMIN: 0
#driver_SEUP: 0
#driver_SEMAX: 0
#driver_SEDN: 0
#driver_SEIMIN: 0
# Set the given register during the configuration of the TMC2209
# chip. This may be used to set custom motor parameters. The
# defaults for each parameter are next to the parameter name in the
@@ -6605,6 +6881,18 @@ run_current:
# set, &quot;stealthChop&quot; mode will be enabled if the stepper motor
# velocity is below this value. The default is 0, which disables
# &quot;stealthChop&quot; mode.
#coolstep_threshold:
# The velocity (in mm/s) to set the TMC driver internal &quot;CoolStep&quot;
# threshold to. If set, the coolstep feature will be enabled when
# the stepper motor velocity is near or above this value. Important
# - if coolstep_threshold is set and &quot;sensorless homing&quot; is used,
# then one must ensure that the homing speed is above the coolstep
# threshold! The default is to not enable the coolstep feature.
#high_velocity_threshold:
# The velocity (in mm/s) to set the TMC driver internal &quot;high
# velocity&quot; threshold (THIGH) to. This is typically used to disable
# the &quot;CoolStep&quot; feature at high speeds. The default is to not set a
# TMC &quot;high velocity&quot; threshold.
#driver_MSLUT0: 2863314260
#driver_MSLUT1: 1251300522
#driver_MSLUT2: 608774441
@@ -6720,6 +7008,18 @@ run_current:
# set, &quot;stealthChop&quot; mode will be enabled if the stepper motor
# velocity is below this value. The default is 0, which disables
# &quot;stealthChop&quot; mode.
#coolstep_threshold:
# The velocity (in mm/s) to set the TMC driver internal &quot;CoolStep&quot;
# threshold to. If set, the coolstep feature will be enabled when
# the stepper motor velocity is near or above this value. Important
# - if coolstep_threshold is set and &quot;sensorless homing&quot; is used,
# then one must ensure that the homing speed is above the coolstep
# threshold! The default is to not enable the coolstep feature.
#high_velocity_threshold:
# The velocity (in mm/s) to set the TMC driver internal &quot;high
# velocity&quot; threshold (THIGH) to. This is typically used to disable
# the &quot;CoolStep&quot; feature at high speeds. The default is to not set a
# TMC &quot;high velocity&quot; threshold.
#driver_MSLUT0: 2863314260
#driver_MSLUT1: 1251300522
#driver_MSLUT2: 608774441
@@ -7374,6 +7674,86 @@ adc2:
# 關於上述參數的描述請參見&quot;filament_switch_sensor&quot;章節。
</code></pre></div>
<h2 id="load-cells">Load Cells<a class="headerlink" href="#load-cells" title="Permanent link">&para;</a></h2>
<h3 id="load_cell">[load_cell]<a class="headerlink" href="#load_cell" title="Permanent link">&para;</a></h3>
<p>Load Cell. Uses an ADC sensor attached to a load cell to create a digital scale.</p>
<div class="highlight"><pre><span></span><code>[load_cell]
sensor_type:
# This must be one of the supported sensor types, see below.
</code></pre></div>
<h4 id="xh711">XH711<a class="headerlink" href="#xh711" title="Permanent link">&para;</a></h4>
<p>This is a 24 bit low sample rate chip using "bit-bang" communications. It is suitable for filament scales.</p>
<div class="highlight"><pre><span></span><code>[load_cell]
sensor_type: hx711
sclk_pin:
# The pin connected to the HX711 clock line. This parameter must be provided.
dout_pin:
# The pin connected to the HX711 data output line. This parameter must be
# provided.
#gain: A-128
# Valid values for gain are: A-128, A-64, B-32. The default is A-128.
# &#39;A&#39; denotes the input channel and the number denotes the gain. Only the 3
# listed combinations are supported by the chip. Note that changing the gain
# setting also selects the channel being read.
#sample_rate: 80
# Valid values for sample_rate are 80 or 10. The default value is 80.
# This must match the wiring of the chip. The sample rate cannot be changed
# in software.
</code></pre></div>
<h4 id="hx717">HX717<a class="headerlink" href="#hx717" title="Permanent link">&para;</a></h4>
<p>This is the 4x higher sample rate version of the HX711, suitable for probing.</p>
<div class="highlight"><pre><span></span><code>[load_cell]
sensor_type: hx717
sclk_pin:
# The pin connected to the HX717 clock line. This parameter must be provided.
dout_pin:
# The pin connected to the HX717 data output line. This parameter must be
# provided.
#gain: A-128
# Valid values for gain are A-128, B-64, A-64, B-8.
# &#39;A&#39; denotes the input channel and the number denotes the gain setting.
# Only the 4 listed combinations are supported by the chip. Note that
# changing the gain setting also selects the channel being read.
#sample_rate: 320
# Valid values for sample_rate are: 10, 20, 80, 320. The default is 320.
# This must match the wiring of the chip. The sample rate cannot be changed
# in software.
</code></pre></div>
<h4 id="ads1220">ADS1220<a class="headerlink" href="#ads1220" title="Permanent link">&para;</a></h4>
<p>The ADS1220 is a 24 bit ADC supporting up to a 2Khz sample rate configurable in software.</p>
<div class="highlight"><pre><span></span><code>[load_cell]
sensor_type: ads1220
cs_pin:
# The pin connected to the ADS1220 chip select line. This parameter must
# be provided.
#spi_speed: 512000
# This chip supports 2 speeds: 256000 or 512000. The faster speed is only
# enabled when one of the Turbo sample rates is used. The correct spi_speed
# is selected based on the sample rate.
#spi_bus:
#spi_software_sclk_pin:
#spi_software_mosi_pin:
#spi_software_miso_pin:
# See the &quot;common SPI settings&quot; section for a description of the
# above parameters.
data_ready_pin:
# Pin connected to the ADS1220 data ready line. This parameter must be
# provided.
#gain: 128
# Valid gain values are 128, 64, 32, 16, 8, 4, 2, 1
# The default is 128
#sample_rate: 660
# This chip supports two ranges of sample rates, Normal and Turbo. In turbo
# mode the chips c internal clock runs twice as fast and the SPI communication
# speed is also doubled.
# Normal sample rates: 20, 45, 90, 175, 330, 600, 1000
# Turbo sample rates: 40, 90, 180, 350, 660, 1200, 2000
# The default is 660
</code></pre></div>
<h2 id="_27">控制板特定硬體支援<a class="headerlink" href="#_27" title="Permanent link">&para;</a></h2>
<h3 id="sx1509">[sx1509]<a class="headerlink" href="#sx1509" title="Permanent link">&para;</a></h3>
<p>將一個 SX1509 I2C 配置為 GPIO 擴充套件器。由於 I2C 通訊本身的延遲,不應將 SX1509 引腳用作步進電機的 enable (啟用)、step步進或 dir (方向)引腳或任何其他需要快速 bit-banging位拆裂的引腳。它們最適合用作靜態或G程式碼控制的數字輸出或硬體 pwm 引腳例如風扇。可以使用「sx1509」字首定義任意數量的分段。每個擴充套件器提供可用於印表機配置的一組 16 個引腳sx1509_my_sx1509:PIN_0 到 sx1509_my_sx1509:PIN_15</p>
@@ -7600,7 +7980,7 @@ cs_pin:
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="Installation.html" class="md-footer__link md-footer__link--prev" aria-label="上一頁: 安裝" rel="prev">
<a href="OctoPrint.html" class="md-footer__link md-footer__link--prev" aria-label="上一頁: OctoPrint for Klipper" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
@@ -7609,7 +7989,7 @@ cs_pin:
<span class="md-footer__direction">
上一頁
</span>
安裝
OctoPrint for Klipper
</div>
</div>
</a>