From a7f69caa37a0290b80ce376281e311cb36ef48fd Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Wed, 23 Mar 2022 15:55:56 -0400 Subject: [PATCH] docs: Note change to neopixel/dotstar API status fields Signed-off-by: Kevin O'Connor --- docs/Config_Changes.md | 6 ++++++ docs/Status_Reference.md | 23 +++++++++++++---------- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md index b78a23be..587c06b0 100644 --- a/docs/Config_Changes.md +++ b/docs/Config_Changes.md @@ -8,6 +8,12 @@ All dates in this document are approximate. ## Changes +20220330: The format of the `printer.neopixel.color_data` status +information for neopixel and dotstar modules has changed. The +information is now stored as a list of color lists (instead of a list +of dictionaries). See the [status reference](Status_Reference.md#led) +for details. + 20220307: `M73` will no longer set print progress to 0 if `P` is missing. 20220304: There is no longer a default for the `extruder` parameter of diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md index dfe6b805..aac6fec0 100644 --- a/docs/Status_Reference.md +++ b/docs/Status_Reference.md @@ -191,6 +191,19 @@ is always available): been in the "Printing" state (as tracked by the idle_timeout module). +## led + +The following information is available for each `[led led_name]`, +`[neopixel led_name]`, `[dotstar led_name]`, `[pca9533 led_name]`, and +`[pca9632 led_name]` config section defined in printer.cfg: +- `color_data`: A list of color lists containing the RGBW values for a + led in the chain. Each value is represented as a float from 0.0 to + 1.0. Each color list contains 4 items (red, green, blue, white) even + if the underyling LED supports fewer color channels. For example, + the blue value (3rd item in color list) of the second neopixel in a + chain could be accessed at + `printer["neopixel "].color_data[1][2]`. + ## mcu The following information is available in @@ -406,13 +419,3 @@ 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 "].color_data[1].B`.