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>
This commit is contained in:
Kevin O'Connor 2021-06-04 16:45:22 -04:00
parent 0bc0767997
commit 6db40df6af
2 changed files with 4 additions and 5 deletions

View File

@ -6,6 +6,10 @@ All dates in this document are approximate.
# Changes # 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 20210503: The gcode_macro `default_parameter_<name>` config option is
deprecated. Use the `params` pseudo-variable to access macro deprecated. Use the `params` pseudo-variable to access macro
parameters. Other methods for accessing macro parameters will be parameters. Other methods for accessing macro parameters will be

View File

@ -714,9 +714,6 @@ pid_Ki:
pid_Kd: pid_Kd:
# Kd is the "derivative" constant for the pid. This parameter must # Kd is the "derivative" constant for the pid. This parameter must
# be provided for PID heaters. # 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 #max_delta: 2.0
# On 'watermark' controlled heaters this is the number of degrees in # On 'watermark' controlled heaters this is the number of degrees in
# Celsius above the target temperature before disabling the heater # Celsius above the target temperature before disabling the heater
@ -1989,7 +1986,6 @@ temperature.
#pid_Kp: #pid_Kp:
#pid_Ki: #pid_Ki:
#pid_Kd: #pid_Kd:
#pid_integral_max:
#pwm_cycle_time: #pwm_cycle_time:
#min_temp: #min_temp:
#max_temp: #max_temp:
@ -2429,7 +2425,6 @@ additional information.
#pid_Ki: #pid_Ki:
#pid_Kd: #pid_Kd:
#pid_deriv_time: #pid_deriv_time:
#pid_integral_max:
#max_delta: #max_delta:
#min_temp: #min_temp:
#max_temp: #max_temp: