aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2022-04-11 11:43:47 -0400
committerKevin O'Connor <kevin@koconnor.net>2022-04-11 11:46:24 -0400
commit4a8a76ead8480c6302ee812b6aed7d57824eb43c (patch)
tree8ded2c2db53bcad6cb03175ceb2f7225bf2b4e70 /docs/Config_Reference.md
parent38e82e8d8f4d27edbefaa822d8ecce229c4ce8c5 (diff)
downloadkutter-4a8a76ead8480c6302ee812b6aed7d57824eb43c.tar.gz
kutter-4a8a76ead8480c6302ee812b6aed7d57824eb43c.tar.xz
kutter-4a8a76ead8480c6302ee812b6aed7d57824eb43c.zip
docs: Update temperature_fan PID documentation in Config_Reference.md
Reported by @dewi-ny-je. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 416b1196..f0332bc6 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -2517,14 +2517,25 @@ information.
#sensor_type:
#sensor_pin:
#control:
-#pid_Kp:
-#pid_Ki:
-#pid_Kd:
-#pid_deriv_time:
#max_delta:
#min_temp:
#max_temp:
# See the "extruder" section for a description of the above parameters.
+#pid_Kp:
+#pid_Ki:
+#pid_Kd:
+# 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:
+# fan_pwm = max_power - (Kp*e + Ki*integral(e) - Kd*derivative(e)) / 255
+# Where "e" is "target_temperature - measured_temperature" and
+# "fan_pwm" is the requested fan rate with 0.0 being full off and
+# 1.0 being full on. The pid_Kp, pid_Ki, and pid_Kd parameters must
+# be provided when the PID control algorithm is enabled.
+#pid_deriv_time: 2.0
+# A time value (in seconds) over which temperature measurements will
+# be smoothed when using the PID control algorithm. This may reduce
+# the impact of measurement noise. The default is 2 seconds.
#target_temp: 40.0
# A temperature (in Celsius) that will be the target temperature.
# The default is 40 degrees.