diff options
author | Kevin O'Connor <kevin@koconnor.net> | 2023-01-13 11:20:19 -0500 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2024-01-23 20:04:03 -0500 |
commit | fd2feff67df65c559cafc8fc5f2fd8601355e81a (patch) | |
tree | 35001c58cddd233bf1689ef284e76a8e3d9d2a60 /docs/G-Codes.md | |
parent | 1baa45913ffd05a808d5d9ea0ae0161ebbaff247 (diff) | |
download | kutter-fd2feff67df65c559cafc8fc5f2fd8601355e81a.tar.gz kutter-fd2feff67df65c559cafc8fc5f2fd8601355e81a.tar.xz kutter-fd2feff67df65c559cafc8fc5f2fd8601355e81a.zip |
pwm_cycle_time: New module for output pins with dynamic cycle times
Remove support for changing the cycle time of pwm pins from the
output_pin module. Use a new pwm_cycle_time module that supports
setting dynamic cycle times. This simplifies the output_pin code and
low-level pin update code.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r-- | docs/G-Codes.md | 30 |
1 files changed, 19 insertions, 11 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md index 8c70609f..92cb7660 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -839,17 +839,10 @@ The following command is available when an enabled. #### SET_PIN -`SET_PIN PIN=config_name VALUE=<value> [CYCLE_TIME=<cycle_time>]`: Set -the pin to the given output `VALUE`. VALUE should be 0 or 1 for -"digital" output pins. For PWM pins, set to a value between 0.0 and -1.0, or between 0.0 and `scale` if a scale is configured in the -output_pin config section. - -Some pins (currently only "soft PWM" pins) support setting an explicit -cycle time using the CYCLE_TIME parameter (specified in seconds). Note -that the CYCLE_TIME parameter is not stored between SET_PIN commands -(any SET_PIN command without an explicit CYCLE_TIME parameter will use -the `cycle_time` specified in the output_pin config section). +`SET_PIN PIN=config_name VALUE=<value>`: Set the pin to the given +output `VALUE`. VALUE should be 0 or 1 for "digital" output pins. For +PWM pins, set to a value between 0.0 and 1.0, or between 0.0 and +`scale` if a scale is configured in the output_pin config section. ### [palette2] @@ -978,6 +971,21 @@ babystepping), and subtract if from the probe's z_offset. This acts to take a frequently used babystepping value, and "make it permanent". Requires a `SAVE_CONFIG` to take effect. +### [pwm_cycle_time] + +The following command is available when a +[pwm_cycle_time config section](Config_Reference.md#pwm_cycle_time) +is enabled. + +#### SET_PIN +`SET_PIN PIN=config_name VALUE=<value> [CYCLE_TIME=<cycle_time>]`: +This command works similarly to [output_pin](#output_pin) SET_PIN +commands. The command here supports setting an explicit cycle time +using the CYCLE_TIME parameter (specified in seconds). Note that the +CYCLE_TIME parameter is not stored between SET_PIN commands (any +SET_PIN command without an explicit CYCLE_TIME parameter will use the +`cycle_time` specified in the pwm_cycle_time config section). + ### [query_adc] The query_adc module is automatically loaded. |