h3n3/klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Note change to neopixel/dotstar API status fields

Browse Source 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor
2022-03-23 15:55:56 -04:00
parent 2001eecd5e
commit a7f69caa37
2 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/Status_Reference.md
View File

@@ -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 <config_name>"].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 <config_name>"].color_data[1].B`.