aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2023-10-13 21:10:11 -0400
committerKevin O'Connor <kevin@koconnor.net>2023-11-16 22:07:15 -0500
commit29b7550ce5330da8e5ca4f22c1420cbeadf01eaf (patch)
tree107c086343081c9589af7be53873fea1a7a40d29 /docs/Config_Reference.md
parent48a05eaa542bfd4a1099c2224bda443049a6fa64 (diff)
downloadkutter-29b7550ce5330da8e5ca4f22c1420cbeadf01eaf.tar.gz
kutter-29b7550ce5330da8e5ca4f22c1420cbeadf01eaf.tar.xz
kutter-29b7550ce5330da8e5ca4f22c1420cbeadf01eaf.zip
pwm_tool: Add support for high-speed PWM pin updates
The output_pin module is only capable of updating an output pin at most once every 100ms. Add a new pwm_tool module that is capable of queuing updates in the micro-controller and thus allowing for much higher update rates. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 24139183..c7a2a3db 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -3127,6 +3127,26 @@ pin:
# parameter.
```
+### [pwm_tool]
+
+Pulse width modulation digital output pins capable of high speed
+updates (one may define any number of sections with an "output_pin"
+prefix). Pins configured here will be setup as output pins and one may
+modify them at run-time using "SET_PIN PIN=my_pin VALUE=.1" type
+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.
+#value:
+#shutdown_value:
+#cycle_time: 0.100
+#hardware_pwm: False
+#scale:
+# See the "output_pin" section for the definition of these parameters.
+```
+
### [static_digital_output]
Statically configured digital output pins (one may define any number