GEX protocol documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gex-docs/UNIT_NEOPIXEL.md

58 lines
1.1 KiB

6 years ago
# NeoPixel
Implements the NeoPixel protocol for driving addressable LED strips.
The strip length is configured in the unit settings.
Five color data encodings are available for user convenience.
6 years ago
## Commands
### CLEAR (0x00)
Set all pixels to black. This is also automatically executed on start-up to clear the strip.
6 years ago
### LOAD (0x01)
Load packed RGB data to the strip.
*Payload:*
- a byte array `(R,G,B)` x length
### LOAD_U32_ZRGB (0x08)
Load 32-bit `0x00RRGGBB` words encoded in big-endian as `(0,R,G,B)`.
6 years ago
*Payload:*
- a byte array `(0,R,G,B)` x length
6 years ago
### LOAD_U32_ZBGR (0x09)
6 years ago
Load 32-bit `0x00BBGGRR` words encoded in big-endian as `(0,B,G,R)`.
*Payload:*
- a byte array `(0,B,G,R)` x length
### LOAD_U32_RGBZ (0x0A)
Load 32-bit `0x00BBGGRR` words encoded in little-endian as `(R,G,B,0)`.
*Payload:*
- a byte array `(R,G,B,0)` x length
### LOAD_U32_BGRZ (0x09)
Load 32-bit `0x00RRGGBB` words encoded in little-endian as `(B,G,R,0)`.
*Payload:*
- a byte array `(B,G,R,0)` x length
6 years ago
### GET_LEN (0x04)
Read the neopixel strip length as configured in the settings.
*Response:*
- u16 - number of pixels
## Events
*No events defined for this unit type.*