This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

worldsemi,ws2812-gpio

Vendor: Worldsemi Co., Limited

Description

Worldsemi WS2812 LED strip, GPIO binding

Driver bindings for bit-banging a WS2812 or compatible LED strip.

The GPIO driver uses inline assembly, and isn't available for all
boards.

Properties

Properties not inherited from the base binding file.

Name

Type

Details

gpios

phandle-array

GPIO phandle and specifier for the pin connected to the
led-strip. Exactly one pin should be given.

This property is required.

chain-length

int

The number of devices in the daisy-chain.

This property is required.

color-mapping

array

Channel to color mapping (or pixel order).

For example a GRB channel to color mapping would be

   color-mapping = <LED_COLOR_ID_GREEN
                    LED_COLOR_ID_RED
                    LED_COLOR_ID_BLUE>;

This property is required.

reset-delay

int

Minimum delay to wait (in microseconds) to make sure that the strip has
latched the signal. If omitted, a default value of 8 microseconds is used.
This default is good for the WS2812 controllers. Note that despite the
WS2812 datasheet states that a 50 microseconds delay is required, it seems
6 microseconds is enough. The default is set to 8 microseconds just to be
safe.

Default value: 8