aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEric Callahan <arksine.code@gmail.com>2021-06-10 06:41:45 -0400
committerKevinOConnor <kevin@koconnor.net>2021-06-18 10:53:12 -0400
commit8bcfaa53aad63445a573beb6899c7a85a54f261c (patch)
treeebf7cff9c5feb839f8e89b608a525141acda1566 /docs
parent7ced62ab9cd6431d15e5656b75461e0fbabecebe (diff)
downloadkutter-8bcfaa53aad63445a573beb6899c7a85a54f261c.tar.gz
kutter-8bcfaa53aad63445a573beb6899c7a85a54f261c.tar.xz
kutter-8bcfaa53aad63445a573beb6899c7a85a54f261c.zip
docs: add status documentaton for neopixel and dotstar
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/Status_Reference.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index 81449a6a..7442c170 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -346,3 +346,12 @@ The following information is available in the `z_tilt` object (this
object is available if z_tilt is defined):
- `applied`: True if the z-tilt leveling process has been run and completed
successfully.
+
+# neopixel / dotstar
+The following information is available for each `[neopixel led_name]` and
+`[dotstar led_name]` defined in printer.cfg:
+- `color_data`: An array of objects, with each object containing the RGBW
+ values for a led in the chain. Note that not all configurations will contain
+ a white value. Each value is represented as a float from 0 to 1. For
+ example, the blue value of the second neopixel in a chain could be accessed
+ at `printer["neopixel <config_name>"].colordata[1].B`.