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

This commit is contained in:
KevinOConnor
2022-04-09 20:31:56 +00:00
parent 21245a37f1
commit 6585e6a6c3
24 changed files with 881 additions and 373 deletions

View File

@@ -1074,6 +1074,13 @@
adxl345/dump_adxl345
</a>
</li>
<li class="md-nav__item">
<a href="#angledump_angle" class="md-nav__link">
angle/dump_angle
</a>
</li>
<li class="md-nav__item">
@@ -1512,6 +1519,13 @@
adxl345/dump_adxl345
</a>
</li>
<li class="md-nav__item">
<a href="#angledump_angle" class="md-nav__link">
angle/dump_angle
</a>
</li>
<li class="md-nav__item">
@@ -1656,6 +1670,10 @@ gcode:
<p>該端點用於訂閱 ADXL345 加速度計數據。獲取這些低級運動更新可能對診斷和調試有用。使用此端點可能會增加 Klipper 的系統負載。</p>
<p>請求可能類似於:<code>{"id": 123, "method":"adxl345/dump_adxl345", "params": {"sensor": "adxl345", "response_template": {}}}</code> 並且可能返回: <code>{"id": 123,"result":{"header":["time","x_acceleration","y_acceleration", "z_acceleration"]}}</code> 並且可能稍後會產生異步消息,例如:<code>{"params ":{"溢出":0,"數據":[[3292.432935,-535.44309,-1529.8374,9561.4], [3292.433256,-382.45935,-1606.32927,9561.48375]}}</code></p>
<p>初始查詢響應中的“header”字段用於描述在以後的“data”響應中找到的字段。</p>
<h3 id="angledump_angle">angle/dump_angle<a class="headerlink" href="#angledump_angle" title="Permanent link">&para;</a></h3>
<p>This endpoint is used to subscribe to <a href="Config_Reference.html#angle">angle sensor data</a>. Obtaining these low-level motion updates may be useful for diagnostic and debugging purposes. Using this endpoint may increase Klipper's system load.</p>
<p>A request may look like: <code>{"id": 123, "method":"angle/dump_angle", "params": {"sensor": "my_angle_sensor", "response_template": {}}}</code> and might return: <code>{"id": 123,"result":{"header":["time","angle"]}}</code> and might later produce asynchronous messages such as: <code>{"params":{"position_offset":3.151562,"errors":0, "data":[[1290.951905,-5063],[1290.952321,-5065]]}}</code></p>
<p>初始查詢響應中的“header”字段用於描述在以後的“data”響應中找到的字段。</p>
<h3 id="pause_resumecancel">pause_resume/cancel<a class="headerlink" href="#pause_resumecancel" title="Permanent link">&para;</a></h3>
<p>此端點類似於運行“PRINT_CANCEL”G 代碼命令。例如:<code>{"id": 123, "method": "pause_resume/cancel"}</code></p>
<p>與“gcode/script”端點一樣此端點僅在任何待處理的 G 代碼命令完成後才會完成。</p>

View File

@@ -1355,7 +1355,7 @@
<p>提交的檔案是否為執行真實世界任務的真實世界使用者提供了 "高度影響"的好處?審閱人仕需要至少在自己的腦海中確定大致的“目標受眾是誰”、“受眾規模”的粗略尺度、他們將獲得的“好處”、“好處是如何衡量的”,以及“這些測量測試的結果”。在大多數情況下,這對於提交者和審閱者來說都是顯而易見的,並且在審閱期間沒有明確說明。</p>
<p>向 Klipper 主分支提交的內容預計會有值得注意的目標受眾。作為一般的“經驗法則”,提交內容應針對至少 100 個真實用戶的用戶群。</p>
<p>If a reviewer asks for details on the "benefit" of a submission, please don't consider it criticism. Being able to understand the real-world benefits of a change is a natural part of a review.</p>
<p>在討論好處時,最好討論“事實和測量”而不是“觀點和理論”。一般來說,審閱人仕不會尋找“此提交可能會因為……而提高質量”形式的回复,也不會尋找“有人可能會發現選項 X 有用”形式的回复,也不會尋找以下回复表單“此提交添加了固件 X 實現的功能”。相反,通常最好討論如何衡量質量改進的細節以及這些測量的結果 - 例如“Acme X1000 打印機上的測試顯示改進的角落,如圖所示......”,或例如“在 Foomatic X900 打印機上打印真實世界對象 X 的時間從 4 小時變為 3.5 小時”。可以理解這種類型的測試可能需要大量的時間和精力。在合併到主分支之前Klipper 的一些最顯著的功能經過多年的討論、返工、測試和文檔編制。</p>
<p>When discussing benefits it is preferable to discuss "facts and measurements". In general, reviewers are not looking for responses of the form "someone may find option X useful", nor are they looking for responses of the form "this submission adds a feature that firmware X implements". Instead, it is generally preferable to discuss details on how the quality improvement was measured and what were the results of those measurements - for example, "tests on Acme X1000 printers show improved corners as seen in picture ...", or for example "print time of real-world object X on a Foomatic X900 printer went from 4 hours to 3.5 hours". It is understood that testing of this type can take significant time and effort. Some of Klipper's most notable features took months of discussion, rework, testing, and documentation prior to being merged into the master branch.</p>
<p>所有新模塊、配置選項、命令、命令參數和文檔都應該具有“高影響”。我們不想讓用戶負擔他們無法合理配置的選項,也不想讓他們負擔不提供顯著好處的選項。</p>
<p>審閱者可能會要求澄清用戶如何配置選項 - 理想的回復將包含有關過程的詳細信息 - 例如“MegaX500 的用戶預計將選項 X 設置為 99.3,而 Elite100Y 的用戶預計將使用程序校準選項 X ..."。</p>
<p>如果選項的目標是使代碼更加模塊化,那麼更喜歡使用代碼常量而不是面向用戶的配置選項。</p>

View File

@@ -1246,6 +1246,9 @@
<p>本文件涵蓋了軟體更新中對配置檔案不向后相容的部分。在升級 Klipper 時,最好也檢視一下這份文件。</p>
<p>本文件中的所有日期都是不精確的。</p>
<h2 id="_2">變更<a class="headerlink" href="#_2" title="Permanent link">&para;</a></h2>
<p>20220407: The temperature_fan <code>pid_integral_max</code> config option has been removed (it was deprecated on 20210612).</p>
<p>20220407: The default color order for pca9632 LEDs is now "RGBW". Add an explicit <code>color_order: RBGW</code> setting to the pca9632 config section to obtain the previous behavior.</p>
<p>20220330: The format of the <code>printer.neopixel.color_data</code> status information for neopixel and dotstar modules has changed. The information is now stored as a list of color lists (instead of a list of dictionaries). See the <a href="Status_Reference.html#led">status reference</a> for details.</p>
<p>20220307: <code>M73</code> will no longer set print progress to 0 if <code>P</code> is missing.</p>
<p>20220304: There is no longer a default for the <code>extruder</code> parameter of <a href="Config_Reference.html#extruder_stepper">extruder_stepper</a> config sections. If desired, specify <code>extruder: extruder</code> explicitly to associate the stepper motor with the "extruder" motion queue at startup.</p>
<p>20220210<code>SYNC_STEPPER_TO_EXTRUDER</code><code>SET_EXTRUDER_STEP_DISTANCE</code><a href="Config_Reference.html#extruder">extruder</a><code>shared_heater</code> 配置選項已棄用。這些功能將在不久的將來被刪除。將<code>SET_EXTRUDER_STEP_DISTANCE</code>替換為<code>SET_EXTRUDER_ROTATION_DISTANCE</code><code>SYNC_STEPPER_TO_EXTRUDER</code>替換為<code>SYNC_EXTRUDER_MOTION</code>,使用 <code>shared_heater</code><a href="Config_Reference.html#extruder_stepper">extruder_stepper</a>配置分段替換 extruder 配置分段,並更新所有啟用宏以使用 <a href="G-Codes.html#sync_extruder_motion">SYNC_EXTRUDER_MOTION</a></p>

View File

@@ -1155,16 +1155,16 @@
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
額外的舵機LED按鍵和其他引腳
<a href="#leds" class="md-nav__link">
LEDs
</a>
<nav class="md-nav" aria-label="額外的舵機LED按鍵和其他引腳">
<nav class="md-nav" aria-label="LEDs">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#servo" class="md-nav__link">
[servo]
<a href="#led" class="md-nav__link">
[led]
</a>
</li>
@@ -1185,14 +1185,34 @@
<li class="md-nav__item">
<a href="#pca9533" class="md-nav__link">
[PCA9533]
[pca9533]
</a>
</li>
<li class="md-nav__item">
<a href="#pca9632" class="md-nav__link">
[PCA9632]
[pca9632]
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#additional-servos-buttons-and-other-pins" class="md-nav__link">
Additional servos, buttons, and other pins
</a>
<nav class="md-nav" aria-label="Additional servos, buttons, and other pins">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#servo" class="md-nav__link">
[servo]
</a>
</li>
@@ -1517,6 +1537,13 @@
[palette2]
</a>
</li>
<li class="md-nav__item">
<a href="#angle" class="md-nav__link">
[angle]
</a>
</li>
</ul>
@@ -2985,16 +3012,16 @@
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
額外的舵機LED按鍵和其他引腳
<a href="#leds" class="md-nav__link">
LEDs
</a>
<nav class="md-nav" aria-label="額外的舵機LED按鍵和其他引腳">
<nav class="md-nav" aria-label="LEDs">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#servo" class="md-nav__link">
[servo]
<a href="#led" class="md-nav__link">
[led]
</a>
</li>
@@ -3015,14 +3042,34 @@
<li class="md-nav__item">
<a href="#pca9533" class="md-nav__link">
[PCA9533]
[pca9533]
</a>
</li>
<li class="md-nav__item">
<a href="#pca9632" class="md-nav__link">
[PCA9632]
[pca9632]
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#additional-servos-buttons-and-other-pins" class="md-nav__link">
Additional servos, buttons, and other pins
</a>
<nav class="md-nav" aria-label="Additional servos, buttons, and other pins">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#servo" class="md-nav__link">
[servo]
</a>
</li>
@@ -3347,6 +3394,13 @@
[palette2]
</a>
</li>
<li class="md-nav__item">
<a href="#angle" class="md-nav__link">
[angle]
</a>
</li>
</ul>
@@ -3999,14 +4053,17 @@ control:
# Control algorithm (either pid or watermark). This parameter must
# be provided.
pid_Kp:
# Kp is the &quot;proportional&quot; constant for the pid. This parameter must
# be provided for PID heaters.
pid_Ki:
# Ki is the &quot;integral&quot; constant for the pid. This parameter must be
# provided for PID heaters.
pid_Kd:
# Kd is the &quot;derivative&quot; constant for the pid. This parameter must
# be provided for PID heaters.
# The proportional (pid_Kp), integral (pid_Ki), and derivative
# (pid_Kd) settings for the PID feedback control system. Klipper
# evaluates the PID settings with the following general formula:
# heater_pwm = (Kp*error + Ki*integral(error) - Kd*derivative(error)) / 255
# Where &quot;error&quot; is &quot;requested_temperature - measured_temperature&quot;
# and &quot;heater_pwm&quot; is the requested heating rate with 0.0 being full
# off and 1.0 being full on. Consider using the PID_CALIBRATE
# command to obtain these parameters. The pid_Kp, pid_Ki, and pid_Kd
# parameters must be provided for PID heaters.
#max_delta: 2.0
# On &#39;watermark&#39; controlled heaters this is the number of degrees in
# Celsius above the target temperature before disabling the heater
@@ -5371,7 +5428,117 @@ pin:
# 以上參數介紹請見「fan」風扇章節。
</code></pre></div>
<h2 id="led">額外的舵機LED按鍵和其他引腳<a class="headerlink" href="#led" title="Permanent link">&para;</a></h2>
<h2 id="leds">LEDs<a class="headerlink" href="#leds" title="Permanent link">&para;</a></h2>
<h3 id="led">[led]<a class="headerlink" href="#led" title="Permanent link">&para;</a></h3>
<p>Support for LEDs (and LED strips) controlled via micro-controller PWM pins (one may define any number of sections with an "led" prefix). See the <a href="G-Codes.html#led">command reference</a> for more information.</p>
<div class="highlight"><pre><span></span><code>[led my_led]
#red_pin:
#green_pin:
#blue_pin:
#white_pin:
# The pin controlling the given LED color. At least one of the above
# parameters must be provided.
#cycle_time: 0.010
# The amount of time (in seconds) per PWM cycle. It is recommended
# this be 10 milliseconds or greater when using software based PWM.
# The default is 0.010 seconds.
#hardware_pwm: False
# Enable this to use hardware PWM instead of software PWM. When
# using hardware PWM the actual cycle time is constrained by the
# implementation and may be significantly different than the
# requested cycle_time. The default is False.
#initial_RED: 0.0
#initial_GREEN: 0.0
#initial_BLUE: 0.0
#initial_WHITE: 0.0
# Sets the initial LED color. Each value should be between 0.0 and
# 1.0. The default for each color is 0.
</code></pre></div>
<h3 id="neopixel">[neopixel]<a class="headerlink" href="#neopixel" title="Permanent link">&para;</a></h3>
<p>Neopixel (aka WS2812) LED support (one may define any number of sections with a "neopixel" prefix). See the <a href="G-Codes.html#led">command reference</a> for more information.</p>
<p>Note that the <a href="RPi_microcontroller.html">linux mcu</a> implementation does not currently support directly connected neopixels.</p>
<div class="highlight"><pre><span></span><code>[neopixel my_neopixel]
pin:
# The pin connected to the neopixel. This parameter must be
# provided.
#chain_count:
# The number of Neopixel chips that are &quot;daisy chained&quot; to the
# provided pin. The default is 1 (which indicates only a single
# Neopixel is connected to the pin).
#color_order: GRB
# Set the pixel order required by the LED hardware (using a string
# containing the letters R, G, B, W with W optional). The default is
# GRB.
#initial_RED: 0.0
#initial_GREEN: 0.0
#initial_BLUE: 0.0
#initial_WHITE: 0.0
# See the &quot;led&quot; section for information on these parameters.
</code></pre></div>
<h3 id="dotstar">[dotstar]<a class="headerlink" href="#dotstar" title="Permanent link">&para;</a></h3>
<p>Dotstar (aka APA102) LED support (one may define any number of sections with a "dotstar" prefix). See the <a href="G-Codes.html#led">command reference</a> for more information.</p>
<div class="highlight"><pre><span></span><code>[dotstar my_dotstar]
data_pin:
# The pin connected to the data line of the dotstar. This parameter
# must be provided.
clock_pin:
# The pin connected to the clock line of the dotstar. This parameter
# must be provided.
#chain_count:
# See the &quot;neopixel&quot; section for information on this parameter.
#initial_RED: 0.0
#initial_GREEN: 0.0
#initial_BLUE: 0.0
# See the &quot;led&quot; section for information on these parameters.
</code></pre></div>
<h3 id="pca9533">[pca9533]<a class="headerlink" href="#pca9533" title="Permanent link">&para;</a></h3>
<p>PCA9533 LED支援。PCA9533 在 mightyboard上出現。</p>
<div class="highlight"><pre><span></span><code>[pca9533 my_pca9533]
#i2c_address: 98
# The i2c address that the chip is using on the i2c bus. Use 98 for
# the PCA9533/1, 99 for the PCA9533/2. The default is 98.
#i2c_mcu:
#i2c_bus:
#i2c_speed:
# See the &quot;common I2C settings&quot; section for a description of the
# above parameters.
#initial_RED: 0.0
#initial_GREEN: 0.0
#initial_BLUE: 0.0
#initial_WHITE: 0.0
# See the &quot;led&quot; section for information on these parameters.
</code></pre></div>
<h3 id="pca9632">[pca9632]<a class="headerlink" href="#pca9632" title="Permanent link">&para;</a></h3>
<p>PCA9632 LED support. The PCA9632 is used on the FlashForge Dreamer.</p>
<div class="highlight"><pre><span></span><code>[pca9632 my_pca9632]
#i2c_address: 98
# The i2c address that the chip is using on the i2c bus. This may be
# 96, 97, 98, or 99. The default is 98.
#i2c_mcu:
#i2c_bus:
#i2c_speed:
# See the &quot;common I2C settings&quot; section for a description of the
# above parameters.
#scl_pin:
#sda_pin:
# Alternatively, if the pca9632 is not connected to a hardware I2C
# bus, then one may specify the &quot;clock&quot; (scl_pin) and &quot;data&quot;
# (sda_pin) pins. The default is to use hardware I2C.
#color_order: RGBW
# Set the pixel order of the LED (using a string containing the
# letters R, G, B, W). The default is RGBW.
#initial_RED: 0.0
#initial_GREEN: 0.0
#initial_BLUE: 0.0
#initial_WHITE: 0.0
# See the &quot;led&quot; section for information on these parameters.
</code></pre></div>
<h2 id="additional-servos-buttons-and-other-pins">Additional servos, buttons, and other pins<a class="headerlink" href="#additional-servos-buttons-and-other-pins" title="Permanent link">&para;</a></h2>
<h3 id="servo">[servo]<a class="headerlink" href="#servo" title="Permanent link">&para;</a></h3>
<p>伺服(可以定義任意數量的帶有“伺服”前綴的部分)。可以使用 SET_SERVO <a href="G-Codes.html#servo">g-code command</a> 控制舵機。例如SET_SERVO SERVO=my_servo ANGLE=180</p>
<div class="highlight"><pre><span></span><code>[servo my_servo]
@@ -5397,81 +5564,6 @@ pin:
# send any signal at startup.
</code></pre></div>
<h3 id="neopixel">[neopixel]<a class="headerlink" href="#neopixel" title="Permanent link">&para;</a></h3>
<p>Neopixel又名 WS2812LED 支持可以定義任意數量的帶有“neopixel”前綴的部分。可以通過“SET_LED LED=my_neopixel RED=0.1 GREEN=0.1 BLUE=0.1”類型擴展 <a href="G-Codes.html#neopixel">g-code commands</a> 設置 LED 顏色。</p>
<div class="highlight"><pre><span></span><code>[neopixel my_neopixel]
pin:
# The pin connected to the neopixel. This parameter must be
# provided.
#chain_count:
# The number of Neopixel chips that are &quot;daisy chained&quot; to the
# provided pin. The default is 1 (which indicates only a single
# Neopixel is connected to the pin).
#color_order: GRB
# Set the pixel order required by the LED hardware. Options are GRB,
# RGB, BRG, BGR, GRBW, or RGBW. The default is GRB.
#initial_RED: 0.0
#initial_GREEN: 0.0
#initial_BLUE: 0.0
#initial_WHITE: 0.0
# Sets the initial LED color of the Neopixel. Each value should be
# between 0.0 and 1.0. The WHITE option is only available on RGBW
# LEDs. The default for each color is 0.
</code></pre></div>
<h3 id="dotstar">[dotstar]<a class="headerlink" href="#dotstar" title="Permanent link">&para;</a></h3>
<p>Dotstar又名 APA102LED 支持可以使用“dotstar”前綴定義任意數量的部分。可以通過“SET_LED LED=my_dotstar RED=0.1 GREEN=0.1 BLUE=0.1”類型擴展 <a href="G-Codes.html#neopixel">g-code commands</a> 設置 LED 顏色。</p>
<div class="highlight"><pre><span></span><code>[dotstar my_dotstar]
data_pin:
# 連線到dotstar data數據線的引腳。必須提供這個參數。
clock_pin:
# 連線到dotstar clock時鐘線的引腳。必須提供這個參數。
#chain_count:
#initial_RED:0.0
#initial_GREEN: 0.0
#initial_BLUE: 0.0
# 有關這些參數的資訊,請參見 &quot;Neopixel &quot; 章節。
</code></pre></div>
<h3 id="pca9533">[PCA9533]<a class="headerlink" href="#pca9533" title="Permanent link">&para;</a></h3>
<p>PCA9533 LED支援。PCA9533 在 mightyboard上出現。</p>
<div class="highlight"><pre><span></span><code>[pca9533 my_pca9533]
#i2c_address: 98
# The i2c address that the chip is using on the i2c bus. Use 98 for
# the PCA9533/1, 99 for the PCA9533/2. The default is 98.
#i2c_mcu:
#i2c_bus:
#i2c_speed:
# See the &quot;common I2C settings&quot; section for a description of the
# above parameters.
#initial_RED: 0
#initial_GREEN: 0
#initial_BLUE: 0
#initial_WHITE: 0
# The PCA9533 only supports 1 or 0. The default is 0. On the
# mightyboard, the white led is not populated.
# Use GCODE to modify led values after startup.
# set_led led=my_pca9533 red=1 green=1 blue=1
</code></pre></div>
<h3 id="pca9632">[PCA9632]<a class="headerlink" href="#pca9632" title="Permanent link">&para;</a></h3>
<p>PCA9632 LED support. The PCA9632 is used on the FlashForge Dreamer.</p>
<div class="highlight"><pre><span></span><code>[pca9632 my_pca9632]
scl_pin:
# The SCL &quot;clock&quot; pin. This parameter must be provided.
sda_pin:
# The SDA &quot;data&quot; pin. This parameter must be provided.
#initial_RED: 0
#initial_GREEN: 0
#initial_BLUE: 0
#initial_WHITE: 0
# PCA9632 supports individual LED PWM.
# Values range from 0.0 to 1.0. The default is 0.0.
# On the FlashForge Dreamer, the white led is not populated.
# Use GCODE to modify led values after startup.
# set_led led=my_pca9632 red=1.0 green=1.0 blue=1.0 white=0.0
</code></pre></div>
<h3 id="gcode_button">[gcode_button]<a class="headerlink" href="#gcode_button" title="Permanent link">&para;</a></h3>
<p>在一個按鈕被按下或放開或當一個引腳狀態發生變化時時執行G程式碼。你可以使用 <code>QUERY_BUTTON button=my_gcode_button</code> 來查詢按鈕的狀態。</p>
<div class="highlight"><pre><span></span><code>[gcode_button my_gcode_button]
@@ -6221,19 +6313,23 @@ text:
</code></pre></div>
<h3 id="display_template">[display_template]<a class="headerlink" href="#display_template" title="Permanent link">&para;</a></h3>
<p>顯示數據文字「宏」(可以使用 display_template 字首定義任意數量的部分)。此功能可以幫助減少 display_data 部分中重複的定義。可以使用 display_data 部分中的內建 render() 函式來預覽模板。例如,如果要定義 <code>[display_template my_template]</code> 則可以在 display_data 部分使用 <code>{ render('my_template') }</code></p>
<div class="highlight"><pre><span></span><code>[display_template 模版名稱]
#param_&lt;名稱&gt;:
# 可以使用&quot;param_&quot;字首定義任意數量的選項。定義的名稱將被
# 關聯到給定的值被解析為Python literal並在macro解釋時可
# 以被使用。如果參數被render()的呼叫傳入,則這個值會被用於
# 宏擴充套件。例如,配置 &quot;param_speed = 75&quot; 允許呼叫
# &quot;render(&#39;my_template_name&#39;, param_speed=80)&quot;
# 參數名不能包含大寫字元。
#text:
# 當 render() 函式因為這個模板被呼叫時會顯示的文字。這個
# 欄位使用命令模板請見docs/Command_Templates.md
# 必須提供此參數。
<p>Display data text "macros" (one may define any number of sections with a display_template prefix). See the <a href="Command_Templates.html">command templates</a> document for information on template evaluation.</p>
<p>This feature allows one to reduce repetitive definitions in display_data sections. One may use the builtin <code>render()</code> function in display_data sections to evaluate a template. For example, if one were to define <code>[display_template my_template]</code> then one could use <code>{ render('my_template') }</code> in a display_data section.</p>
<p>This feature can also be used for continuous LED updates using the <a href="G-Codes.html#set_led_template">SET_LED_TEMPLATE</a> command.</p>
<div class="highlight"><pre><span></span><code>[display_template my_template_name]
#param_&lt;name&gt;:
# One may specify any number of options with a &quot;param_&quot; prefix. The
# given name will be assigned the given value (parsed as a Python
# literal) and will be available during macro expansion. If the
# parameter is passed in the call to render() then that value will
# be used during macro expansion. For example, a config with
# &quot;param_speed = 75&quot; might have a caller with
# &quot;render(&#39;my_template_name&#39;, param_speed=80)&quot;. Parameter names may
# not use upper case characters.
text:
# The text to return when the this template is rendered. This field
# is evaluated using command templates (see
# docs/Command_Templates.md). This parameter must be provided.
</code></pre></div>
<h3 id="display_glyph">[display_glyph]<a class="headerlink" href="#display_glyph" title="Permanent link">&para;</a></h3>
@@ -6585,6 +6681,33 @@ serial:
# # 當 ping 值變化高於此閾值時自動取消列印
</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>
<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
# specified.
#sample_period: 0.000400
# The query period (in seconds) to use during measurements. The
# default is 0.000400 (which is 2500 samples per second).
#stepper:
# The name of the stepper that the angle sensor is attached to (eg,
# &quot;stepper_x&quot;). Setting this value enables an angle calibration
# tool. To use this feature, the Python &quot;numpy&quot; package must be
# installed. The default is to not enable angle calibration for the
# angle sensor.
cs_pin:
# The SPI enable pin for the sensor. This parameter must be provided.
#spi_speed:
#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.
</code></pre></div>
<h2 id="_29">通用匯流排參數<a class="headerlink" href="#_29" title="Permanent link">&para;</a></h2>
<h3 id="spi">常見 SPI 設定<a class="headerlink" href="#spi" title="Permanent link">&para;</a></h3>
<p>以下參數通常適用於使用 SPI 總線的設備。</p>

View File

@@ -775,6 +775,40 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#angle" class="md-nav__link">
[angle]
</a>
<nav class="md-nav" aria-label="[angle]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#angle_calibrate" class="md-nav__link">
ANGLE_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#angle_debug_read" class="md-nav__link">
ANGLE_DEBUG_READ
</a>
</li>
<li class="md-nav__item">
<a href="#angle_debug_write" class="md-nav__link">
ANGLE_DEBUG_WRITE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1496,11 +1530,11 @@
</li>
<li class="md-nav__item">
<a href="#neopixel" class="md-nav__link">
[neopixel]
<a href="#led" class="md-nav__link">
[led]
</a>
<nav class="md-nav" aria-label="[neopixel]">
<nav class="md-nav" aria-label="[led]">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -1508,6 +1542,13 @@
SET_LED
</a>
</li>
<li class="md-nav__item">
<a href="#set_led_template" class="md-nav__link">
SET_LED_TEMPLATE
</a>
</li>
</ul>
@@ -2640,6 +2681,40 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#angle" class="md-nav__link">
[angle]
</a>
<nav class="md-nav" aria-label="[angle]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#angle_calibrate" class="md-nav__link">
ANGLE_CALIBRATE
</a>
</li>
<li class="md-nav__item">
<a href="#angle_debug_read" class="md-nav__link">
ANGLE_DEBUG_READ
</a>
</li>
<li class="md-nav__item">
<a href="#angle_debug_write" class="md-nav__link">
ANGLE_DEBUG_WRITE
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -3361,11 +3436,11 @@
</li>
<li class="md-nav__item">
<a href="#neopixel" class="md-nav__link">
[neopixel]
<a href="#led" class="md-nav__link">
[led]
</a>
<nav class="md-nav" aria-label="[neopixel]">
<nav class="md-nav" aria-label="[led]">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -3373,6 +3448,13 @@
SET_LED
</a>
</li>
<li class="md-nav__item">
<a href="#set_led_template" class="md-nav__link">
SET_LED_TEMPLATE
</a>
</li>
</ul>
@@ -4028,6 +4110,14 @@
<p><code>ACCELEROMETER_DEBUG_READ [CHIP=&lt;配置名&gt;] REG=&lt;暫存器&gt;</code>查詢ADXL345的暫存器"REG"例如44或0x2C。可以用於debug。</p>
<h4 id="accelerometer_debug_write">ACCELEROMETER_DEBUG_WRITE<a class="headerlink" href="#accelerometer_debug_write" title="Permanent link">&para;</a></h4>
<p><code>ACCELEROMETER_DEBUG_WRITE [CHIP=&lt;配置名&gt;] REG=&lt;暫存器&gt; VAL=&lt;&gt;</code>:將原始的"值"寫進暫存器"暫存器"。"值"和"暫存器"都可以是一個十進制或十六進制的整數。請謹慎使用,並參考 ADXL345 數據手冊。</p>
<h3 id="angle">[angle]<a class="headerlink" href="#angle" title="Permanent link">&para;</a></h3>
<p>The following commands are available when an <a href="Config_Reference.html#angle">angle config section</a> is enabled.</p>
<h4 id="angle_calibrate">ANGLE_CALIBRATE<a class="headerlink" href="#angle_calibrate" title="Permanent link">&para;</a></h4>
<p><code>ANGLE_CALIBRATE CHIP=&lt;chip_name&gt;</code>: Perform angle calibration on the given sensor (there must be an <code>[angle chip_name]</code> config section that has specified a <code>stepper</code> parameter). IMPORTANT - this tool will command the stepper motor to move without checking the normal kinematic boundary limits. Ideally the motor should be disconnected from any printer carriage before performing calibration. If the stepper can not be disconnected from the printer, make sure the carriage is near the center of its rail before starting calibration. (The stepper motor may move forwards or backwards two full rotations during this test.) After completing this test use the <code>SAVE_CONFIG</code> command to save the calibration data to the config file. In order to use this tool the Python "numpy" package must be installed (see the <a href="Measuring_Resonances.html#software-installation">measuring resonance document</a> for more information).</p>
<h4 id="angle_debug_read">ANGLE_DEBUG_READ<a class="headerlink" href="#angle_debug_read" title="Permanent link">&para;</a></h4>
<p><code>ANGLE_DEBUG_READ CHIP=&lt;config_name&gt; REG=&lt;register&gt;</code>: Queries sensor register "register" (e.g. 44 or 0x2C). Can be useful for debugging purposes. This is only available for tle5012b chips.</p>
<h4 id="angle_debug_write">ANGLE_DEBUG_WRITE<a class="headerlink" href="#angle_debug_write" title="Permanent link">&para;</a></h4>
<p><code>ANGLE_DEBUG_WRITE CHIP=&lt;config_name&gt; REG=&lt;register&gt; VAL=&lt;value&gt;</code>: Writes raw "value" into register "register". Both "value" and "register" can be a decimal or a hexadecimal integer. Use with care, and refer to sensor data sheet for the reference. This is only available for tle5012b chips.</p>
<h3 id="bed_mesh">[bed_mesh]<a class="headerlink" href="#bed_mesh" title="Permanent link">&para;</a></h3>
<p>當啟用 <a href="Config_Reference.html#bed_mesh">bed_mesh config section</a> 時,以下命令可用(另請參閱 <a href="Bed_Mesh.html">bed mesh guide</a>)。</p>
<h4 id="bed_mesh_calibrate">BED_MESH_CALIBRATE<a class="headerlink" href="#bed_mesh_calibrate" title="Permanent link">&para;</a></h4>
@@ -4209,10 +4299,12 @@
<p><a href="Config_Reference.html#manual_stepper">manual_stepper 配置分段</a>被啟用時,以下命令可用。</p>
<h4 id="manual_stepper_1">MANUAL_STEPPER<a class="headerlink" href="#manual_stepper_1" title="Permanent link">&para;</a></h4>
<p><code>MANUAL_STEPPER STEPPER=config_name [ENABLE=[0|1]] [SET_POSITION=&lt;pos&gt;] [SPEED=&lt;speed&gt;] [ACCEL=&lt;accel&gt;] [MOVE=&lt;pos&gt; [STOP_ON_ENDSTOP=[1|2|-1|-2]] [SYNC=0]]</code>該命令將改變步進器的狀態。使用ENABLE參數來啟用/禁用步進。使用SET_POSITION參數迫使步進認為它處於給定的位置。使用MOVE參數要求移動到給定位置。如果指定了SPEED或者ACCEL那麼將使用給定的值而不是配置檔案中指定的預設值。如果指定ACCEL為0那麼將不執行加速。如果STOP_ON_ENDSTOP=1被指定那麼如果止動器報告被觸發動作將提前結束使用STOP_ON_ENDSTOP=2來完成動作即使止動器沒有被觸發也不會出錯使用-1或-2來在止動器報告沒有被觸發時停止。通常情況下未來的G-Code命令將被安排在步進運動完成後執行但是如果手動步進運動使用SYNC=0那麼未來的G-Code運動命令可能與步進運動平行執行。</p>
<h3 id="neopixel">[neopixel]<a class="headerlink" href="#neopixel" title="Permanent link">&para;</a></h3>
<p>當啟用 <a href="Config_Reference.html#neopixel">neopixel config section</a> <a href="Config_Reference.html#dotstar">dotstar config section</a> 時,以下命令可用。</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;配置中的名稱&gt; RED=&lt;&gt; GREEN=&lt;&gt; BLUE=&lt;&gt; WHITE=&lt;&gt; [INDEX=&lt;索引&gt;] [TRANSMIT=0] [SYNC=1]</code>這條指令設定LED的輸出。每個顏色的 <code>&lt;&gt;</code> 必須在0.0和1.0之間。WHITE白色參數僅在 RGBW LED上有效果。如果多個 LED 晶片是通過菊鏈連線的可以用INDEX參數來指定改變指定晶片的顏色1是第一顆晶片2是第二顆晶片…。如果不提供 INDEX 則全部菊鏈中的 LED 將被設定為給定的顏色。如果指定了 TRANSMIT=0 ,色彩變化只會在下一條不是 TRANSMIT=0 的 SET_LED命令發送后發生。這個特性和 INDEX 參數一起使用可以在菊鏈中批量改變LED的顏色。預設情況下SET_LED命令將與其他正在進行的G程式碼命令同步其變化。 因為修改LED狀態會重置空閑超時這可能在不列印時造成不期望的行為。 如果精確的時序不重要,可選的 SYNC=0 參數可以立刻應用LED變化而不重置LED超時。</p>
<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>當啟用 <a href="Config_Reference.html#output_pin">output_pin config section</a> 時,以下命令可用。</p>
<h4 id="set_pin">SET_PIN<a class="headerlink" href="#set_pin" title="Permanent link">&para;</a></h4>

View File

@@ -1384,6 +1384,7 @@ Recv: ok
<li>右後螺絲必須逆時針轉動至 50 分鐘方向</li>
<li>左後螺絲必須順時針轉動至 2 分鐘方向(不需要就可以了)</li>
</ul>
<p>Note that "minutes" refers to "minutes of a clock face". So, for example, 15 minutes is a quarter of a full turn.</p>
<p>重複這個過程幾次,直到你得到一個好的水平床——通常當所有的調整都低於 6 分鐘。</p>
<p>如果使用安裝在熱端側面的探頭(即,它具有 X 或 Y 偏移),請注意調整床傾斜度將使之前使用傾斜床執行的任何探頭校準無效。確保在調整底座螺絲後運行 <a href="Probe_Calibrate.html">探頭校準</a></p>
<p>當使用保存的床面網格時“MAX_DEVIATION”參數很有用以確保床面高度不會偏離網格創建時的位置太遠。例如可以在加載網格之前將“SCREWS_TILT_CALCULATE MAX_DEVIATION=0.01”添加到切片器的自定義啟動 gcode。如果超過配置的限制本例中為 0.01mm),它將中止打印,讓用戶有機會調整螺絲並重新開始打印。</p>

View File

@@ -777,6 +777,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#angle" class="md-nav__link">
angle
</a>
</li>
<li class="md-nav__item">
<a href="#bed_mesh" class="md-nav__link">
bed_mesh
@@ -873,6 +880,13 @@
idle_timeout
</a>
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
led
</a>
</li>
<li class="md-nav__item">
@@ -1013,13 +1027,6 @@
z_tilt
</a>
</li>
<li class="md-nav__item">
<a href="#neopixel-dotstar" class="md-nav__link">
neopixel / dotstar
</a>
</li>
</ul>
@@ -1460,6 +1467,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#angle" class="md-nav__link">
angle
</a>
</li>
<li class="md-nav__item">
<a href="#bed_mesh" class="md-nav__link">
bed_mesh
@@ -1556,6 +1570,13 @@
idle_timeout
</a>
</li>
<li class="md-nav__item">
<a href="#led" class="md-nav__link">
led
</a>
</li>
<li class="md-nav__item">
@@ -1696,13 +1717,6 @@
z_tilt
</a>
</li>
<li class="md-nav__item">
<a href="#neopixel-dotstar" class="md-nav__link">
neopixel / dotstar
</a>
</li>
</ul>
@@ -1725,6 +1739,11 @@
<h1 id="_1">狀態參考<a class="headerlink" href="#_1" title="Permanent link">&para;</a></h1>
<p>本文件是可用於 Klipper <a href="Command_Templates.html"></a><a href="Config_Reference.html#display">顯示欄位</a>以及<a href="API_Server.html">API伺服器</a> 的印表機狀態資訊的參考。</p>
<p>本文件中的欄位可能會發生變化 - 如果使用了任何欄位,在更新 Klipper 時,請務必檢視<a href="Config_Changes.html">配置變化文件</a></p>
<h2 id="angle">angle<a class="headerlink" href="#angle" title="Permanent link">&para;</a></h2>
<p>The following information is available in <a href="Config_Reference.html#angle">angle some_name</a> objects:</p>
<ul>
<li><code>temperature</code>: The last temperature reading (in Celsius) from a tle5012b magnetic hall sensor. This value is only available if the angle sensor is a tle5012b chip and if measurements are in progress (otherwise it reports <code>None</code>).</li>
</ul>
<h2 id="bed_mesh">bed_mesh<a class="headerlink" href="#bed_mesh" title="Permanent link">&para;</a></h2>
<p><a href="Config_Reference.html#bed_mesh">bed_mesh</a> 對像中提供了以下資訊:</p>
<ul>
@@ -1819,6 +1838,11 @@
<li><code>state</code>:由 idle_timeout 模組跟蹤的印表機的當前狀態。它可以是以下字串之一:"Idle", "Printing", "Ready"。</li>
<li><code>printing_time</code>印表機處於「Printing」狀態的時間以秒為單位由 idle_timeout 模組跟蹤)。</li>
</ul>
<h2 id="led">led<a class="headerlink" href="#led" title="Permanent link">&para;</a></h2>
<p>The following information is available for each <code>[led led_name]</code>, <code>[neopixel led_name]</code>, <code>[dotstar led_name]</code>, <code>[pca9533 led_name]</code>, and <code>[pca9632 led_name]</code> config section defined in printer.cfg:</p>
<ul>
<li><code>color_data</code>: A list of color lists containing the RGBW values for a led in the chain. Each value is represented as a float from 0.0 to 1.0. Each color list contains 4 items (red, green, blue, white) even if the underyling LED supports fewer color channels. For example, the blue value (3rd item in color list) of the second neopixel in a chain could be accessed at <code>printer["neopixel &lt;config_name&gt;"].color_data[1][2]</code>.</li>
</ul>
<h2 id="mcu">mcu<a class="headerlink" href="#mcu" title="Permanent link">&para;</a></h2>
<p><a href="Config_Reference.html#mcu">mcu</a><a href="Config_Reference.html#mcu-my_extra_mcu">mcu some_name</a>對像提供了以下資訊:</p>
<ul>
@@ -1945,11 +1969,6 @@
<p><code>z_tilt</code> 對像提供了以下資訊(如果定義了 z_tilt則該對象可用</p>
<ul>
<li><code>applied</code>:如果 z 傾斜調平過程已執行併成功完成,則為 True。</li>
</ul>
<h2 id="neopixel-dotstar">neopixel / dotstar<a class="headerlink" href="#neopixel-dotstar" title="Permanent link">&para;</a></h2>
<p>以下資訊適用於每個在 printer.cfg 中定義的 <code>[neopixel led_name]</code><code>[dotstar led_name]</code></p>
<ul>
<li><code>color_data</code>:對像陣列,每個對像包含鏈中一個 LED 的 RGBW 值。請注意,並非所有配置都包含白色值。每個值都是從 0 到 1 的浮點數。例如,鏈中第二個 neopixel 的藍色值可以通過<code>printer["neopixel &lt;config_name&gt;"].color_data[1].B</code>訪問。</li>
</ul>

File diff suppressed because one or more lines are too long

Binary file not shown.