Skip to content

Commit e3fb848

Browse files
committed
feat(led_indicator): Update docs, examples
1 parent 87dcec2 commit e3fb848

File tree

7 files changed

+29
-19
lines changed

7 files changed

+29
-19
lines changed

docs/en/display/led_indicator.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Create an indicator by specifying an IO and a set of configuration information.
238238
.blink_lists = led_indicator_get_sample_lists(),
239239
.blink_list_num = led_indicator_get_sample_lists_num(),
240240
};
241-
led_indicator_handle_t led_handle = iot_led_new_gpio_device(&config, &led_indicator_gpio_config);
241+
esp_err_t ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle);
242242

243243

244244
Start/stop blinking: control your indicator to start/stop a specified type of blink by calling corresponding functions. The functions are returned immediately after calling, and the blink process is controlled by the internal timer. The same indicator can perform multiple blink types in turn based on their priorities.

docs/zh_CN/display/led_indicator.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ LED 指示灯是最简单的输出外设之一,可以通过不同形式的闪
234234
.blink_lists = led_indicator_get_sample_lists(),
235235
.blink_list_num = led_indicator_get_sample_lists_num(),
236236
};
237-
led_indicator_handle_t led_handle = iot_led_new_gpio_device(&config, &led_indicator_gpio_config);
237+
esp_err_t ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle);
238238

239239

240240
开始/停止闪烁:控制指示灯开启/停止指定闪烁类型,函数调用后立刻返回,内部由定时器控制闪烁流程。同一个指示灯可以开启多种闪烁类型,将根据闪烁类型优先级依次执行。

examples/indicator/gpio/main/main.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -11,7 +11,7 @@
1111
#include "cmd_led_indicator.h"
1212
#include "esp_idf_version.h"
1313
#include "esp_log.h"
14-
#include "led_indicator.h"
14+
#include "led_indicator_gpio.h"
1515

1616
#define GPIO_LED_PIN CONFIG_EXAMPLE_GPIO_NUM
1717
#define GPIO_ACTIVE_LEVEL CONFIG_EXAMPLE_GPIO_ACTIVE_LEVEL
@@ -124,7 +124,8 @@ void app_main(void)
124124
.blink_list_num = BLINK_MAX,
125125
};
126126

127-
led_handle = iot_led_new_gpio_device(&config, &gpio_config);
127+
esp_err_t ret = led_indicator_new_gpio_device(&config, &gpio_config, &led_handle);
128+
ESP_ERROR_CHECK(ret);
128129
assert(led_handle != NULL);
129130

130131
#if CONFIG_EXAMPLE_ENABLE_CONSOLE_CONTROL

examples/indicator/ledc/main/main.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -11,7 +11,7 @@
1111
#include "cmd_led_indicator.h"
1212
#include "esp_idf_version.h"
1313
#include "esp_log.h"
14-
#include "led_indicator.h"
14+
#include "led_indicator_ledc.h"
1515

1616
#define GPIO_LED_PIN CONFIG_EXAMPLE_GPIO_NUM
1717
#define GPIO_ACTIVE_LEVEL CONFIG_EXAMPLE_GPIO_ACTIVE_LEVEL
@@ -152,7 +152,8 @@ void app_main(void)
152152
.blink_list_num = BLINK_MAX,
153153
};
154154

155-
led_handle = iot_led_new_ledc_device(&config, &ledc_config);
155+
esp_err_t ret = led_indicator_new_ledc_device(&config, &ledc_config, &led_handle);
156+
ESP_ERROR_CHECK(ret);
156157
assert(led_handle != NULL);
157158

158159
#if CONFIG_EXAMPLE_ENABLE_CONSOLE_CONTROL

examples/indicator/rgb/main/main.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -11,7 +11,7 @@
1111
#include "cmd_led_indicator.h"
1212
#include "esp_idf_version.h"
1313
#include "esp_log.h"
14-
#include "led_indicator.h"
14+
#include "led_indicator_rgb.h"
1515

1616
#define GPIO_LED_RED_PIN CONFIG_EXAMPLE_GPIO_RED_NUM
1717
#define GPIO_LED_GREEN_PIN CONFIG_EXAMPLE_GPIO_GREEN_NUM
@@ -186,7 +186,8 @@ void app_main(void)
186186
.blink_list_num = BLINK_MAX,
187187
};
188188

189-
led_handle = iot_led_new_rgb_device(&config, &rgb_config);
189+
esp_err_t ret = led_indicator_new_rgb_device(&config, &rgb_config, &led_handle);
190+
ESP_ERROR_CHECK(ret);
190191
assert(led_handle != NULL);
191192

192193
#if CONFIG_EXAMPLE_ENABLE_CONSOLE_CONTROL

examples/indicator/ws2812_strips/main/main.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -11,7 +11,7 @@
1111
#include "cmd_led_indicator.h"
1212
#include "esp_idf_version.h"
1313
#include "esp_log.h"
14-
#include "led_indicator.h"
14+
#include "led_indicator_strips.h"
1515

1616
#define WS2812_GPIO_NUM CONFIG_EXAMPLE_WS2812_GPIO_NUM
1717
#define WS2812_STRIPS_NUM CONFIG_EXAMPLE_WS2812_STRIPS_NUM
@@ -216,7 +216,8 @@ void app_main(void)
216216
.blink_list_num = BLINK_MAX,
217217
};
218218

219-
led_handle = iot_led_new_strips_device(&config, &strips_config);
219+
esp_err_t ret = led_indicator_new_strips_device(&config, &strips_config, &led_handle);
220+
ESP_ERROR_CHECK(ret);
220221
assert(led_handle != NULL);
221222

222223
#if CONFIG_EXAMPLE_ENABLE_CONSOLE_CONTROL

examples/usb/host/usb_cdc_4g_module/main/app_main.c

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#include "nvs_flash.h"
1919
#include "nvs.h"
2020
#include "esp_netif.h"
21-
#include "led_indicator.h"
21+
#include "led_indicator_gpio.h"
2222
#include "led_indicator_blink_default.h"
2323
#include "usbh_modem_board.h"
2424
#include "usbh_modem_wifi.h"
@@ -113,23 +113,29 @@ static void _led_indicator_init()
113113
.is_active_level_high = LED_ACTIVE_LEVEL,
114114
};
115115

116-
led_indicator_config_t led_config ;
116+
led_indicator_config_t led_config = {
117+
.blink_lists = NULL,
118+
.blink_list_num = 0,
119+
};
117120

118121
if (LED_RED_SYSTEM_GPIO) {
119122
led_indicator_gpio_config.gpio_num = LED_RED_SYSTEM_GPIO;
120-
s_led_system_handle = iot_led_new_gpio_device(&led_config, &led_indicator_gpio_config);
123+
esp_err_t ret = led_indicator_new_gpio_device(&led_config, &led_indicator_gpio_config, &s_led_system_handle);
124+
ESP_ERROR_CHECK(ret);
121125
assert(s_led_system_handle != NULL);
122126
}
123127
if (LED_BLUE_WIFI_GPIO) {
124128
led_indicator_gpio_config.gpio_num = LED_BLUE_WIFI_GPIO;
125-
s_led_wifi_handle = iot_led_new_gpio_device(&led_config, &led_indicator_gpio_config);
129+
ret = led_indicator_new_gpio_device(&led_config, &led_indicator_gpio_config, &s_led_wifi_handle);
130+
ESP_ERROR_CHECK(ret);
126131
assert(s_led_wifi_handle != NULL);
127132
led_indicator_stop(s_led_wifi_handle, BLINK_CONNECTED);
128133
led_indicator_start(s_led_wifi_handle, BLINK_CONNECTING);
129134
}
130135
if (LED_GREEN_4GMODEM_GPIO) {
131136
led_indicator_gpio_config.gpio_num = LED_GREEN_4GMODEM_GPIO;
132-
s_led_4g_handle = iot_led_new_gpio_device(&led_config, &led_indicator_gpio_config);
137+
ret = led_indicator_new_gpio_device(&led_config, &led_indicator_gpio_config, &s_led_4g_handle);
138+
ESP_ERROR_CHECK(ret);
133139
assert(s_led_4g_handle != NULL);
134140
led_indicator_stop(s_led_4g_handle, BLINK_CONNECTED);
135141
led_indicator_start(s_led_4g_handle, BLINK_CONNECTING);

0 commit comments

Comments
 (0)