aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Firmware_Commands.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2016-12-01 10:21:36 -0500
committerKevin O'Connor <kevin@koconnor.net>2016-12-01 10:21:36 -0500
commitbabc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a (patch)
treeb06367c363ad63bac52e8d3b79a0b47914a74604 /docs/Firmware_Commands.md
parentd2ecc9d80c749454b3d14d547d8ec71c0c124fd1 (diff)
downloadkutter-babc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a.tar.gz
kutter-babc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a.tar.xz
kutter-babc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a.zip
docs: Minor updates to wording of some documents
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Firmware_Commands.md')
-rw-r--r--docs/Firmware_Commands.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/Firmware_Commands.md b/docs/Firmware_Commands.md
index a2f3f559..a0f9a65c 100644
--- a/docs/Firmware_Commands.md
+++ b/docs/Firmware_Commands.md
@@ -46,12 +46,12 @@ Common startup commands:
* set_pwm_out pin=%u cycle_ticks=%u value=%c : 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 amount of time (in MCU clock
- ticks) in a complete power on and power off cycle. A cycle_ticks
- value of 1 can be used to request the fastest possible cycle
- time. The specified "value" is between 0 and 255 with 0 indicating a
- full off state and 255 indicating a full on state. This command may
- be useful for enabling CPU and nozzle cooling fans.
+ cycle_ticks. The "cycle_ticks" is the number of MCU clock ticks each
+ power on and power off cycle should last. A cycle_ticks value of 1
+ can be used to request the fastest possible cycle time. The "value"
+ parameter is between 0 and 255 with 0 indicating a full off state
+ and 255 indicating a full on state. This command may be useful for
+ enabling CPU and nozzle cooling fans.
* send_spi_message pin=%u msg=%*s : This command can be used to
transmit messages to a serial-peripheral-interface (SPI) component