aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2024-01-12 22:52:32 -0500
committerKevin O'Connor <kevin@koconnor.net>2024-01-23 20:04:03 -0500
commit1baa45913ffd05a808d5d9ea0ae0161ebbaff247 (patch)
tree15f2b12ed018d79f3caab45c493b3e3695ee8dfe /docs/Config_Reference.md
parent7abafb575ba7b098b9f1025a1d65717568a89876 (diff)
downloadkutter-1baa45913ffd05a808d5d9ea0ae0161ebbaff247.tar.gz
kutter-1baa45913ffd05a808d5d9ea0ae0161ebbaff247.tar.xz
kutter-1baa45913ffd05a808d5d9ea0ae0161ebbaff247.zip
output_pin: Deprecate the maximum_mcu_duration parameter
Advise users to configure a pwm_tool config section if checking for maximum mcu duration is required. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index a6964e5b..226b7a13 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -3102,13 +3102,6 @@ pin:
#shutdown_value:
# The value to set the pin to on an MCU shutdown event. The default
# is 0 (for low voltage).
-#maximum_mcu_duration:
-# The maximum duration a non-shutdown value may be driven by the MCU
-# without an acknowledge from the host.
-# If host can not keep up with an update, the MCU will shutdown
-# and set all pins to their respective shutdown values.
-# Default: 0 (disabled)
-# Usual values are around 5 seconds.
#cycle_time: 0.100
# The amount of time (in seconds) per PWM cycle. It is recommended
# this be 10 milliseconds or greater when using software based PWM.
@@ -3128,8 +3121,9 @@ pin:
# then the 'value' parameter can be specified using the desired
# amperage for the stepper. The default is to not scale the 'value'
# parameter.
+#maximum_mcu_duration:
#static_value:
-# This option is deprecated and should no longer be specified.
+# These options are deprecated and should no longer be specified.
```
### [pwm_tool]
@@ -3144,9 +3138,15 @@ extended [g-code commands](G-Codes.md#output_pin).
[pwm_tool my_tool]
pin:
# The pin to configure as an output. This parameter must be provided.
+#maximum_mcu_duration:
+# The maximum duration a non-shutdown value may be driven by the MCU
+# without an acknowledge from the host.
+# If host can not keep up with an update, the MCU will shutdown
+# and set all pins to their respective shutdown values.
+# Default: 0 (disabled)
+# Usual values are around 5 seconds.
#value:
#shutdown_value:
-#maximum_mcu_duration:
#cycle_time: 0.100
#hardware_pwm: False
#scale: