aboutsummaryrefslogtreecommitdiffstats
path: root/docs/MCU_Commands.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2017-05-07 17:33:45 -0400
committerKevin O'Connor <kevin@koconnor.net>2017-05-15 14:02:59 -0400
commit5c4cc0d64637363aaeb46e2b65bb1b1f99e9e434 (patch)
tree3e05557f40fd73c2d8bebed6afbf7719c701a952 /docs/MCU_Commands.md
parenta361b921849b4e23f7a41feb2a7c011ee6d794b1 (diff)
downloadkutter-5c4cc0d64637363aaeb46e2b65bb1b1f99e9e434.tar.gz
kutter-5c4cc0d64637363aaeb46e2b65bb1b1f99e9e434.tar.xz
kutter-5c4cc0d64637363aaeb46e2b65bb1b1f99e9e434.zip
pwmcmds: Export the maximum PWM value
Instead of assuming the maximum PWM value is 255, export a constant from the firmware to the host with the maximum value. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/MCU_Commands.md')
-rw-r--r--docs/MCU_Commands.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/MCU_Commands.md b/docs/MCU_Commands.md
index 5cd47193..6cfadd89 100644
--- a/docs/MCU_Commands.md
+++ b/docs/MCU_Commands.md
@@ -50,7 +50,7 @@ Common startup commands:
may be useful for configuring the initial value of LEDs and for
configuring the initial value of stepper driver micro-stepping pins.
-* `set_pwm_out pin=%u cycle_ticks=%u value=%c` : This command will
+* `set_pwm_out pin=%u cycle_ticks=%u value=%hu` : This command will
immediately configure the given pin to use hardware based
pulse-width-modulation (PWM) with the given number of
cycle_ticks. The "cycle_ticks" is the number of MCU clock ticks each
@@ -148,7 +148,7 @@ This section lists some commonly used config commands.
feature can be used with heater pins to ensure the host does not
enable the heater and then go off-line.
-* `config_pwm_out oid=%c pin=%u cycle_ticks=%u default_value=%c
+* `config_pwm_out oid=%c pin=%u cycle_ticks=%u default_value=%hu
max_duration=%u` : This command creates an internal object for
hardware based PWM pins that the host may schedule updates for. Its
usage is analogous to config_digital_out - see the description of
@@ -205,11 +205,11 @@ only of interest to developers looking to gain insight into Klipper.
same 'oid' parameter must have been issued during micro-controller
configuration.
-* `schedule_pwm_out oid=%c clock=%u value=%c` : Schedules a change to
+* `schedule_pwm_out oid=%c clock=%u value=%hu` : Schedules a change to
a hardware PWM output pin. See the 'schedule_digital_out' and
'config_pwm_out' commands for more info.
-* `schedule_soft_pwm_out oid=%c clock=%u value=%c` : Schedules a
+* `schedule_soft_pwm_out oid=%c clock=%u value=%hu` : Schedules a
change to a software PWM output pin. See the 'schedule_digital_out'
and 'config_soft_pwm_out' commands for more info.