Skip to content

Commit 87dcec2

Browse files
zhongchaoespzhongchaoesp
committed
feat(led_indicator): Modify all public APIs return esp_err_t
1 parent 33f9877 commit 87dcec2

File tree

9 files changed

+55
-42
lines changed

9 files changed

+55
-42
lines changed

‎components/led/led_indicator/include/led_indicator_gpio.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ typedef struct {
3434
* - ESP_OK Success
3535
* - ESP_FAIL Delete fail
3636
*/
37-
led_indicator_handle_t led_indicator_new_gpio_device(const led_indicator_config_t *led_config, const led_indicator_gpio_config_t *gpio_cfg);
37+
esp_err_t led_indicator_new_gpio_device(const led_indicator_config_t *led_config, const led_indicator_gpio_config_t *gpio_cfg, led_indicator_handle_t *handle);
3838
#ifdef __cplusplus
3939
}
4040
#endif

‎components/led/led_indicator/include/led_indicator_ledc.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ typedef struct {
3333
* - ESP_OK Success
3434
* - ESP_FAIL Delete fail
3535
*/
36-
led_indicator_handle_t led_indicator_new_ledc_device(const led_indicator_config_t *led_config, const led_indicator_ledc_config_t *ledc_cfg);
36+
esp_err_t led_indicator_new_ledc_device(const led_indicator_config_t *led_config, const led_indicator_ledc_config_t *ledc_cfg, led_indicator_handle_t *handle);
3737

3838
#ifdef __cplusplus
3939
}

‎components/led/led_indicator/include/led_indicator_rgb.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ typedef struct {
4040
* - ESP_OK Success
4141
* - ESP_FAIL Delete fail
4242
*/
43-
led_indicator_handle_t led_indicator_new_rgb_device(const led_indicator_config_t *led_config, const led_indicator_rgb_config_t *rgb_cfg);
43+
esp_err_t led_indicator_new_rgb_device(const led_indicator_config_t *led_config, const led_indicator_rgb_config_t *rgb_cfg, led_indicator_handle_t *handle);
4444

4545
#ifdef __cplusplus
4646
}

‎components/led/led_indicator/include/led_indicator_strips.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ typedef struct {
5050
* - ESP_OK Success
5151
* - ESP_FAIL Delete fail
5252
*/
53-
led_indicator_handle_t led_indicator_new_strips_device(const led_indicator_config_t *led_config, const led_indicator_strips_config_t *strips_cfg);
53+
esp_err_t led_indicator_new_strips_device(const led_indicator_config_t *led_config, const led_indicator_strips_config_t *strips_cfg, led_indicator_handle_t *handle);
5454
#ifdef __cplusplus
5555
}
5656
#endif

‎components/led/led_indicator/src/led_indicator_gpio.c‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@ static esp_err_t led_indicator_gpio_set_on_off(void *handle, bool on_off)
7272
return gpio_set_level(p_gpio->io_num, on_off);
7373
}
7474

75-
led_indicator_handle_t led_indicator_new_gpio_device(const led_indicator_config_t *led_config, const led_indicator_gpio_config_t *gpio_cfg)
75+
esp_err_t led_indicator_new_gpio_device(const led_indicator_config_t *led_config, const led_indicator_gpio_config_t *gpio_cfg, led_indicator_handle_t *handle)
7676
{
7777
esp_err_t ret = ESP_OK;
7878
bool if_blink_default_list = false;
7979

8080
ESP_LOGI(TAG, "LED Indicator Version: %d.%d.%d", LED_INDICATOR_VER_MAJOR, LED_INDICATOR_VER_MINOR, LED_INDICATOR_VER_PATCH);
81-
LED_INDICATOR_CHECK(gpio_cfg != NULL, "invalid config pointer", return NULL);
81+
LED_INDICATOR_CHECK(gpio_cfg != NULL, "invalid config pointer", return ESP_ERR_INVALID_ARG);
8282
_led_indicator_com_config_t com_cfg = {0};
8383
_led_indicator_t *p_led_indicator = NULL;
8484

8585
void *hardware_data = NULL;
8686
ret = led_indicator_gpio_init((void *)gpio_cfg, &hardware_data);
87-
LED_INDICATOR_CHECK(ESP_OK == ret, "LED rgb init failed", return NULL);
87+
LED_INDICATOR_CHECK(ESP_OK == ret, "LED rgb init failed", return ESP_FAIL);
8888
com_cfg.hardware_data = hardware_data;
8989
com_cfg.hal_indicator_set_on_off = led_indicator_gpio_set_on_off;
9090
com_cfg.hal_indicator_deinit = led_indicator_gpio_deinit;
@@ -103,8 +103,9 @@ led_indicator_handle_t led_indicator_new_gpio_device(const led_indicator_config_
103103

104104
p_led_indicator = _led_indicator_create_com(&com_cfg);
105105

106-
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return NULL);
106+
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return ESP_FAIL);
107107
_led_indicator_add_node(p_led_indicator);
108108
ESP_LOGI(TAG, "Indicator create successfully. type:GPIO mode, hardware_data:%p, blink_lists:%s", p_led_indicator->hardware_data, if_blink_default_list ? "default" : "custom");
109-
return (led_indicator_handle_t)p_led_indicator;
109+
*handle = (led_indicator_handle_t)p_led_indicator;
110+
return ESP_OK;
110111
}

‎components/led/led_indicator/src/led_indicator_ledc.c‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,18 +118,18 @@ static esp_err_t led_indicator_ledc_set_brightness(void *channel, uint32_t brigh
118118
return ESP_OK;
119119
}
120120

121-
led_indicator_handle_t led_indicator_new_ledc_device(const led_indicator_config_t *led_config, const led_indicator_ledc_config_t *ledc_cfg)
121+
esp_err_t led_indicator_new_ledc_device(const led_indicator_config_t *led_config, const led_indicator_ledc_config_t *ledc_cfg, led_indicator_handle_t *handle)
122122
{
123123
esp_err_t ret = ESP_OK;
124124
bool if_blink_default_list = false;
125125

126126
ESP_LOGI(TAG, "LED Indicator Version: %d.%d.%d", LED_INDICATOR_VER_MAJOR, LED_INDICATOR_VER_MINOR, LED_INDICATOR_VER_PATCH);
127-
LED_INDICATOR_CHECK(ledc_cfg != NULL, "invalid config pointer", return NULL);
127+
LED_INDICATOR_CHECK(ledc_cfg != NULL, "invalid config pointer", return ESP_ERR_INVALID_ARG);
128128
_led_indicator_com_config_t com_cfg = {0};
129129
_led_indicator_t *p_led_indicator = NULL;
130130

131131
ret = led_indicator_ledc_init((void *)ledc_cfg);
132-
LED_INDICATOR_CHECK(ESP_OK == ret, "LEDC mode init failed", return NULL);
132+
LED_INDICATOR_CHECK(ESP_OK == ret, "LEDC mode init failed", return ESP_FAIL);
133133
com_cfg.hardware_data = (void *)ledc_cfg->channel;
134134
com_cfg.hal_indicator_set_on_off = led_indicator_ledc_set_on_off;
135135
com_cfg.hal_indicator_deinit = led_indicator_ledc_deinit;
@@ -148,8 +148,9 @@ led_indicator_handle_t led_indicator_new_ledc_device(const led_indicator_config_
148148

149149
p_led_indicator = _led_indicator_create_com(&com_cfg);
150150

151-
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return NULL);
151+
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return ESP_FAIL);
152152
_led_indicator_add_node(p_led_indicator);
153153
ESP_LOGI(TAG, "Indicator create successfully. type:LEDC mode, hardware_data:%p, blink_lists:%s", p_led_indicator->hardware_data, if_blink_default_list ? "default" : "custom");
154-
return (led_indicator_handle_t)p_led_indicator;
154+
*handle = (led_indicator_handle_t)p_led_indicator;
155+
return ESP_OK;
155156
}

‎components/led/led_indicator/src/led_indicator_rgb.c‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,19 +159,19 @@ static esp_err_t led_indicator_rgb_set_brightness(void *rgb_handle, uint32_t bri
159159
return ESP_OK;
160160
}
161161

162-
led_indicator_handle_t led_indicator_new_rgb_device(const led_indicator_config_t *led_config, const led_indicator_rgb_config_t *rgb_cfg)
162+
esp_err_t led_indicator_new_rgb_device(const led_indicator_config_t *led_config, const led_indicator_rgb_config_t *rgb_cfg, led_indicator_handle_t *handle)
163163
{
164164
esp_err_t ret = ESP_OK;
165165
bool if_blink_default_list = false;
166166

167167
ESP_LOGI(TAG, "LED Indicator Version: %d.%d.%d", LED_INDICATOR_VER_MAJOR, LED_INDICATOR_VER_MINOR, LED_INDICATOR_VER_PATCH);
168-
LED_INDICATOR_CHECK(rgb_cfg != NULL, "invalid config pointer", return NULL);
168+
LED_INDICATOR_CHECK(rgb_cfg != NULL, "invalid config pointer", return ESP_ERR_INVALID_ARG);
169169
_led_indicator_com_config_t com_cfg = {0};
170170
_led_indicator_t *p_led_indicator = NULL;
171171

172172
void *hardware_data = NULL;
173173
ret = led_indicator_rgb_init((void *)rgb_cfg, &hardware_data);
174-
LED_INDICATOR_CHECK(ESP_OK == ret, "LEDC mode init failed", return NULL);
174+
LED_INDICATOR_CHECK(ESP_OK == ret, "LEDC mode init failed", return ESP_FAIL);
175175
com_cfg.hardware_data = hardware_data;
176176
com_cfg.hal_indicator_set_on_off = led_indicator_rgb_set_on_off;
177177
com_cfg.hal_indicator_deinit = led_indicator_rgb_deinit;
@@ -192,8 +192,9 @@ led_indicator_handle_t led_indicator_new_rgb_device(const led_indicator_config_t
192192

193193
p_led_indicator = _led_indicator_create_com(&com_cfg);
194194

195-
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return NULL);
195+
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return ESP_FAIL);
196196
_led_indicator_add_node(p_led_indicator);
197197
ESP_LOGI(TAG, "Indicator create successfully. type:LED RGB mode, hardware_data:%p, blink_lists:%s", p_led_indicator->hardware_data, if_blink_default_list ? "default" : "custom");
198-
return (led_indicator_handle_t)p_led_indicator;
198+
*handle = (led_indicator_handle_t)p_led_indicator;
199+
return ESP_OK;
199200
}

‎components/led/led_indicator/src/led_indicator_strips.c‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,19 +190,19 @@ static esp_err_t led_indicator_strips_set_brightness(void *strips, uint32_t ihsv
190190
return ESP_OK;
191191
}
192192

193-
led_indicator_handle_t led_indicator_new_strips_device(const led_indicator_config_t *led_config, const led_indicator_strips_config_t *strips_cfg)
193+
esp_err_t led_indicator_new_strips_device(const led_indicator_config_t *led_config, const led_indicator_strips_config_t *strips_cfg, led_indicator_handle_t *handle)
194194
{
195195
esp_err_t ret = ESP_OK;
196196
bool if_blink_default_list = false;
197197

198198
ESP_LOGI(TAG, "LED Indicator Version: %d.%d.%d", LED_INDICATOR_VER_MAJOR, LED_INDICATOR_VER_MINOR, LED_INDICATOR_VER_PATCH);
199-
LED_INDICATOR_CHECK(strips_cfg != NULL, "invalid config pointer", return NULL);
199+
LED_INDICATOR_CHECK(strips_cfg != NULL, "invalid config pointer", return ESP_ERR_INVALID_ARG);
200200
_led_indicator_com_config_t com_cfg = {0};
201201
_led_indicator_t *p_led_indicator = NULL;
202202

203203
void *hardware_data = NULL;
204204
ret = led_indicator_strips_init((void *)strips_cfg, &hardware_data);
205-
LED_INDICATOR_CHECK(ESP_OK == ret, "LED rgb init failed", return NULL);
205+
LED_INDICATOR_CHECK(ESP_OK == ret, "LED rgb init failed", return ESP_FAIL);
206206
com_cfg.hardware_data = hardware_data;
207207
com_cfg.hal_indicator_set_on_off = led_indicator_strips_set_on_off;
208208
com_cfg.hal_indicator_deinit = led_indicator_strips_deinit;
@@ -223,8 +223,9 @@ led_indicator_handle_t led_indicator_new_strips_device(const led_indicator_confi
223223

224224
p_led_indicator = _led_indicator_create_com(&com_cfg);
225225

226-
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return NULL);
226+
LED_INDICATOR_CHECK(NULL != p_led_indicator, "LED indicator create failed", return ESP_FAIL);
227227
_led_indicator_add_node(p_led_indicator);
228228
ESP_LOGI(TAG, "Indicator create successfully. type:LED Strips mode, hardware_data:%p, blink_lists:%s", p_led_indicator->hardware_data, if_blink_default_list ? "default" : "custom");
229-
return (led_indicator_handle_t)p_led_indicator;
229+
*handle = (led_indicator_handle_t)p_led_indicator;
230+
return ESP_OK;
230231
}

‎components/led/led_indicator/test_apps/main/test_led_indicator.c‎

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ void led_indicator_init()
4646
.blink_list_num = 0,
4747
};
4848

49-
led_handle_0 = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config);
49+
esp_err_t ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle_0);
50+
TEST_ASSERT(ret == ESP_OK);
5051
TEST_ASSERT_NOT_NULL(led_handle_0);
5152
}
5253

@@ -168,13 +169,16 @@ void led_indicator_all_init()
168169
.blink_list_num = 0,
169170
};
170171

171-
led_handle_0 = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config);
172+
esp_err_t ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle_0);
173+
TEST_ASSERT(ret == ESP_OK);
172174
TEST_ASSERT_NOT_NULL(led_handle_0);
173175
led_indicator_gpio_config.gpio_num = LED_IO_NUM_1;
174-
led_handle_1 = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config);
176+
ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle_1);
177+
TEST_ASSERT(ret == ESP_OK);
175178
TEST_ASSERT_NOT_NULL(led_handle_1);
176179
led_indicator_gpio_config.gpio_num = LED_IO_NUM_2;
177-
led_handle_2 = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config);
180+
ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle_2);
181+
TEST_ASSERT(ret == ESP_OK);
178182
TEST_ASSERT_NOT_NULL(led_handle_2);
179183
}
180184

@@ -340,11 +344,12 @@ TEST_CASE("User defined blink", "[LED][indicator]")
340344
.blink_list_num = BLINK_NUM,
341345
};
342346

343-
led_handle_0 = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config);
347+
esp_err_t ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle_0);
348+
TEST_ASSERT(ret == ESP_OK);
344349
TEST_ASSERT_NOT_NULL(led_handle_0);
345350

346351
ESP_LOGI(TAG, "double blink.....");
347-
esp_err_t ret = led_indicator_start(led_handle_0, BLINK_DOUBLE);
352+
ret = led_indicator_start(led_handle_0, BLINK_DOUBLE);
348353
TEST_ASSERT(ret == ESP_OK);
349354
vTaskDelay(2000 / portTICK_PERIOD_MS);
350355
ret = led_indicator_stop(led_handle_0, BLINK_DOUBLE);
@@ -374,11 +379,12 @@ TEST_CASE("Preempt blink lists test", "[LED][indicator]")
374379
.blink_list_num = BLINK_NUM,
375380
};
376381

377-
led_handle_0 = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config);
382+
esp_err_t ret = led_indicator_new_gpio_device(&config, &led_indicator_gpio_config, &led_handle_0);
383+
TEST_ASSERT(ret == ESP_OK);
378384
TEST_ASSERT_NOT_NULL(led_handle_0);
379385

380386
ESP_LOGI(TAG, "double blink.....");
381-
esp_err_t ret = led_indicator_start(led_handle_0, BLINK_DOUBLE);
387+
ret = led_indicator_start(led_handle_0, BLINK_DOUBLE);
382388
vTaskDelay(1000 / portTICK_PERIOD_MS);
383389
TEST_ASSERT(ret == ESP_OK);
384390

@@ -415,11 +421,12 @@ TEST_CASE("breathe test", "[LED][indicator]")
415421
.blink_list_num = BLINK_NUM,
416422
};
417423

418-
led_handle_0 = led_indicator_new_ledc_device(&config, &led_indicator_ledc_config);
424+
esp_err_t ret = led_indicator_new_ledc_device(&config, &led_indicator_ledc_config, &led_handle_0);
425+
TEST_ASSERT(ret == ESP_OK);
419426
TEST_ASSERT_NOT_NULL(led_handle_0);
420427

421428
ESP_LOGI(TAG, "breathe 25/100 blink.....");
422-
esp_err_t ret = led_indicator_start(led_handle_0, BLINK_25_BRIGHTNESS);
429+
ret = led_indicator_start(led_handle_0, BLINK_25_BRIGHTNESS);
423430
vTaskDelay(2000 / portTICK_PERIOD_MS);
424431
TEST_ASSERT(ret == ESP_OK);
425432

@@ -462,11 +469,12 @@ TEST_CASE("test led preempt func with breath", "[LED][preempt][breath]")
462469
};
463470
int cnt0 = 3;
464471
while (cnt0--) {
465-
led_handle_0 = led_indicator_new_ledc_device(&config, &led_indicator_ledc_config);
472+
esp_err_t ret = led_indicator_new_ledc_device(&config, &led_indicator_ledc_config, &led_handle_0);
473+
TEST_ASSERT(ret == ESP_OK);
466474
TEST_ASSERT_NOT_NULL(led_handle_0);
467475

468476
ESP_LOGI(TAG, "breathe blink .....");
469-
esp_err_t ret = led_indicator_start(led_handle_0, BLINK_BREATHE);
477+
ret = led_indicator_start(led_handle_0, BLINK_BREATHE);
470478
TEST_ASSERT(ret == ESP_OK);
471479
bool preempted = false;
472480
int cnt = 3;
@@ -641,9 +649,8 @@ TEST_CASE("TEST LED RGB", "[LED RGB][RGB]")
641649
.blink_list_num = BLINK_RGB_NUM,
642650
};
643651

644-
led_handle_0 = led_indicator_new_rgb_device(&config, &led_grb_cfg);
645-
esp_err_t ret = ESP_OK;
646-
652+
esp_err_t ret = led_indicator_new_rgb_device(&config, &led_grb_cfg, &led_handle_0);
653+
TEST_ASSERT(ret == ESP_OK);
647654
TEST_ASSERT_NOT_NULL(led_handle_0);
648655

649656
ESP_LOGI(TAG, "breathe 25/100 blink.....");
@@ -763,8 +770,8 @@ TEST_CASE("TEST LED Strips by RGB", "[LED Strips][RGB]")
763770
.blink_list_num = BLINK_RGB_NUM,
764771
};
765772
esp_err_t ret = ESP_OK;
766-
led_handle_0 = led_indicator_new_strips_device(&config, &led_indicator_strips_config);
767-
773+
ret = led_indicator_new_strips_device(&config, &led_indicator_strips_config, &led_handle_0);
774+
TEST_ASSERT(ret == ESP_OK);
768775
TEST_ASSERT_NOT_NULL(led_handle_0);
769776

770777
ESP_LOGI(TAG, "breathe 25/100 blink.....");
@@ -881,7 +888,9 @@ TEST_CASE("TEST LED RGB control Real time ", "[LED RGB][Real time]")
881888
.blink_list_num = BLINK_RGB_NUM,
882889
};
883890
esp_err_t ret = ESP_OK;
884-
led_handle_0 = led_indicator_new_strips_device(&config, &led_indicator_strips_config);
891+
ret = led_indicator_new_strips_device(&config, &led_indicator_strips_config, &led_handle_0);
892+
TEST_ASSERT(ret == ESP_OK);
893+
TEST_ASSERT_NOT_NULL(led_handle_0);
885894

886895
ESP_LOGI(TAG, "set red by rgb_value one by one .....");
887896

0 commit comments

Comments
 (0)