diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2023-01-13 11:19:07 -0500 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2023-01-13 11:25:06 -0500 |
| commit | 4671cf2d0e3ec864e72766cb1f6e24f1a308f794 (patch) | |
| tree | 9c2f2726dfd5ca4245ef3b3cfddd3d0234699cf9 | |
| parent | bca2671efb8ae6035bb8600619b7a7c4e76169c3 (diff) | |
| download | kutter-4671cf2d0e3ec864e72766cb1f6e24f1a308f794.tar.gz kutter-4671cf2d0e3ec864e72766cb1f6e24f1a308f794.tar.xz kutter-4671cf2d0e3ec864e72766cb1f6e24f1a308f794.zip | |
docs: Improve SET_PIN documentation in G-Codes.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
| -rw-r--r-- | docs/G-Codes.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md index 137d14ba..04efdbf2 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -811,9 +811,17 @@ The following command is available when an enabled. #### SET_PIN -`SET_PIN PIN=config_name VALUE=<value> CYCLE_TIME=<cycle_time>`: -Note - hardware PWM does not currently support the CYCLE_TIME -parameter and will use the cycle time defined in the config. +`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). ### [palette2] |