Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
LED Strip Driver Backend API

Data Structures

struct  led_strip_driver_api
  Driver Operations LED Strip driver operations More...

Typedefs

typedef int(* led_api_update_rgb) (const struct device *dev, struct led_rgb *pixels, size_t num_pixels)
 Callback API for updating an RGB LED strip.
typedef int(* led_api_update_channels) (const struct device *dev, uint8_t *channels, size_t num_channels)
 Callback API for updating channels without an RGB interpretation.
typedef size_t(* led_api_length) (const struct device *dev)
 Callback API for getting length of an LED strip.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a LED Strip driver.

Typedef Documentation

◆ led_api_length

typedef size_t(* led_api_length) (const struct device *dev)

#include <zephyr/drivers/led_strip.h>

Callback API for getting length of an LED strip.

See led_strip_length() for argument descriptions.

◆ led_api_update_channels

typedef int(* led_api_update_channels) (const struct device *dev, uint8_t *channels, size_t num_channels)

#include <zephyr/drivers/led_strip.h>

Callback API for updating channels without an RGB interpretation.

See led_strip_update_channels() for argument descriptions.

◆ led_api_update_rgb

typedef int(* led_api_update_rgb) (const struct device *dev, struct led_rgb *pixels, size_t num_pixels)

#include <zephyr/drivers/led_strip.h>

Callback API for updating an RGB LED strip.

See led_strip_update_rgb() for argument descriptions.