mirror of https://github.com/lvgl/lvgl.git synced 2025-01-21 06:53:01 +08:00

Gabor Kiss-Vamosi 643b6f52f0 docs add docs for some extra widgets

2021-05-18 14:25:17 +02:00

1.2 KiB

Raw Blame History

.. include:: /header.rst 
:github_url: |github_link_base|/widgets/led.md

LED (lv_led)

Overview

The LEDs are rectangle-like (or circle) object. It's brightness can be adjusted. With lower brightness the the colors of the LED become darker.

Parts and Styles

The LEDs have only one main part, called LV_LED_PART_MAIN and it uses all the typical background style properties.

Usage

Color

You can set the color of the LED with lv_led_set_color(led, lv_color_hex(0xff0080)). This will be used as background color, border color, and shadow color.

Brightness

You can set their brightness with lv_led_set_bright(led, bright). The brightness should be between 0 (darkest) and 255 (lightest).

Toggle

Use lv_led_on(led) and lv_led_off(led) to set the brightness to a predefined ON or OFF value. The lv_led_toggle(led) toggles between the ON and OFF state.

Events

No special event are sent by the LED object.

Learn more about Events.

Keys

No Keys are processed by the object type.

Learn more about Keys.

Example


.. include:: ../../../examples/widgets/led/index.rst

API


.. doxygenfile:: lv_led.h
  :project: lvgl

1.2 KiB Raw Blame History