h3n3/klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ Klipper3d/klipper@cf3b0475da 🚀

Browse Source
This commit is contained in:
KevinOConnor
2025-01-17 00:05:15 +00:00
parent ab5d75e656
commit 624e1f941a
83 changed files with 3167 additions and 1149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

275
zh-Hant/Config_Reference.html
View File

@@ -938,6 +938,13 @@
[lis2dw]
</a>
</li>
<li class="md-nav__item">
<a href="#lis3dh" class="md-nav__link">
[lis3dh]
</a>
</li>
<li class="md-nav__item">
@@ -1537,6 +1544,13 @@
hd44780_spi顯示屏
</a>
</li>
<li class="md-nav__item">
<a href="#aip31068_spi-display" class="md-nav__link">
aip31068_spi display
</a>
</li>
<li class="md-nav__item">
@@ -1670,8 +1684,8 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#xh711" class="md-nav__link">
XH711
<a href="#hx711" class="md-nav__link">
HX711
</a>
</li>
@@ -3032,6 +3046,13 @@
[lis2dw]
</a>
</li>
<li class="md-nav__item">
<a href="#lis3dh" class="md-nav__link">
[lis3dh]
</a>
</li>
<li class="md-nav__item">
@@ -3631,6 +3652,13 @@
hd44780_spi顯示屏
</a>
</li>
<li class="md-nav__item">
<a href="#aip31068_spi-display" class="md-nav__link">
aip31068_spi display
</a>
</li>
<li class="md-nav__item">
@@ -3764,8 +3792,8 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#xh711" class="md-nav__link">
XH711
<a href="#hx711" class="md-nav__link">
HX711
</a>
</li>
@@ -5253,8 +5281,9 @@ cs_pin:
<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]
cs_pin:
# The SPI enable pin for the sensor. This parameter must be provided.
#cs_pin:
# The SPI enable pin for the sensor. This parameter must be provided
# if using SPI.
#spi_speed: 5000000
# The SPI speed (in hz) to use when communicating with the chip.
# The default is 5000000.
@@ -5264,6 +5293,43 @@ cs_pin:
#spi_software_miso_pin:
# See the &quot;common SPI settings&quot; section for a description of the
# above parameters.
#i2c_address:
# Default is 25 (0x19). If SA0 is high, it would be 24 (0x18) 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="lis3dh">[lis3dh]<a class="headerlink" href="#lis3dh" title="Permanent link">&para;</a></h3>
<p>Support for LIS3DH accelerometers.</p>
<div class="highlight"><pre><span></span><code>[lis3dh]
#cs_pin:
# The SPI enable pin for the sensor. This parameter must be provided
# if using SPI.
#spi_speed: 5000000
# The SPI speed (in hz) to use when communicating with the chip.
# The default is 5000000.
#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.
#i2c_address:
# Default is 25 (0x19). If SA0 is high, it would be 24 (0x18) 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>
@@ -5312,11 +5378,14 @@ cs_pin:
# auto-calibration (with &#39;SHAPER_CALIBRATE&#39; command). By default no
# maximum smoothing is specified. Refer to Measuring_Resonances guide
# for more details on using this feature.
#move_speed: 50
# The speed (in mm/s) to move the toolhead to and between test points
# during the calibration. The default is 50.
#min_freq: 5
# Minimum frequency to test for resonances. The default is 5 Hz.
#max_freq: 133.33
# Maximum frequency to test for resonances. The default is 133.33 Hz.
#accel_per_hz: 75
#accel_per_hz: 60
# This parameter is used to determine which acceleration to use to
# test a specific frequency: accel = accel_per_hz * freq. Higher the
# value, the higher is the energy of the oscillations. Can be set to
@@ -5330,6 +5399,13 @@ cs_pin:
# hz_per_sec. Small values make the test slow, and the large values
# will decrease the precision of the test. The default value is 1.0
# (Hz/sec == sec^-2).
#sweeping_accel: 400
# An acceleration of slow sweeping moves. The default is 400 mm/sec^2.
#sweeping_period: 1.2
# A period of slow sweeping moves. Setting this parameter to 0
# disables slow sweeping moves. Avoid setting it to a too small
# non-zero value in order to not poison the measurements.
# The default is 1.2 sec which is a good all-round choice.
</code></pre></div>
<h2 id="_14">配置檔案助手<a class="headerlink" href="#_14" title="Permanent link">&para;</a></h2>
@@ -5553,7 +5629,7 @@ sensor_type: ldc1612
</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>
<p>A tool to compensate for inaccurate probe readings due to twist in X or Y 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]
#speed: 50
# The speed (in mm/s) of non-probing moves during the calibration.
@@ -5564,16 +5640,33 @@ sensor_type: ldc1612
calibrate_start_x: 20
# Defines the minimum X coordinate of the calibration
# This should be the X coordinate that positions the nozzle at the starting
# calibration position. This parameter must be provided.
# calibration position.
calibrate_end_x: 200
# Defines the maximum X coordinate of the calibration
# This should be the X coordinate that positions the nozzle at the ending
# calibration position. This parameter must be provided.
# calibration position.
calibrate_y: 112.5
# Defines the Y coordinate of the calibration
# This should be the Y coordinate that positions the nozzle during the
# calibration process. This parameter must be provided and is recommended to
# calibration process. This parameter is recommended to
# be near the center of the bed
# For Y-axis twist compensation, specify the following parameters:
calibrate_start_y: ...
# Defines the minimum Y coordinate of the calibration
# This should be the Y coordinate that positions the nozzle at the starting
# calibration position for the Y axis. This parameter must be provided if
# compensating for Y axis twist.
calibrate_end_y: ...
# Defines the maximum Y coordinate of the calibration
# This should be the Y coordinate that positions the nozzle at the ending
# calibration position for the Y axis. This parameter must be provided if
# compensating for Y axis twist.
calibrate_x: ...
# Defines the X coordinate of the calibration for Y axis twist compensation
# This should be the X coordinate that positions the nozzle during the
# calibration process for Y axis twist compensation. This parameter must be
# provided and is recommended to be near the center of the bed.
</code></pre></div>
<h2 id="_16">額外的步進電機和擠出機<a class="headerlink" href="#_16" title="Permanent link">&para;</a></h2>
@@ -5851,6 +5944,10 @@ extruder:
# &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.
#max_validation_temp: 60.
# The maximum temperature used to validate the calibration. It is
# recommended to set this to a value between 100 and 120 for enclosed
# printers. The default is 60.
</code></pre></div>
<h2 id="_18">溫度傳感器<a class="headerlink" href="#_18" title="Permanent link">&para;</a></h2>
@@ -6953,6 +7050,7 @@ run_current:
#driver_SEIMIN: 0
#driver_SFILT: 0
#driver_SG4_ANGLE_OFFSET: 1
#driver_SLOPE_CONTROL: 0
# Set the given register during the configuration of the TMC2240
# chip. This may be used to set custom motor parameters. The
# defaults for each parameter are next to the parameter name in the
@@ -7223,72 +7321,82 @@ wiper:
<p>支持連接到微控制器的顯示屏。</p>
<div class="highlight"><pre><span></span><code>[display]
lcd_type:
# 使用的 LCD 晶片型別。這可以是「hd44780」、「hd44780_spi」、
# 「st7920」、「emulated_st7920」、「uc1701」、「ssd1306」、或「sh1106」。
# 有關不同的LCD晶片型別和它們特有的參數，請檢視下面的顯示屏分段。
# 必須提供此參數。
# The type of LCD chip in use. This may be &quot;hd44780&quot;, &quot;hd44780_spi&quot;,
# &quot;aip31068_spi&quot;, &quot;st7920&quot;, &quot;emulated_st7920&quot;, &quot;uc1701&quot;, &quot;ssd1306&quot;, or
# &quot;sh1106&quot;.
# See the display sections below for information on each type and
# additional parameters they provide. This parameter must be
# provided.
#display_group:
# 顯示在這個顯示屏上的 display_data 組。它決定了這個螢幕顯示
# 的內容（詳見「display_data」分段）。
# hd44780 預設使用 _default_20x4，其他顯示屏則預設使用 _default_16x4。
# The name of the display_data group to show on the display. This
# controls the content of the screen (see the &quot;display_data&quot; section
# for more information). The default is _default_20x4 for hd44780 or
# aip31068_spi displays and _default_16x4 for other displays.
#menu_timeout:
# 菜單超時時間。在不活躍給定時間后將會退出菜單或在 autorun 啟用時
# 回到根菜單。
# 預設為 0 秒（禁用）。
# Timeout for menu. Being inactive this amount of seconds will
# trigger menu exit or return to root menu when having autorun
# enabled. The default is 0 seconds (disabled)
#menu_root:
# 在主螢幕按下編碼器時顯示的主菜單段名稱。
# 預設為 __main，這會顯示在 klippy/extras/display/menu.cfg中定義的主菜單。
# Name of the main menu section to show when clicking the encoder
# on the home screen. The defaults is __main, and this shows the
# the default menus as defined in klippy/extras/display/menu.cfg
#menu_reverse_navigation:
# 啟用時反轉上滾動和下滾動。
# 預設為False。這是一個可選參數。
# When enabled it will reverse up and down directions for list
# navigation. The default is False. This parameter is optional.
#encoder_pins:
# 連線到編碼器的引腳。使用編碼器時必須提供兩個引腳。
# 使用菜單時必須提供此參數。
# The pins connected to encoder. 2 pins must be provided when using
# encoder. This parameter must be provided when using menu.
#encoder_steps_per_detent:
# 編碼器在每一個凹陷處（&quot;click&quot;）發出多少步。如果編碼器需要轉過兩個凹
# 陷才能在條目之間移動，或者轉過一個凹痕會在兩個詞條之間移動/跳過
# 一個詞條，可以嘗試改變這個值。
# 允許的值是2 （半步）或 4（全步）。
# 預設為 4。
# How many steps the encoder emits per detent (&quot;click&quot;). If the
# encoder takes two detents to move between entries or moves two
# entries from one detent, try changing this. Allowed values are 2
# (half-stepping) or 4 (full-stepping). The default is 4.
#click_pin:
# 連線到 &quot;enter&quot; 按鈕或編碼器按壓的引腳。
# 使用菜單時必須提供此參數。
# 如果定義了 「analog_range_click_pin」配置參數，則這個參數的引腳需要
# 是模擬引腳。
# The pin connected to &#39;enter&#39; button or encoder &#39;click&#39;. This
# parameter must be provided when using menu. The presence of an
# &#39;analog_range_click_pin&#39; config parameter turns this parameter
# from digital to analog.
#back_pin:
# 連線到「back」按鈕的引腳。這是一個可選參數，菜單不需要這個按鈕。
# 如果定義了 「analog_range_back_pin」配置參數，則這個參數的引腳需要
# 是模擬引腳。
# The pin connected to &#39;back&#39; button. This parameter is optional,
# menu can be used without it. The presence of an
# &#39;analog_range_back_pin&#39; config parameter turns this parameter from
# digital to analog.
#up_pin:
# 連線到「up」按鈕的引腳。在不使用編碼器時使用菜單必須提供這個參數。
# 如果定義了 「analog_range_up_pin」配置參數，則這個參數的引腳需要
# 是模擬引腳。
# The pin connected to &#39;up&#39; button. This parameter must be provided
# when using menu without encoder. The presence of an
# &#39;analog_range_up_pin&#39; config parameter turns this parameter from
# digital to analog.
#down_pin:
# 連線到「down」按鈕的引腳。 在不使用編碼器時使用菜單必須提供這個參數。
# 如果定義了 「analog_range_down_pin」配置參數，則這個參數的引腳需要
# 是模擬引腳。
# The pin connected to &#39;down&#39; button. This parameter must be
# provided when using menu without encoder. The presence of an
# &#39;analog_range_down_pin&#39; config parameter turns this parameter from
# digital to analog.
#kill_pin:
# 連線到「kill」按鈕的引腳。 這個按鈕將會觸發緊急停止。
# 如果定義了 「analog_range_kill_pin」配置參數，則這個參數的引腳需要
# 是模擬引腳。
# The pin connected to &#39;kill&#39; button. This button will call
# emergency stop. The presence of an &#39;analog_range_kill_pin&#39; config
# parameter turns this parameter from digital to analog.
#analog_pullup_resistor: 4700
# 連線到模擬按鈕的拉高電阻阻值(ohms)
# 預設為 4700 ohms。
# The resistance (in ohms) of the pullup attached to the analog
# button. The default is 4700 ohms.
#analog_range_click_pin:
# &#39;enter&#39;按鈕的阻值範圍。
# 在使用模擬按鈕時必須提供由逗號分隔最小和最大值。
# The resistance range for a &#39;enter&#39; button. Range minimum and
# maximum comma-separated values must be provided when using analog
# button.
#analog_range_back_pin:
# &#39;back&#39;按鈕的阻值範圍。
# 在使用模擬按鈕時必須提供由逗號分隔最小和最大值。
# The resistance range for a &#39;back&#39; button. Range minimum and
# maximum comma-separated values must be provided when using analog
# button.
#analog_range_up_pin:
# &#39;up&#39;按鈕的阻值範圍。
# 在使用模擬按鈕時必須提供由逗號分隔最小和最大值。
# The resistance range for a &#39;up&#39; button. Range minimum and maximum
# comma-separated values must be provided when using analog button.
#analog_range_down_pin:
# &#39;down&#39;按鈕的阻值範圍。
# 在使用模擬按鈕時必須提供由逗號分隔最小和最大值。
# The resistance range for a &#39;down&#39; button. Range minimum and
# maximum comma-separated values must be provided when using analog
# button.
#analog_range_kill_pin:
# &#39;kill&#39;按鈕的阻值範圍。
# 在使用模擬按鈕時必須提供由逗號分隔最小和最大值。
# The resistance range for a &#39;kill&#39; button. Range minimum and
# maximum comma-separated values must be provided when using analog
# button.
</code></pre></div>
<h4 id="hd44780">hd44780顯示屏<a class="headerlink" href="#hd44780" title="Permanent link">&para;</a></h4>
@@ -7339,6 +7447,26 @@ spi_software_miso_pin:
...
</code></pre></div>
<h4 id="aip31068_spi-display">aip31068_spi display<a class="headerlink" href="#aip31068_spi-display" title="Permanent link">&para;</a></h4>
<p>Information on configuring an aip31068_spi display - a very similar to hd44780_spi a 20x04 (20 symbols by 4 lines) display with slightly different internal protocol.</p>
<div class="highlight"><pre><span></span><code>[display]
lcd_type: aip31068_spi
latch_pin:
spi_software_sclk_pin:
spi_software_mosi_pin:
spi_software_miso_pin:
# The pins connected to the shift register controlling the display.
# The spi_software_miso_pin needs to be set to an unused pin of the
# printer mainboard as the shift register does not have a MISO pin,
# but the software spi implementation requires this pin to be
# configured.
#line_length:
# Set the number of characters per line for an hd44780 type lcd.
# Possible values are 20 (default) and 16. The number of lines is
# fixed to 4.
...
</code></pre></div>
<h4 id="st7920">st7920 顯示屏<a class="headerlink" href="#st7920" title="Permanent link">&para;</a></h4>
<p>有關配置 st7920 類顯示屏的資訊（可用於 "RepRapDiscount 12864 Full Graphic Smart Controller" 型別的顯示屏）。</p>
<div class="highlight"><pre><span></span><code>[display]
@@ -7682,7 +7810,7 @@ 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>
<h4 id="hx711">HX711<a class="headerlink" href="#hx711" 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
@@ -7745,13 +7873,30 @@ data_ready_pin:
#gain: 128
# Valid gain values are 128, 64, 32, 16, 8, 4, 2, 1
# The default is 128
#pga_bypass: False
# Disable the internal Programmable Gain Amplifier. If
# True the PGA will be disabled for gains 1, 2, and 4. The PGA is always
# enabled for gain settings 8 to 128, regardless of the pga_bypass setting.
# If AVSS is used as an input pga_bypass is forced to True.
# The default is False.
#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
# mode the chip&#39;s 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
#input_mux:
# Input multiplexer configuration, select a pair of pins to use. The first pin
# is the positive, AINP, and the second pin is the negative, AINN. Valid
# values are: &#39;AIN0_AIN1&#39;, &#39;AIN0_AIN2&#39;, &#39;AIN0_AIN3&#39;, &#39;AIN1_AIN2&#39;, &#39;AIN1_AIN3&#39;,
# &#39;AIN2_AIN3&#39;, &#39;AIN1_AIN0&#39;, &#39;AIN3_AIN2&#39;, &#39;AIN0_AVSS&#39;, &#39;AIN1_AVSS&#39;, &#39;AIN2_AVSS&#39;
# and &#39;AIN3_AVSS&#39;. If AVSS is used the PGA is bypassed and the pga_bypass
# setting will be forced to True.
# The default is AIN0_AIN1.
#vref:
# The selected voltage reference. Valid values are: &#39;internal&#39;, &#39;REF0&#39;, &#39;REF1&#39;
# and &#39;analog_supply&#39;. Default is &#39;internal&#39;.
</code></pre></div>
<h2 id="_27">控制板特定硬體支援<a class="headerlink" href="#_27" title="Permanent link">&para;</a></h2>
@@ -7890,11 +8035,11 @@ serial:
</code></pre></div>
<h3 id="angle">[angle]<a class="headerlink" href="#angle" title="Permanent link">&para;</a></h3>
<p>Magnetic hall angle sensor support for reading stepper motor angle shaft measurements using a1333, as5047d, or tle5012b SPI chips. The measurements are available via the <a href="API_Server.html">API Server</a> and <a href="Debugging.html#motion-analysis-and-data-logging">motion analysis tool</a>. See the <a href="G-Codes.html#angle">G-Code reference</a> for available commands.</p>
<p>Magnetic hall angle sensor support for reading stepper motor angle shaft measurements using a1333, as5047d, mt6816, mt6826s, or tle5012b SPI chips. The measurements are available via the <a href="API_Server.html">API Server</a> and <a href="Debugging.html#motion-analysis-and-data-logging">motion analysis tool</a>. See the <a href="G-Codes.html#angle">G-Code reference</a> for available commands.</p>
<div class="highlight"><pre><span></span><code>[angle my_angle_sensor]
sensor_type:
# The type of the magnetic hall sensor chip. Available choices are
# &quot;a1333&quot;, &quot;as5047d&quot;, and &quot;tle5012b&quot;. This parameter must be
# &quot;a1333&quot;, &quot;as5047d&quot;, &quot;mt6816&quot;, &quot;mt6826s&quot;, and &quot;tle5012b&quot;. This parameter must be
# specified.
#sample_period: 0.000400
# The query period (in seconds) to use during measurements. The
@@ -7938,7 +8083,7 @@ cs_pin:
<h3 id="i2c">通用 I2C 設定<a class="headerlink" href="#i2c" title="Permanent link">&para;</a></h3>
<p>以下參數通常適用於使用 I2C 總線的設備。</p>
<p>Note that Klipper's current micro-controller support for I2C is generally not tolerant to line noise. Unexpected errors on the I2C wires may result in Klipper raising a run-time error. Klipper's support for error recovery varies between each micro-controller type. It is generally recommended to only use I2C devices that are on the same printed circuit board as the micro-controller.</p>
<p>Most Klipper micro-controller implementations only support an <code>i2c_speed</code> of 100000 (<em>standard mode</em>, 100kbit/s). The Klipper "Linux" micro-controller supports a 400000 speed (<em>fast mode</em>, 400kbit/s), but it must be <a href="RPi_microcontroller.html#optional-enabling-i2c">set in the operating system</a> and the <code>i2c_speed</code> parameter is otherwise ignored. The Klipper "RP2040" micro-controller and ATmega AVR family support a rate of 400000 via the <code>i2c_speed</code> parameter. All other Klipper micro-controllers use a 100000 rate and ignore the <code>i2c_speed</code> parameter.</p>
<p>Most Klipper micro-controller implementations only support an <code>i2c_speed</code> of 100000 (<em>standard mode</em>, 100kbit/s). The Klipper "Linux" micro-controller supports a 400000 speed (<em>fast mode</em>, 400kbit/s), but it must be <a href="RPi_microcontroller.html#optional-enabling-i2c">set in the operating system</a> and the <code>i2c_speed</code> parameter is otherwise ignored. The Klipper "RP2040" micro-controller and ATmega AVR family and some STM32 (F0, G0, G4, L4, F7, H7) support a rate of 400000 via the <code>i2c_speed</code> parameter. All other Klipper micro-controllers use a 100000 rate and ignore the <code>i2c_speed</code> parameter.</p>
<div class="highlight"><pre><span></span><code>#i2c_address:
# The i2c address of the device. This must specified as a decimal
# number (not in hex). The default depends on the type of device.