Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
led_driver_api Struct Reference

@driver_ops{LED} More...

#include <led.h>

Data Fields

led_api_on on
 @driver_ops_optional Turn on an LED.
led_api_off off
 @driver_ops_optional Turn off an LED.
led_api_set_brightness set_brightness
 @driver_ops_optional Set LED brightness.
led_api_blink blink
 @driver_ops_optional Blink an LED.
led_api_get_info get_info
 @driver_ops_optional Get LED information.
led_api_set_color set_color
 @driver_ops_optional Set LED color.
led_api_write_channels write_channels
 @driver_ops_optional Write/update a strip of LED channels.

Detailed Description

@driver_ops{LED}

Note
A driver must implement at least led_driver_api::set_brightness, or both led_driver_api::on and led_driver_api::off. The subsystem emulates each of these operations with the other(s) when it is not provided.

Field Documentation

◆ blink

led_api_blink led_driver_api::blink

@driver_ops_optional Blink an LED.

◆ get_info

led_api_get_info led_driver_api::get_info

@driver_ops_optional Get LED information.

◆ off

led_api_off led_driver_api::off

@driver_ops_optional Turn off an LED.

Mandatory if led_driver_api::set_brightness is not implemented.

◆ on

led_api_on led_driver_api::on

@driver_ops_optional Turn on an LED.

Mandatory if led_driver_api::set_brightness is not implemented.

◆ set_brightness

led_api_set_brightness led_driver_api::set_brightness

@driver_ops_optional Set LED brightness.

Mandatory if led_driver_api::on and led_driver_api::off are not implemented.

◆ set_color

led_api_set_color led_driver_api::set_color

@driver_ops_optional Set LED color.

◆ write_channels

led_api_write_channels led_driver_api::write_channels

@driver_ops_optional Write/update a strip of LED channels.


The documentation for this struct was generated from the following file:
  • include/zephyr/drivers/led.h