aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-06-04 16:45:22 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-06-12 13:29:11 -0400
commit6db40df6af51eefe87e601484a63881b17084f0a (patch)
tree4263e21b8399a69d698f967d8db282160854ce60
parent0bc076799776fd61a63a1e8ee53e7f3bdf5039d6 (diff)
downloadkutter-6db40df6af51eefe87e601484a63881b17084f0a.tar.gz
kutter-6db40df6af51eefe87e601484a63881b17084f0a.tar.xz
kutter-6db40df6af51eefe87e601484a63881b17084f0a.zip
docs: Deprecate pid_integral_max config option
The default pid_integral_max setting should be sufficient; it's not necessary to complicate the documentation and config to support customization. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
-rw-r--r--docs/Config_Changes.md4
-rw-r--r--docs/Config_Reference.md5
2 files changed, 4 insertions, 5 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md
index 15d94883..65a4890a 100644
--- a/docs/Config_Changes.md
+++ b/docs/Config_Changes.md
@@ -6,6 +6,10 @@ All dates in this document are approximate.
# Changes
+20210612: The `pid_integral_max` config option in heater and
+temperature_fan sections is deprecated. The option will be removed in
+the near future.
+
20210503: The gcode_macro `default_parameter_<name>` config option is
deprecated. Use the `params` pseudo-variable to access macro
parameters. Other methods for accessing macro parameters will be
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index e3b2b33f..5297edd2 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -714,9 +714,6 @@ pid_Ki:
pid_Kd:
# Kd is the "derivative" constant for the pid. This parameter must
# be provided for PID heaters.
-#pid_integral_max:
-# The maximum "windup" the integral term may accumulate. The default
-# is to use the same value as max_power.
#max_delta: 2.0
# On 'watermark' controlled heaters this is the number of degrees in
# Celsius above the target temperature before disabling the heater
@@ -1989,7 +1986,6 @@ temperature.
#pid_Kp:
#pid_Ki:
#pid_Kd:
-#pid_integral_max:
#pwm_cycle_time:
#min_temp:
#max_temp:
@@ -2429,7 +2425,6 @@ additional information.
#pid_Ki:
#pid_Kd:
#pid_deriv_time:
-#pid_integral_max:
#max_delta:
#min_temp:
#max_temp: