aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2019-12-15 23:24:17 -0500
committerKevin O'Connor <kevin@koconnor.net>2019-12-15 23:24:17 -0500
commit254789f4c570426f589e3cf966dac12a0600b6a5 (patch)
treeea7739e1381f7160740ca4779a7cb8ed316f90e5 /docs/G-Codes.md
parentab5540bd341d8a6d290014809387d616f4049a53 (diff)
downloadkutter-254789f4c570426f589e3cf966dac12a0600b6a5.tar.gz
kutter-254789f4c570426f589e3cf966dac12a0600b6a5.tar.xz
kutter-254789f4c570426f589e3cf966dac12a0600b6a5.zip
neopixel: Add support for delaying updates in SET_LED command
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 4ab3ffc7..a82f1cc9 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -222,13 +222,16 @@ is enabled:
The following command is available when "neopixel" or "dotstar" config
sections are enabled:
-- `SET_LED LED=<config_name> INDEX=<index> RED=<value> GREEN=<value>
- BLUE=<value>`: This sets the LED output. Each color <value> must be
- between 0.0 and 1.0. If multiple LED chips are daisy-chained then
- one may specify INDEX to alter the color of just the given chip (1
- for the first chip, 2 for the second, etc.). If INDEX is not
- provided then all LEDs in the daisy-chain will be set to the
- provided color.
+- `SET_LED LED=<config_name> RED=<value> GREEN=<value> BLUE=<value>
+ [INDEX=<index>] [TRANSMIT=0]`: This sets the LED output. Each color
+ <value> must be between 0.0 and 1.0. If multiple LED chips are
+ daisy-chained then one may specify INDEX to alter the color of just
+ the given chip (1 for the first chip, 2 for the second, etc.). If
+ INDEX is not provided then all LEDs in the daisy-chain will be set
+ to the provided color. If TRANSMIT=0 is specified then the color
+ change will only be made on the next SET_LED command that does not
+ specify TRANSMIT=0; this may be useful in combination with the INDEX
+ parameter to batch multiple updates in a daisy-chain.
## Servo Commands