aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPascal Pieper <accounts@pascalpieper.de>2020-11-25 11:36:00 -0500
committerKevin O'Connor <kevin@koconnor.net>2020-12-04 16:10:13 -0500
commit9cdf9bb6ec9f957cb1f94a0d3ed7f72b1618986f (patch)
tree03e1b08cda64ae763cc1aa2d390a6d93b1cc11bc /docs
parente8ec1801ffd41be4a79e0871d43b9e084074151b (diff)
downloadkutter-9cdf9bb6ec9f957cb1f94a0d3ed7f72b1618986f.tar.gz
kutter-9cdf9bb6ec9f957cb1f94a0d3ed7f72b1618986f.tar.xz
kutter-9cdf9bb6ec9f957cb1f94a0d3ed7f72b1618986f.zip
gpiocmds: Use move queue for digital output pins
Signed-off-by: Pascal Pieper <accounts@pascalpieper.de> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/MCU_Commands.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/MCU_Commands.md b/docs/MCU_Commands.md
index 536d1ce4..8b20c6a4 100644
--- a/docs/MCU_Commands.md
+++ b/docs/MCU_Commands.md
@@ -113,18 +113,18 @@ This section lists some commonly used config commands.
digital output mode and set to an initial value as specified by
'value' (0 for low, 1 for high). Creating a digital_out object
allows the host to schedule GPIO updates for the given pin at
- specified times (see the schedule_digital_out command described
- below). Should the micro-controller software go into shutdown mode
- then all configured digital_out objects will be set to
- 'default_value'. The 'max_duration' parameter is used to implement a
- safety check - if it is non-zero then it is the maximum number of
- clock ticks that the host may set the given GPIO to a non-default
- value without further updates. For example, if the default_value is
- zero and the max_duration is 16000 then if the host sets the gpio to
- a value of one then it must schedule another update to the gpio pin
- (to either zero or one) within 16000 clock ticks. This safety
- feature can be used with heater pins to ensure the host does not
- enable the heater and then go off-line.
+ specified times (see the queue_digital_out command described below).
+ Should the micro-controller software go into shutdown mode then all
+ configured digital_out objects will be set to 'default_value'. The
+ 'max_duration' parameter is used to implement a safety check - if it
+ is non-zero then it is the maximum number of clock ticks that the
+ host may set the given GPIO to a non-default value without further
+ updates. For example, if the default_value is zero and the
+ max_duration is 16000 then if the host sets the gpio to a value of
+ one then it must schedule another update to the gpio pin (to either
+ zero or one) within 16000 clock ticks. This safety 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 value=%hu
default_value=%hu max_duration=%u` : This command creates an
@@ -191,21 +191,21 @@ Common commands
This section lists some commonly used run-time commands. It is likely
only of interest to developers looking to gain insight into Klipper.
-* `schedule_digital_out oid=%c clock=%u value=%c` : This command will
+* `queue_digital_out oid=%c clock=%u value=%c` : This command will
schedule a change to a digital output GPIO pin at the given clock
time. To use this command a 'config_digital_out' command with the
same 'oid' parameter must have been issued during micro-controller
configuration.
* `queue_pwm_out oid=%c clock=%u value=%hu` : Schedules a change to a
- hardware PWM output pin. See the 'schedule_digital_out' and
+ hardware PWM output pin. See the 'queue_digital_out' and
'config_pwm_out' commands for more info.
* `schedule_soft_pwm_out oid=%c clock=%u on_ticks=%u` : Schedules a
change to a software PWM output pin. Because the output switching is
implemented in the micro-controller software, it is recommended that
the sum of on_ticks and off_ticks parameters corresponds to a time
- of 10ms or greater. See the 'schedule_digital_out' and
+ of 10ms or greater. See the 'queue_digital_out' and
'config_soft_pwm_out' commands for more info.
* `query_analog_in oid=%c clock=%u sample_ticks=%u sample_count=%c