Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
led_strip_driver_api Struct Reference

Driver Operations LED Strip driver operations More...

#include <zephyr/drivers/led_strip.h>

Data Fields

led_api_update_rgb update_rgb
  REQ Update an LED strip with the given RGB array.
led_api_length length
  REQ Get chain length (in pixels) of an LED strip device.
led_api_update_channels update_channels
  OPT Update an LED strip with the given channel array.

Detailed Description

Driver Operations LED Strip driver operations

This is the driver API structure any LED Strip driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Field Documentation

◆ length

led_api_length led_strip_driver_api::length

REQ Get chain length (in pixels) of an LED strip device.

◆ update_channels

led_api_update_channels led_strip_driver_api::update_channels

OPT Update an LED strip with the given channel array.

◆ update_rgb

led_api_update_rgb led_strip_driver_api::update_rgb

REQ Update an LED strip with the given RGB array.


The documentation for this struct was generated from the following file: