lv_led.h

API reference for lv_led.h

Summary

Functions

public/widgets/lv_led.h:64function

lv_led_set_color

Set the color of the LED

void lv_led_set_color(lv_obj_t *obj, lv_color_t color)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a LED object
`color`	`lv_color_t`	the color of the LED

public/widgets/lv_led.h:71function

lv_led_set_brightness

Set the brightness of a LED object

void lv_led_set_brightness(lv_obj_t *obj, uint8_t bright)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a LED object
`bright`	`uint8_t`	LV_LED_BRIGHT_MIN (max. dark) ... LV_LED_BRIGHT_MAX (max. light)

public/widgets/lv_led.h:96function

lv_led_get_brightness

Get the brightness of a LED object

uint8_t lv_led_get_brightness(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to LED object

Returns: uint8_t — bright 0 (max. dark) ... 255 (max. light)

public/widgets/lv_led.h:103function

lv_led_get_color

Get the color of a LED object

lv_color_t lv_led_get_color(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to LED object

Returns: lv_color_t — color color of the LED

public/widgets/lv_led.h:57function

lv_led_create

Create a led object

lv_obj_t * lv_led_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a parent widget May be `NULL`.. When NULL, the widget is created as a screen on the default display.

Returns: lv_obj_t * — pointer to the created led

public/widgets/lv_led.h:77function

lv_led_on

Light on a LED

void lv_led_on(lv_obj_t *led)

Name	Type	Description
`led`	`lv_obj_t *`	pointer to a LED object

public/widgets/lv_led.h:83function

lv_led_off

Light off a LED

void lv_led_off(lv_obj_t *led)

Name	Type	Description
`led`	`lv_obj_t *`	pointer to a LED object

public/widgets/lv_led.h:89function

lv_led_toggle

Toggle the state of a LED

void lv_led_toggle(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a LED object

Enums

public/widgets/lv_led.h:40enum

_lv_property_led_id_t

Name	Value
`LV_PROPERTY_LED_COLOR`	`(LV_PROPERTY_LED_START + ((int) 0 )) \| (( 3 ) << 28 )`
`LV_PROPERTY_LED_BRIGHTNESS`	`(LV_PROPERTY_LED_START + ((int) 1 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_LED_END`

Macros

public/widgets/lv_led.h:25macro

LV_LED_BRIGHT_MIN

#define LV_LED_BRIGHT_MIN 80

Brightness when the LED if OFF

public/widgets/lv_led.h:30macro

LV_LED_BRIGHT_MAX

#define LV_LED_BRIGHT_MAX 255

Brightness when the LED if ON

Variables

public/widgets/lv_led.h:37variable

lv_led_class

const lv_obj_class_t lv_led_class