Deploying to gh-pages from @ Klipper3d/klipper@1cc6398074 🚀

This commit is contained in:
KevinOConnor
2025-05-04 00:06:21 +00:00
parent 9d64784cd9
commit 06b88075fb
308 changed files with 12816 additions and 2971 deletions

View File

@@ -931,6 +931,13 @@
[adxl345]
</a>
</li>
<li class="md-nav__item">
<a href="#icm20948" class="md-nav__link">
[icm20948]
</a>
</li>
<li class="md-nav__item">
@@ -1741,6 +1748,13 @@
[adc_scaled]
</a>
</li>
<li class="md-nav__item">
<a href="#ads1x1x" class="md-nav__link">
[ads1x1x]
</a>
</li>
<li class="md-nav__item">
@@ -2600,8 +2614,8 @@
<li class="md-nav__item">
<a href="Load_Cell.md" class="md-nav__link">
None
<a href="Load_Cell.html" class="md-nav__link">
Load Cells
</a>
</li>
@@ -3053,6 +3067,13 @@
[adxl345]
</a>
</li>
<li class="md-nav__item">
<a href="#icm20948" class="md-nav__link">
[icm20948]
</a>
</li>
<li class="md-nav__item">
@@ -3863,6 +3884,13 @@
[adc_scaled]
</a>
</li>
<li class="md-nav__item">
<a href="#ads1x1x" class="md-nav__link">
[ads1x1x]
</a>
</li>
<li class="md-nav__item">
@@ -5212,6 +5240,22 @@ cs_pin:
# 共振测量的质量。
</code></pre></div>
<h3 id="icm20948">[icm20948]<a class="headerlink" href="#icm20948" title="Permanent link">&para;</a></h3>
<p>Support for icm20948 accelerometers.</p>
<div class="highlight"><pre><span></span><code>[icm20948]
#i2c_address:
# Default is 104 (0x68). If AD0 is high, it would be 0x69 instead.
#i2c_mcu:
#i2c_bus:
#i2c_software_scl_pin:
#i2c_software_sda_pin:
#i2c_speed: 400000
# See the &quot;common I2C settings&quot; section for a description of the
# above parameters. The default &quot;i2c_speed&quot; is 400000.
#axes_map: x, y, z
# See the &quot;adxl345&quot; section for information on this parameter.
</code></pre></div>
<h3 id="lis2dw">[lis2dw]<a class="headerlink" href="#lis2dw" title="Permanent link">&para;</a></h3>
<p>Support for LIS2DW accelerometers.</p>
<div class="highlight"><pre><span></span><code>[lis2dw]
@@ -5529,6 +5573,9 @@ z_offset:
sensor_type: ldc1612
# The sensor chip used to perform eddy current measurements. This
# parameter must be provided and must be set to ldc1612.
#frequency:
# The external crystal frequency (in Hz) of the LDC1612 chip.
# The default is 12000000.
#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.
@@ -6436,20 +6483,27 @@ pin:
<p>在一个按钮被按下或放开或当一个引脚状态发生变化时时运行G代码。你可以使用 <code>QUERY_BUTTON button=my_gcode_button</code> 来查询按钮的状态。</p>
<div class="highlight"><pre><span></span><code>[gcode_button my_gcode_button]
pin:
# 连接到按钮的引脚。
# 必须提供此参数。
# The pin on which the button is connected. This parameter must be
# provided.
#analog_range:
# 两个逗号分隔的阻值(单位:欧姆),指定了按钮的最小和最大电阻。
# 如果提供了 analog_range ,必须使用一个模拟功能的引脚。默认
# 情况下为按钮使用数字GPIO。
# analog_pullup_resistor:
# 当定义 analog_range 时的上拉电阻(欧姆)。默认为4700欧姆。
# Two comma separated resistances (in Ohms) specifying the minimum
# and maximum resistance range for the button. If analog_range is
# provided then the pin must be an analog capable pin. The default
# is to use digital gpio for the button.
#analog_pullup_resistor:
# The pullup resistance (in Ohms) when analog_range is specified.
# The default is 4700 ohms.
#press_gcode:
# 当按钮被按下时要执行的 G-Code 命令序列支持G-Code模板。
# 必须提供此参数。
# A list of G-Code commands to execute when the button is pressed.
# G-Code templates are supported. This parameter must be provided.
#release_gcode:
# 当按钮被释放时要执行的G-Code命令序列支持G-Code模板。
# 默认在按钮释放时不运行任何命令。
# A list of G-Code commands to execute when the button is released.
# G-Code templates are supported. The default is to not run any
# commands on a button release.
#debounce_delay:
# A period of time in seconds to debounce events prior to running the
# button gcode. If the button is pressed and released during this
# delay, the entire button press is ignored. Default is 0.
</code></pre></div>
<h3 id="output_pin">[output_pin]<a class="headerlink" href="#output_pin" title="Permanent link">&para;</a></h3>
@@ -6582,8 +6636,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the &quot;stealthChop&quot; threshold to. When
# 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.
# velocity is below this value. Note that the &quot;sensorless homing&quot;
# code may temporarily override this setting during homing
# operations. 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
@@ -6632,6 +6687,7 @@ run_current:
#driver_PWM_FREQ: 1
#driver_PWM_GRAD: 4
#driver_PWM_AMPL: 128
#driver_FREEWHEEL: 0
#driver_SGT: 0
#driver_SEMIN: 0
#driver_SEUP: 0
@@ -6689,8 +6745,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the &quot;stealthChop&quot; threshold to. When
# 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.
# velocity is below this value. Note that the &quot;sensorless homing&quot;
# code may temporarily override this setting during homing
# operations. The default is 0, which disables &quot;stealthChop&quot; mode.
#driver_MULTISTEP_FILT: True
#driver_IHOLDDELAY: 8
#driver_TPOWERDOWN: 20
@@ -6705,6 +6762,7 @@ run_current:
#driver_PWM_FREQ: 1
#driver_PWM_GRAD: 14
#driver_PWM_OFS: 36
#driver_FREEWHEEL: 0
# Set the given register during the configuration of the TMC2208
# chip. This may be used to set custom motor parameters. The
# defaults for each parameter are next to the parameter name in the
@@ -6748,6 +6806,7 @@ run_current:
#driver_PWM_FREQ: 1
#driver_PWM_GRAD: 14
#driver_PWM_OFS: 36
#driver_FREEWHEEL: 0
#driver_SGTHRS: 0
#driver_SEMIN: 0
#driver_SEUP: 0
@@ -6864,8 +6923,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the &quot;stealthChop&quot; threshold to. When
# 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.
# velocity is below this value. Note that the &quot;sensorless homing&quot;
# code may temporarily override this setting during homing
# operations. 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
@@ -6992,8 +7052,9 @@ run_current:
#stealthchop_threshold: 0
# The velocity (in mm/s) to set the &quot;stealthChop&quot; threshold to. When
# 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.
# velocity is below this value. Note that the &quot;sensorless homing&quot;
# code may temporarily override this setting during homing
# operations. 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
@@ -7575,35 +7636,39 @@ text:
<h3 id="filament_switch_sensor">[filament_switch_sensor]<a class="headerlink" href="#filament_switch_sensor" title="Permanent link">&para;</a></h3>
<p>耗材开关传感器。支持使用开关传感器(如限位开关)进行耗材插入和耗尽检测。</p>
<p>更多信息请参阅<a href="G-Codes.html#filament_switch_sensor">命令参考</a></p>
<div class="highlight"><pre><span></span><code>[filament_switch_sensor my_sensor]
<div class="highlight"><pre><span></span><code>[filament_switch_sensor my_sensor]
#pause_on_runout: True
# 当设置为 &quot;True &quot;时,会在检测到耗尽后立即暂停打印机。
# 请注意, 如果 pause_on_runout False 并且没有定义。
# runout_gcode的话, 耗尽检测将被禁用。
# 默认为 True
# When set to True, a PAUSE will execute immediately after a runout
# is detected. Note that if pause_on_runout is False and the
# runout_gcode is omitted then runout detection is disabled. Default
# is True.
#runout_gcode:
# 在检测到耗材耗尽后会执行的G代码命令列表。
# 有关G-Code 格式请见 docs/Command_Templates.md
# 如果 pause_on_runout 被设置为 True这个G-Code将在
# 暂停后执行。
# 默认情况是不运行任何 G-Code 命令。
# A list of G-Code commands to execute after a filament runout is
# detected. See docs/Command_Templates.md for G-Code format. If
# pause_on_runout is set to True this G-Code will run after the
# PAUSE is complete. The default is not to run any G-Code commands.
#insert_gcode:
# 在检测到耗材插入后会执行的 G-Code 命令列表。
# 关于G代码格式请参见 docs/Command_Templates.md
# 默认不运行任何 G-Code 命令,这将禁用耗材插入检测。
# A list of G-Code commands to execute after a filament insert is
# detected. See docs/Command_Templates.md for G-Code format. The
# default is not to run any G-Code commands, which disables insert
# detection.
#event_delay: 3.0
# 事件之间的最小延迟时间(秒)。
# 在这个时间段内触发的事件将被默许忽略。
# 默认为3秒。
# The minimum amount of time in seconds to delay between events.
# Events triggered during this time period will be silently
# ignored. The default is 3 seconds.
#pause_delay: 0.5
# 暂停命令和执行 runout_gcode 之间的延迟时间, 单位是秒。
# 如果在OctoPrint的情况下增加这个延迟可能改善暂
# 停的可靠性。如果OctoPrint表现出奇怪的暂停行为
# 考虑增加这个延迟。
# 默认为0.5秒。
# The amount of time to delay, in seconds, between the pause command
# dispatch and execution of the runout_gcode. It may be useful to
# increase this delay if OctoPrint exhibits strange pause behavior.
# Default is 0.5 seconds.
#debounce_delay:
# A period of time in seconds to debounce events prior to running the
# switch gcode. The switch must he held in a single state for at least
# this long to activate. If the switch is toggled on/off during this delay,
# the event is ignored. Default is 0.
#switch_pin:
# 连接到检测开关的引脚。
# 必须提供此参数。
# The pin on which the switch is connected. This parameter must be
# provided.
</code></pre></div>
<h3 id="filament_motion_sensor">[filament_motion_sensor]<a class="headerlink" href="#filament_motion_sensor" title="Permanent link">&para;</a></h3>
@@ -7693,6 +7758,16 @@ adc2:
<div class="highlight"><pre><span></span><code>[load_cell]
sensor_type:
# This must be one of the supported sensor types, see below.
#counts_per_gram:
# The floating point number of sensor counts that indicates 1 gram of force.
# This value is calculated by the LOAD_CELL_CALIBRATE command.
#reference_tare_counts:
# The integer tare value, in raw sensor counts, taken when LOAD_CELL_CALIBRATE
# is run. This is the default tare value when klipper starts up.
#sensor_orientation:
# Change the sensor&#39;s orientation. Can be either &#39;normal&#39; or &#39;inverted&#39;.
# The default is &#39;normal&#39;. Use &#39;inverted&#39; if the sensor reports a
# decreasing force value when placed under load.
</code></pre></div>
<h4 id="hx711">HX711<a class="headerlink" href="#hx711" title="Permanent link">&para;</a></h4>
@@ -7836,6 +7911,38 @@ vssa_pin:
# VSSA 测量来减少测量的干扰。默认为2秒。
</code></pre></div>
<h3 id="ads1x1x">[ads1x1x]<a class="headerlink" href="#ads1x1x" title="Permanent link">&para;</a></h3>
<p>ADS1013, ADS1014, ADS1015, ADS1113, ADS1114 and ADS1115 are I2C based Analog to Digital Converters that can be used for temperature sensors. They provide 4 analog input pins either as single line or as differential input.</p>
<p>Note: Use caution if using this sensor to control heaters. The heater min_temp and max_temp are only verified in the host and only if the host is running and operating normally. (ADC inputs directly connected to the micro-controller verify min_temp and max_temp within the micro-controller and do not require a working connection to the host.)</p>
<div class="highlight"><pre><span></span><code>[ads1x1x my_ads1x1x]
chip: ADS1115
#pga: 4.096V
# Default value is 4.096V. The maximum voltage range used for the input. This
# scales all values read from the ADC. Options are: 6.144V, 4.096V, 2.048V,
# 1.024V, 0.512V, 0.256V
#adc_voltage: 3.3
# The suppy voltage for the device. This allows additional software scaling
# for all values read from the ADC.
i2c_mcu: host
i2c_bus: i2c.1
#address_pin: GND
# Default value is GND. There can be up to four addressed devices depending
# upon wiring of the device. Check the datasheet for details. The i2c_address
# can be specified directly instead of using the address_pin.
</code></pre></div>
<p>The chip provides pins that can be used on other sensors.</p>
<div class="highlight"><pre><span></span><code>sensor_type: ...
# Can be any thermistor or adc_temperature.
sensor_pin: my_ads1x1x:AIN0
# A combination of the name of the ads1x1x chip and the pin. Possible
# pin values are AIN0, AIN1, AIN2 and AIN3 for single ended lines and
# DIFF01, DIFF03, DIFF13 and DIFF23 for differential between their
# correspoding lines. For example
# DIFF03 measures the differential between line 0 and 3. Only specific
# combinations for the differentials are allowed.
</code></pre></div>
<h3 id="replicape">[replicape]<a class="headerlink" href="#replicape" title="Permanent link">&para;</a></h3>
<p>Replicape支持 - 参考<a href="Beaglebone.html">beaglebone guide</a><a href="./config/generic-replicape.cfg">generic-replicape.cfg</a></p>
<div class="highlight"><pre><span></span><code># &quot;replicape&quot;配置分段添加了&quot;replicape:stepper_x_enable&quot;虚拟步进使能
@@ -7898,7 +8005,7 @@ host_mcu:
<p>Palette 2 多材料支持 - 提供更紧密的集成,支持处于连接模式的 Palette 2 设备。</p>
<p>该模块的全部功能需要<code>[virtual_sdcard]</code><code>[pause_resume]</code></p>
<p>不要和 Octoprint 的 Palette 2插件一起使用这个模块因为它们会发生冲突造成初始化和打印失败。</p>
<p>如果使用 OctoPrint 并通过串行端口流式传输 G-Code而不通过 virtual_sd 打印,将 * 设置&gt;串行连接&gt;固件和协议 * 中的“暂停命令” 设置为<strong>M1</strong> <strong>M0</strong> 可以避免在开始打印时需要在Palette 2 上选择开始打印并在 OctoPrint 中取消暂停。</p>
<p>If you use Octoprint and stream gcode over the serial port instead of printing from virtual_sd, then remove <strong>M1</strong> and <strong>M0</strong> from <em>Pausing commands</em> in <em>Settings &gt; Serial Connection &gt; Firmware &amp; protocol</em> will prevent the need to start print on the Palette 2 and unpausing in Octoprint for your print to begin.</p>
<div class="highlight"><pre><span></span><code>[palette2]
serial:
# 与 Palette 2 连接的串口。