aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2023-01-13 10:02:47 -0500
committerKevin O'Connor <kevin@koconnor.net>2024-01-23 20:04:03 -0500
commit4115ea128af3308c1a5af224fce83b12c2e97e1a (patch)
treea7fe1eb30b27f971fe5ce47099c8dff8585129f7 /docs
parent2e8b54ae5f01e2c4897eec109cd8a0cb3c0e5c4a (diff)
downloadkutter-4115ea128af3308c1a5af224fce83b12c2e97e1a.tar.gz
kutter-4115ea128af3308c1a5af224fce83b12c2e97e1a.tar.xz
kutter-4115ea128af3308c1a5af224fce83b12c2e97e1a.zip
output_pin: Deprecate static_value parameter
Remove support for configuring "static" pins in output_pin module. A "static" pin only saves a few bytes of memory in the micro-controller. The savings does not justify the increased code complexity. Deprecate the static_value parameter to warn users. In the interim, a static_value parameter will set both value and shutdown_value parameters. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Changes.md4
-rw-r--r--docs/Config_Reference.md7
2 files changed, 6 insertions, 5 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md
index 2ceb868d..bd00e3d7 100644
--- a/docs/Config_Changes.md
+++ b/docs/Config_Changes.md
@@ -8,6 +8,10 @@ All dates in this document are approximate.
## Changes
+20240123: The output_pin `static_value` parameter is deprecated.
+Replace with `value` and `shutdown_value` parameters. The option will
+be removed in the near future.
+
20231216: The `[hall_filament_width_sensor]` is changed to trigger filament runout
when the thickness of the filament exceeds `max_diameter`. The maximum diameter
defaults to `default_nominal_filament_diameter + max_difference`. See
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 4b53ef26..a6964e5b 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -3096,11 +3096,6 @@ pin:
# If this is true, the value fields should be between 0 and 1; if it
# is false the value fields should be either 0 or 1. The default is
# False.
-#static_value:
-# If this is set, then the pin is assigned to this value at startup
-# and the pin can not be changed during runtime. A static pin uses
-# slightly less ram in the micro-controller. The default is to use
-# runtime configuration of pins.
#value:
# The value to initially set the pin to during MCU configuration.
# The default is 0 (for low voltage).
@@ -3133,6 +3128,8 @@ pin:
# then the 'value' parameter can be specified using the desired
# amperage for the stepper. The default is to not scale the 'value'
# parameter.
+#static_value:
+# This option is deprecated and should no longer be specified.
```
### [pwm_tool]