From 15a683b435d6811d16c415422b1f2749e693241f Mon Sep 17 00:00:00 2001 From: Abhik Roy Date: Mon, 9 Oct 2023 22:37:46 +1100 Subject: [PATCH] feat(common): Added simple component for console initialization --- .../workflows/console_simple_init__build.yml | 32 +++ .github/workflows/publish-docs-component.yml | 1 + components/console_simple_init/CMakeLists.txt | 3 + components/console_simple_init/LICENSE | 201 ++++++++++++++++++ components/console_simple_init/README.md | 37 ++++ .../console_simple_init/console_simple_init.c | 63 ++++++ .../console_simple_init/console_simple_init.h | 23 ++ .../console_init-basic/CMakeLists.txt | 8 + .../console_init-basic/main/CMakeLists.txt | 2 + .../main/console_init-basic.c | 37 ++++ .../console_init-basic/main/idf_component.yml | 6 + .../console_simple_init/idf_component.yml | 6 + 12 files changed, 419 insertions(+) create mode 100644 .github/workflows/console_simple_init__build.yml create mode 100644 components/console_simple_init/CMakeLists.txt create mode 100644 components/console_simple_init/LICENSE create mode 100644 components/console_simple_init/README.md create mode 100644 components/console_simple_init/console_simple_init.c create mode 100644 components/console_simple_init/console_simple_init.h create mode 100644 components/console_simple_init/examples/console_init-basic/CMakeLists.txt create mode 100644 components/console_simple_init/examples/console_init-basic/main/CMakeLists.txt create mode 100644 components/console_simple_init/examples/console_init-basic/main/console_init-basic.c create mode 100644 components/console_simple_init/examples/console_init-basic/main/idf_component.yml create mode 100644 components/console_simple_init/idf_component.yml diff --git a/.github/workflows/console_simple_init__build.yml b/.github/workflows/console_simple_init__build.yml new file mode 100644 index 00000000000..fcc4ce06b3a --- /dev/null +++ b/.github/workflows/console_simple_init__build.yml @@ -0,0 +1,32 @@ +name: "console_simple_init: build-tests" + +on: + push: + branches: + - master + pull_request: + types: [opened, synchronize, reopened, labeled] + +jobs: + build_console_simple_init: + if: contains(github.event.pull_request.labels.*.name, 'console_simple_init') || github.event_name == 'push' + name: Build + strategy: + matrix: + idf_ver: ["latest", "release-v5.0"] + idf_target: ["esp32"] + test: [ { app: example, path: "components/console_simple_init/examples" }] + runs-on: ubuntu-20.04 + container: espressif/idf:${{ matrix.idf_ver }} + steps: + - name: Checkout esp-protocols + uses: actions/checkout@v3 + with: + submodules: recursive + - name: Build ${{ matrix.test.app }} with IDF-${{ matrix.idf_ver }} for ${{ matrix.idf_target }} + shell: bash + working-directory: ${{matrix.test.path}} + run: | + ${IDF_PATH}/install.sh --enable-pytest + . ${IDF_PATH}/export.sh + python $IDF_PATH/tools/ci/ci_build_apps.py . --target ${{ matrix.idf_target }} -vv --preserve-all --pytest-app diff --git a/.github/workflows/publish-docs-component.yml b/.github/workflows/publish-docs-component.yml index 672e44aedaa..139c4531bf6 100644 --- a/.github/workflows/publish-docs-component.yml +++ b/.github/workflows/publish-docs-component.yml @@ -89,5 +89,6 @@ jobs: components/esp_mqtt_cxx; components/esp_websocket_client; components/mdns; + components/console_simple_init; namespace: "espressif" api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }} diff --git a/components/console_simple_init/CMakeLists.txt b/components/console_simple_init/CMakeLists.txt new file mode 100644 index 00000000000..a6d5a34a6d5 --- /dev/null +++ b/components/console_simple_init/CMakeLists.txt @@ -0,0 +1,3 @@ +idf_component_register(SRCS "console_simple_init.c" + INCLUDE_DIRS "." + PRIV_REQUIRES console) diff --git a/components/console_simple_init/LICENSE b/components/console_simple_init/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/components/console_simple_init/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/components/console_simple_init/README.md b/components/console_simple_init/README.md new file mode 100644 index 00000000000..30d01fedded --- /dev/null +++ b/components/console_simple_init/README.md @@ -0,0 +1,37 @@ +# Simple Console Initializer +The component provides a simple api's to initialize and start the esp console. +It also provides an api to register an user provided command. + +## API + +### Steps to enable console in an example code: +1. Add this component to your project using ```idf.py add-dependency``` command. +2. In the main file of the example, add the following line: + ```c + #include "console_simple_init.h" + ``` +3. Ensure NVS flash is initialized and default event loop is created in your app_main(): + ```c + ESP_ERROR_CHECK(esp_event_loop_create_default()); + esp_err_t ret = nvs_flash_init(); //Initialize NVS + if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) { + ESP_ERROR_CHECK(nvs_flash_erase()); + ret = nvs_flash_init(); + } + ESP_ERROR_CHECK(ret); + ``` +4. In your app_main() function, add the following line as the last line: + ```c + ESP_ERROR_CHECK(console_cmd_init()); // Initialize console + + // Define the function prototype for do_user_cmd + // It's a function that takes an integer (argc) and a pointer to a pointer to char (argv) + int do_user_cmd(int argc, char **argv); + + // Register the do_user_cmd function as a command callback function for "user" command + // This allows you to execute the do_user_cmd function when the "user" command is invoked + ESP_ERROR_CHECK(console_cmd_user_register("user", do_user_cmd)); + + + ESP_ERROR_CHECK(console_cmd_start()); // Start console + ``` diff --git a/components/console_simple_init/console_simple_init.c b/components/console_simple_init/console_simple_init.c new file mode 100644 index 00000000000..563ba297f5c --- /dev/null +++ b/components/console_simple_init/console_simple_init.c @@ -0,0 +1,63 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ +#include +#include "esp_console.h" +#include "esp_log.h" +#include "console_simple_init.h" + + +static esp_console_repl_t *repl = NULL; +static const char *TAG = "console_simple_init"; + +esp_err_t console_cmd_init(void) +{ + esp_console_repl_config_t repl_config = ESP_CONSOLE_REPL_CONFIG_DEFAULT(); + + // install console REPL environment +#if defined(CONFIG_ESP_CONSOLE_UART_DEFAULT) || defined(CONFIG_ESP_CONSOLE_UART_CUSTOM) + esp_console_dev_uart_config_t hw_config = ESP_CONSOLE_DEV_UART_CONFIG_DEFAULT(); + return esp_console_new_repl_uart(&hw_config, &repl_config, &repl); + +#elif defined(CONFIG_ESP_CONSOLE_USB_CDC) + esp_console_dev_usb_cdc_config_t hw_config = ESP_CONSOLE_DEV_CDC_CONFIG_DEFAULT(); + return esp_console_new_repl_usb_cdc(&hw_config, &repl_config, &repl); + +#elif defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) + esp_console_dev_usb_serial_jtag_config_t hw_config = ESP_CONSOLE_DEV_USB_SERIAL_JTAG_CONFIG_DEFAULT(); + return esp_console_new_repl_usb_serial_jtag(&hw_config, &repl_config, &repl); + +#else +#error Unsupported console type +#endif + +} + + +esp_err_t console_cmd_user_register(char *cmd, esp_console_cmd_func_t do_user_cmd) +{ + esp_err_t ret; + + const esp_console_cmd_t user_cmd = { + .command = cmd, + .help = "User defined command", + .hint = NULL, + .func = do_user_cmd, + }; + + ret = esp_console_cmd_register(&user_cmd); + if (ret) { + ESP_LOGE(TAG, "Unable to register user cmd"); + } + + return ret; +} + + +esp_err_t console_cmd_start(void) +{ + // start console REPL + return esp_console_start_repl(repl); +} diff --git a/components/console_simple_init/console_simple_init.h b/components/console_simple_init/console_simple_init.h new file mode 100644 index 00000000000..d2a97a41a7b --- /dev/null +++ b/components/console_simple_init/console_simple_init.h @@ -0,0 +1,23 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#pragma once + +#include "esp_err.h" +#include "esp_console.h" + +#ifdef __cplusplus +extern "C" { +#endif + +esp_err_t console_cmd_init(void); +esp_err_t console_cmd_user_register(char *user_cmd, esp_console_cmd_func_t do_user_cmd); +esp_err_t console_cmd_start(void); + + +#ifdef __cplusplus +} +#endif diff --git a/components/console_simple_init/examples/console_init-basic/CMakeLists.txt b/components/console_simple_init/examples/console_init-basic/CMakeLists.txt new file mode 100644 index 00000000000..0626211c4f4 --- /dev/null +++ b/components/console_simple_init/examples/console_init-basic/CMakeLists.txt @@ -0,0 +1,8 @@ +# For more information about build system see +# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html +# The following five lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.16) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(console_init-basic) diff --git a/components/console_simple_init/examples/console_init-basic/main/CMakeLists.txt b/components/console_simple_init/examples/console_init-basic/main/CMakeLists.txt new file mode 100644 index 00000000000..bbfb994ca6e --- /dev/null +++ b/components/console_simple_init/examples/console_init-basic/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "console_init-basic.c" + INCLUDE_DIRS ".") diff --git a/components/console_simple_init/examples/console_init-basic/main/console_init-basic.c b/components/console_simple_init/examples/console_init-basic/main/console_init-basic.c new file mode 100644 index 00000000000..9aaa29a633e --- /dev/null +++ b/components/console_simple_init/examples/console_init-basic/main/console_init-basic.c @@ -0,0 +1,37 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ +#include +#include "nvs_flash.h" +#include "esp_event.h" +#include "console_simple_init.h" + + +int do_user_cmd(int argc, char **argv) +{ + printf("Hello from user command\n"); + return 0; +} + +void app_main(void) +{ + ESP_ERROR_CHECK(esp_event_loop_create_default()); + esp_err_t ret = nvs_flash_init(); //Initialize NVS + if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) { + ESP_ERROR_CHECK(nvs_flash_erase()); + ret = nvs_flash_init(); + } + ESP_ERROR_CHECK(ret); + + // Initialize console REPL + ESP_ERROR_CHECK(console_cmd_init()); + + // Register user command + ESP_ERROR_CHECK(console_cmd_user_register("user", do_user_cmd)); + + // start console REPL + ESP_ERROR_CHECK(console_cmd_start()); + +} diff --git a/components/console_simple_init/examples/console_init-basic/main/idf_component.yml b/components/console_simple_init/examples/console_init-basic/main/idf_component.yml new file mode 100644 index 00000000000..16f87575c91 --- /dev/null +++ b/components/console_simple_init/examples/console_init-basic/main/idf_component.yml @@ -0,0 +1,6 @@ +dependencies: + idf: + version: '>=5.1' + console_simple_init: + version: "*" + override_path: '../../../' diff --git a/components/console_simple_init/idf_component.yml b/components/console_simple_init/idf_component.yml new file mode 100644 index 00000000000..302abd86e9a --- /dev/null +++ b/components/console_simple_init/idf_component.yml @@ -0,0 +1,6 @@ +version: 1.0.0 +url: https://github.com/espressif/esp-protocols/tree/master/components/console_simple_init +description: The component provides helper functions for easy initialization and start of esp console. +dependencies: + idf: + version: '>=5.0'