diff --git a/.github/workflows/console_cmd_ifconfig__build.yml b/.github/workflows/console_cmd_ifconfig__build.yml new file mode 100644 index 00000000000..8d94314a9a2 --- /dev/null +++ b/.github/workflows/console_cmd_ifconfig__build.yml @@ -0,0 +1,32 @@ +name: "console_cmd_ifconfig: build-tests" + +on: + push: + branches: + - master + pull_request: + types: [opened, synchronize, reopened, labeled] + +jobs: + build_console_cmd_ifconfig: + if: contains(github.event.pull_request.labels.*.name, 'console') || github.event_name == 'push' + name: Build + strategy: + matrix: + idf_ver: ["latest", "release-v5.0"] + idf_target: ["esp32"] + test: [ { app: example, path: "components/console_cmd_ifconfig/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/console_cmd_ping__build.yml b/.github/workflows/console_cmd_ping__build.yml new file mode 100644 index 00000000000..a6729f0ff33 --- /dev/null +++ b/.github/workflows/console_cmd_ping__build.yml @@ -0,0 +1,32 @@ +name: "console_cmd_ping: build-tests" + +on: + push: + branches: + - master + pull_request: + types: [opened, synchronize, reopened, labeled] + +jobs: + build_console_cmd_ping: + if: contains(github.event.pull_request.labels.*.name, 'console') || github.event_name == 'push' + name: Build + strategy: + matrix: + idf_ver: ["latest", "release-v5.0"] + idf_target: ["esp32"] + test: [ { app: example, path: "components/console_cmd_ping/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 f62c60b5742..43eec0ee39a 100644 --- a/.github/workflows/publish-docs-component.yml +++ b/.github/workflows/publish-docs-component.yml @@ -94,5 +94,7 @@ jobs: components/esp_websocket_client; components/mdns; components/console_simple_init; + components/console_cmd_ifconfig; + components/console_cmd_ping; namespace: "espressif" api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }} diff --git a/components/console_cmd_ifconfig/.cz.yaml b/components/console_cmd_ifconfig/.cz.yaml new file mode 100644 index 00000000000..21a4aa99855 --- /dev/null +++ b/components/console_cmd_ifconfig/.cz.yaml @@ -0,0 +1,8 @@ +--- +commitizen: + bump_message: 'bump(console): $current_version -> $new_version' + pre_bump_hooks: python ../../ci/changelog.py console_cmd_ifconfig + tag_format: console_cmd_ifconfig-v$version + version: 0.0.9 + version_files: + - idf_component.yml diff --git a/components/console_cmd_ifconfig/CMakeLists.txt b/components/console_cmd_ifconfig/CMakeLists.txt index 6be427437a9..146e894443d 100644 --- a/components/console_cmd_ifconfig/CMakeLists.txt +++ b/components/console_cmd_ifconfig/CMakeLists.txt @@ -1,4 +1,3 @@ -idf_component_register(SRCS "console_connect.c" "console_ifconfig.c" - INCLUDE_DIRS "include" - REQUIRES "ethernet_init" - PRIV_REQUIRES esp_netif console nvs_flash esp_eth) +idf_component_register(SRCS "console_ifconfig.c" + INCLUDE_DIRS "." + PRIV_REQUIRES esp_netif console esp_eth) diff --git a/components/console_cmd_ifconfig/Kconfig.projbuild b/components/console_cmd_ifconfig/Kconfig.projbuild deleted file mode 100644 index e93b6a1ea72..00000000000 --- a/components/console_cmd_ifconfig/Kconfig.projbuild +++ /dev/null @@ -1,18 +0,0 @@ -menu "Enable console commands" - - orsource "$IDF_PATH/examples/common_components/env_caps/$IDF_TARGET/Kconfig.env_caps" - - config EXAMPLE_CMD_QUIT - bool - prompt "quit" - default y - config EXAMPLE_CMD_IFCONFIG - bool - prompt "ifconfig" - default y - config EXAMPLE_CMD_PING - bool - prompt "ping" - default n - -endmenu diff --git a/components/console_cmd_ifconfig/LICENSE b/components/console_cmd_ifconfig/LICENSE index b91d0069748..261eeb9e9f8 100644 --- a/components/console_cmd_ifconfig/LICENSE +++ b/components/console_cmd_ifconfig/LICENSE @@ -1 +1,201 @@ -console_cmd_ifconfig/LICENSE + 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_cmd_ifconfig/README.md b/components/console_cmd_ifconfig/README.md index f304b6b7ca0..d483c690510 100644 --- a/components/console_cmd_ifconfig/README.md +++ b/components/console_cmd_ifconfig/README.md @@ -1,57 +1,53 @@ # Console command ifconfig -The component offers a console that enables runtime network interface configuration and monitoring for any example project. +The component offers a console with a command that enables runtime network interface configuration and monitoring for any example project. ## API ### Steps to enable console in an example code: -1. Add this component to your project using the command: - ```bash - idf.py add-dependency - ``` +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_connect.h" + #include "console_ifconfig.h" ``` -3. Ensure esp-netif is initialized and default event loop is created in your app_main(): +3. Ensure esp-netif and NVS flash is initialized and default event loop is created in your app_main(): ```c ESP_ERROR_CHECK(esp_netif_init()); 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 - example_start_networking_console(NULL, NULL); - ``` -5. Optionally, you can add a user-defined command: - ```c - example_start_networking_console("user_cmd", usr_cmd_hndl); - ``` - In the above line, "user_cmd" is a string representing the user-defined command name, and usr_cmd_hndl is the command callback function with the prototype. - ```c - int usr_cmd_hndl(int argc, char **argv) + ESP_ERROR_CHECK(console_cmd_init()); // Initialize console + ESP_ERROR_CHECK(console_cmd_ifconfig_register()); + ESP_ERROR_CHECK(console_cmd_start()); // Start console ``` -## Suported commands: +## Suported command: ### Ifconfig: -* **ifconfig help:** Prints the help text for all ifconfig commands -* **ifconfig netif create/destroy \/\:** Create or destroy a network interface with the specified ethernet handle or interface name -* **ifconfig eth show:** Display a list of available ethernet handle -* **ifconfig:** Display a list of all esp_netif interfaces along with their information. -* **ifconfig \:** Provide the details of the named interface. -* **ifconfig \ default:** Set the specified interface as the default interface. -* **ifconfig \ ip6:** Enable IPv6 on the specified interface. -* **ifconfig up:** Enable the specified interface. -* **ifconfig down:** Disable the specified interface. -* **ifconfig \ link \:** Enable or disable the link of the specified interface. -* **ifconfig \ ip \:** Set the IPv4 address of the specified interface. -* **ifconfig \ mask \:** Set the subnet mask of the specified interface. -* **ifconfig \ gw \:** Set the default gateway of the specified interface. -* **ifconfig \ napt \:** Enable or disable Network Address and Port Translation (NAPT) on the specified interface. -* **ifconfig \ dhcp server \:** Enable or disable the DHCP server on the specified interface. (Note: DHCP server is not supported yet) -* **ifconfig \ dhcp client \:** Enable or disable the DHCP client on the specified interface. - +``` + ifconfig help: Prints the help text for all ifconfig commands + ifconfig netif create/destroy /: Create or destroy a network interface with the specified ethernet handle or interface name + ifconfig eth init/deinit/show: Initialize, deinitialize and display a list of available ethernet handle + ifconfig: Display a list of all esp_netif interfaces along with their information + ifconfig : Provide the details of the named interface + ifconfig default: Set the specified interface as the default interface + ifconfig ip6: Enable IPv6 on the specified interface + ifconfig up: Enable the specified interface + ifconfig down: Disable the specified interface + ifconfig link : Enable or disable the link of the specified interface + ifconfig napt : Enable or disable NAPT on the specified interface. + ifconfig ip : Set the IPv4 address of the specified interface + ifconfig mask : Set the subnet mask of the specified interface + ifconfig gw : Set the default gateway of the specified interface + ifconfig staticip: Enables static ip + ifconfig dhcp server : Enable or disable the DHCP server.(Note: DHCP server is not supported yet) + ifconfig dhcp client : Enable or disable the DHCP client. Note: Disabling the DHCP server and client enables the use of static IP configuration. - -### Quit: -**quit:** Quits the Console application. +``` diff --git a/components/console_cmd_ifconfig/console_connect.c b/components/console_cmd_ifconfig/console_connect.c deleted file mode 100644 index 6290a8dea2e..00000000000 --- a/components/console_cmd_ifconfig/console_connect.c +++ /dev/null @@ -1,96 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD - * - * SPDX-License-Identifier: Apache-2.0 - */ -#include -#include -#include "sdkconfig.h" -#include "lwip/inet.h" -#include "lwip/netdb.h" -#include "lwip/sockets.h" -#include "esp_netif.h" -#include "esp_console.h" -#include "esp_event.h" -#include "nvs_flash.h" -#include "argtable3/argtable3.h" -#include "esp_log.h" -#include "esp_netif_net_stack.h" -#include "lwip/ip6.h" -#include "lwip/opt.h" -#if IP_NAPT -#include "lwip/lwip_napt.h" -#endif -#include "console_connect.h" -#include "console_ifconfig.h" - -static const char *TAG = "console_connect"; - -static esp_console_repl_t *s_repl = NULL; - -/* handle 'quit' command */ -static int do_cmd_quit(int argc, char **argv) -{ - printf("Bye Bye\n\r\n"); - s_repl->del(s_repl); - return 0; -} - -static esp_console_cmd_t register_quit(void) -{ - esp_console_cmd_t command = { - .command = "quit", - .help = "Quit REPL environment", - .func = &do_cmd_quit - }; - return command; -} - - -esp_err_t example_start_networking_console(char *usr_cmd, int (*usr_cmd_hndl)(int argc, char **argv)) -{ - esp_console_repl_config_t repl_config = ESP_CONSOLE_REPL_CONFIG_DEFAULT(); - esp_console_cmd_t command; - - // Initialize TCP/IP network interface aka the esp-netif (should be called only once in application) - //ESP_ERROR_CHECK(esp_netif_init()); - // Create default event loop that running in background - //ESP_ERROR_CHECK(esp_event_loop_create_default()); - - // install console REPL environment -#if CONFIG_ESP_CONSOLE_UART - esp_console_dev_uart_config_t uart_config = ESP_CONSOLE_DEV_UART_CONFIG_DEFAULT(); - ESP_ERROR_CHECK(esp_console_new_repl_uart(&uart_config, &repl_config, &s_repl)); -#endif - -#if CONFIG_EXAMPLE_CMD_IFCONFIG - /* register command `ifconfig` */ - command = register_ifconfig(); - if (esp_console_cmd_register(&command)) { - ESP_LOGE(TAG, "Unable to register ifconfig"); - } -#endif - -#if CONFIG_EXAMPLE_CMD_QUIT - /* register command `quit` */ - command = register_quit(); - if (esp_console_cmd_register(&command)) { - ESP_LOGE(TAG, "Unable to register quit"); - } -#endif - - /* Register command from caller */ - if ((usr_cmd_hndl != NULL) && (usr_cmd != NULL)) { - esp_console_cmd_t command = { - .command = usr_cmd, - .help = "user command", - .func = usr_cmd_hndl - }; - if (esp_console_cmd_register(&command) != ESP_OK) { - ESP_LOGE(TAG, "Unable to register user command"); - } - } - - // start console REPL - return esp_console_start_repl(s_repl); -} diff --git a/components/console_cmd_ifconfig/console_ifconfig.c b/components/console_cmd_ifconfig/console_ifconfig.c index f40bf548b2c..3f9f068a43a 100644 --- a/components/console_cmd_ifconfig/console_ifconfig.c +++ b/components/console_cmd_ifconfig/console_ifconfig.c @@ -13,7 +13,6 @@ #include "esp_eth.h" #include "esp_console.h" #include "esp_event.h" -#include "nvs_flash.h" #include "argtable3/argtable3.h" #include "esp_log.h" #include "esp_netif_net_stack.h" @@ -42,7 +41,7 @@ esp_err_t ifcfg_lwip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp esp_err_t ifcfg_basic_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); esp_err_t ifcfg_ip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); esp_err_t ifcfg_napt_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); -esp_err_t ifcfg_dhcp_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); +esp_err_t ifcfg_addr_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); esp_err_t ifcfg_netif_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); esp_err_t ifcfg_eth_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); @@ -51,7 +50,7 @@ static const char *TAG = "console_ifconfig"; netif_op cmd_list[] = { {.name = "help", .operation = ifcfg_help_op, .arg_cnt = 2, .start_index = 1, .netif_flag = false, .help = "ifconfig help: Prints the help text for all ifconfig commands"}, {.name = "netif", .operation = ifcfg_netif_op, .arg_cnt = 4, .start_index = 1, .netif_flag = false, .help = "ifconfig netif create/destroy /: Create or destroy a network interface with the specified ethernet handle or interface name"}, - {.name = "eth", .operation = ifcfg_eth_op, .arg_cnt = 3, .start_index = 1, .netif_flag = false, .help = "ifconfig eth show: Display a list of available ethernet handle"}, + {.name = "eth", .operation = ifcfg_eth_op, .arg_cnt = 3, .start_index = 1, .netif_flag = false, .help = "ifconfig eth init/deinit/show: Initialize, deinitialize and display a list of available ethernet handle"}, {.name = "ifconfig", .operation = ifcfg_print_op, .arg_cnt = 1, .start_index = 0, .netif_flag = false, .help = "ifconfig: Display a list of all esp_netif interfaces along with their information"}, {.name = "ifconfig", .operation = ifcfg_print_op, .arg_cnt = 2, .start_index = 0, .netif_flag = true, .help = "ifconfig : Provide the details of the named interface"}, {.name = "default", .operation = ifcfg_basic_op, .arg_cnt = 3, .start_index = 2, .netif_flag = true, .help = "ifconfig default: Set the specified interface as the default interface"}, @@ -59,11 +58,12 @@ netif_op cmd_list[] = { {.name = "up", .operation = ifcfg_lwip_op, .arg_cnt = 3, .start_index = 2, .netif_flag = true, .help = "ifconfig up: Enable the specified interface"}, {.name = "down", .operation = ifcfg_lwip_op, .arg_cnt = 3, .start_index = 2, .netif_flag = true, .help = "ifconfig down: Disable the specified interface"}, {.name = "link", .operation = ifcfg_lwip_op, .arg_cnt = 4, .start_index = 2, .netif_flag = true, .help = "ifconfig link : Enable or disable the link of the specified interface"}, + {.name = "napt", .operation = ifcfg_napt_op, .arg_cnt = 4, .start_index = 2, .netif_flag = true, .help = "ifconfig napt : Enable or disable NAPT on the specified interface."}, {.name = "ip", .operation = ifcfg_ip_op, .arg_cnt = 4, .start_index = 2, .netif_flag = true, .help = "ifconfig ip : Set the IPv4 address of the specified interface"}, {.name = "mask", .operation = ifcfg_ip_op, .arg_cnt = 4, .start_index = 2, .netif_flag = true, .help = "ifconfig mask : Set the subnet mask of the specified interface"}, {.name = "gw", .operation = ifcfg_ip_op, .arg_cnt = 4, .start_index = 2, .netif_flag = true, .help = "ifconfig gw : Set the default gateway of the specified interface"}, - {.name = "napt", .operation = ifcfg_napt_op, .arg_cnt = 4, .start_index = 2, .netif_flag = true, .help = "ifconfig napt : Enable or disable NAPT on the specified interface."}, - {.name = "dhcp", .operation = ifcfg_dhcp_op, .arg_cnt = 5, .start_index = 2, .netif_flag = true, .help = "ifconfig dhcp server : Enable or disable the DHCP server.(Note: DHCP server is not supported yet)\n ifconfig dhcp client : Enable or disable the DHCP client\nNote: Disabling the DHCP server and client enables the use of static IP configuration."}, + {.name = "staticip", .operation = ifcfg_addr_op, .arg_cnt = 3, .start_index = 2, .netif_flag = true, .help = "ifconfig staticip: Enables static ip"}, + {.name = "dhcp", .operation = ifcfg_addr_op, .arg_cnt = 5, .start_index = 2, .netif_flag = true, .help = "ifconfig dhcp server : Enable or disable the DHCP server.(Note: DHCP server is not supported yet)\n ifconfig dhcp client : Enable or disable the DHCP client.\nNote: Disabling the DHCP server and client enables the use of static IP configuration."}, }; @@ -164,10 +164,9 @@ esp_err_t ifcfg_lwip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp esp_err_t ifcfg_ip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) { - esp_netif_ip_info_t ip_info; + esp_netif_ip_info_t ip_info = {0}; esp_netif_dhcpc_stop(esp_netif); - memset(&ip_info, 0, sizeof(esp_netif_ip_info_t)); esp_netif_get_ip_info(esp_netif, &ip_info); if (!strcmp("ip", argv[self->start_index])) { @@ -176,17 +175,13 @@ esp_err_t ifcfg_ip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_n inet_aton(argv[self->start_index + 1], &ip_info.ip.addr); esp_netif_set_ip_info(esp_netif, &ip_info); return ESP_OK; - } - - if (!strcmp("mask", argv[self->start_index])) { + } else if (!strcmp("mask", argv[self->start_index])) { ESP_LOGI(TAG, "Setting mask: %s", argv[self->start_index + 1]); inet_aton(argv[self->start_index + 1], &ip_info.netmask.addr); esp_netif_set_ip_info(esp_netif, &ip_info); return ESP_OK; - } - - if (!strcmp("gw", argv[self->start_index])) { + } else if (!strcmp("gw", argv[self->start_index])) { ESP_LOGI(TAG, "Setting gw: %s", argv[self->start_index + 1]); inet_aton(argv[self->start_index + 1], &ip_info.gw.addr); @@ -249,10 +244,13 @@ esp_err_t ifcfg_napt_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp } -esp_err_t ifcfg_dhcp_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +esp_err_t ifcfg_addr_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) { - /* Server */ - if (!strcmp("server", argv[self->start_index + 1])) { + if (!strcmp("staticip", argv[self->start_index])) { + esp_netif_dhcpc_stop(esp_netif); + //esp_netif_dhcps_stop(esp_netif); + return ESP_OK; + } else if (!strcmp("server", argv[self->start_index + 1])) { // Server if (!strcmp("enable", argv[self->start_index + 2])) { ESP_LOGW(TAG, "DHCP Server configuration is not supported yet."); // TBD //esp_netif_dhcps_start(esp_netif); @@ -261,24 +259,22 @@ esp_err_t ifcfg_dhcp_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp ESP_LOGW(TAG, "DHCP Server configuration is not supported yet."); // TBD //esp_netif_dhcps_stop(esp_netif); return ESP_OK; - } else { - ESP_LOGE(TAG, "Invalid argument"); - return ESP_FAIL; } - } - /* Client */ - if (!strcmp("client", argv[self->start_index + 1])) { + ESP_LOGE(TAG, "Invalid argument"); + return ESP_FAIL; + + } else if (!strcmp("client", argv[self->start_index + 1])) { // Client if (!strcmp("enable", argv[self->start_index + 2])) { esp_netif_dhcpc_start(esp_netif); return ESP_OK; } else if (!strcmp("disable", argv[self->start_index + 2])) { esp_netif_dhcpc_stop(esp_netif); return ESP_OK; - } else { - ESP_LOGE(TAG, "Invalid argument"); - return ESP_FAIL; } + + ESP_LOGE(TAG, "Invalid argument"); + return ESP_FAIL; } return ESP_FAIL; @@ -304,11 +300,15 @@ void print_iface_details(esp_netif_t *esp_netif) return; } +#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 0) if (esp_netif_get_default_netif() == esp_netif) { ESP_LOGI(TAG, "Interface Name: %s (DEF)", interface); } else { ESP_LOGI(TAG, "Interface Name: %s", interface); } +#else + ESP_LOGI(TAG, "Interface Name: %s", interface); +#endif ESP_LOGI(TAG, "Interface Number: %d", lwip_netif->num); /* Print MAC address */ @@ -318,7 +318,7 @@ void print_iface_details(esp_netif_t *esp_netif) /* Print DHCP status */ if (ESP_OK == esp_netif_dhcps_get_status(esp_netif, &status)) { - ESP_LOGI(TAG, "DHCP Server Status: %d", status); + ESP_LOGI(TAG, "DHCP Server Status: %s", status ? "enabled" : "disabled"); } else if ((ESP_OK == esp_netif_dhcpc_get_status(esp_netif, &status))) { if (ESP_NETIF_DHCP_STOPPED == status) { ESP_LOGI(TAG, "Static IP"); @@ -370,18 +370,27 @@ esp_err_t ifcfg_print_op(netif_op *self, int argc, char *argv[], esp_netif_t *es /* Maximum number of interface that can be added */ #define MAX_ETH_NETIF_COUNT (10) -typedef struct { - esp_netif_t *esp_netif[MAX_ETH_NETIF_COUNT]; - uint8_t created_flag[MAX_ETH_NETIF_COUNT]; - uint8_t netif_count; -} esp_netif_list; +typedef enum { + UNINITIALIZED = 0, + ETH_INITIALIZED = 1, + NETIF_CREATED = 2, + NETIF_DESTROYED = 3, + ETH_DEINITIALIZED = 4 +} iface_state; +typedef struct { + esp_netif_t *esp_netif; + esp_eth_handle_t *eth_handle; + esp_eth_netif_glue_handle_t eth_glue; + iface_state state; +} iface_desc; + +iface_desc iface_list[MAX_ETH_NETIF_COUNT]; +uint8_t netif_count; uint8_t eth_init_flag = false; -uint8_t eth_port_cnt = 0; -esp_eth_handle_t *eth_handle = NULL; +uint8_t eth_port_cnt_g = 0; - -esp_err_t get_netif_config(uint16_t id, esp_netif_config_t *eth_cfg_o) +static esp_err_t get_netif_config(uint16_t id, esp_netif_config_t *eth_cfg_o) { /* Create new default instance of esp-netif for Ethernet */ char *if_key; @@ -404,7 +413,7 @@ esp_err_t get_netif_config(uint16_t id, esp_netif_config_t *eth_cfg_o) } -void free_config(esp_netif_config_t *eth_cfg) +static void free_config(esp_netif_config_t *eth_cfg) { if ((NULL != eth_cfg) && (NULL != eth_cfg->base)) { free((void *)(eth_cfg->base->if_key)); @@ -415,40 +424,41 @@ void free_config(esp_netif_config_t *eth_cfg) esp_err_t ifcfg_netif_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) { - static esp_netif_list netif_list; int eth_handle_id = atoi(argv[self->start_index + 2]); if (!strcmp(argv[self->start_index + 1], "create")) { /* Validate ethernet handle */ - if ((eth_handle_id + 1 > eth_port_cnt) || (eth_handle_id < 0)) { + if ((eth_handle_id + 1 > eth_port_cnt_g) || (eth_handle_id < 0)) { ESP_LOGE(TAG, "Invalid ethernet handle: %s", argv[self->start_index + 2]); return ESP_FAIL; } - esp_netif_config_t eth_cfg = ESP_NETIF_DEFAULT_ETH(); + + esp_netif_config_t eth_cfg; ESP_ERROR_CHECK(get_netif_config(eth_handle_id, ð_cfg)); for (int i = 0; i < MAX_ETH_NETIF_COUNT; i++) { - if (netif_list.created_flag[i] == 0) { + if (iface_list[i].state == ETH_INITIALIZED) { esp_netif = esp_netif_new(ð_cfg); if (esp_netif == NULL) { ESP_LOGE(TAG, "Interface with key %s already exists", argv[self->start_index + 2]); return ESP_FAIL; } - netif_list.esp_netif[i] = esp_netif; - netif_list.created_flag[i] = 1; - netif_list.netif_count++; - esp_eth_netif_glue_handle_t eth_glue = esp_eth_new_netif_glue(eth_handle[eth_handle_id]); - if (eth_glue == NULL) { + iface_list[i].eth_glue = esp_eth_new_netif_glue(iface_list[i].eth_handle); + if (iface_list[i].eth_glue == NULL) { ESP_LOGE(TAG, "%s: eth_glue is NULL", __func__); + esp_netif_destroy(esp_netif); + return ESP_FAIL; } - ESP_ERROR_CHECK(esp_netif_attach(netif_list.esp_netif[i], eth_glue)); - sleep(10); + iface_list[i].esp_netif = esp_netif; + ESP_ERROR_CHECK(esp_netif_attach(iface_list[i].esp_netif, iface_list[i].eth_glue)); // start Ethernet driver state machine - ESP_ERROR_CHECK(esp_eth_start(eth_handle[eth_handle_id])); + ESP_ERROR_CHECK(esp_eth_start(iface_list[i].eth_handle)); free_config(ð_cfg); + iface_list[i].state = NETIF_CREATED; + netif_count++; break; } } @@ -462,40 +472,108 @@ esp_err_t ifcfg_netif_op(netif_op *self, int argc, char *argv[], esp_netif_t *es } for (int i = 0; i < MAX_ETH_NETIF_COUNT; i++) { - if (esp_netif == netif_list.esp_netif[i]) { - netif_list.created_flag[i] = 0; + if (esp_netif == iface_list[i].esp_netif) { + if (iface_list[i].state == NETIF_CREATED) { + esp_eth_stop(iface_list[i].eth_handle); + esp_eth_del_netif_glue(iface_list[i].eth_glue); + esp_netif_destroy(iface_list[i].esp_netif); + iface_list[i].state = NETIF_DESTROYED; + netif_count--; + return ESP_OK; + } else { + ESP_LOGE(TAG, "Netif is not in created state"); + return ESP_FAIL; + } break; } } - esp_netif_destroy(esp_netif); - netif_list.netif_count--; - return ESP_OK; + ESP_LOGE(TAG, "Something is very wrong. Unauthorized Interface."); + return ESP_FAIL; } return ESP_FAIL; } +static void print_eth_info(eth_dev_info_t eth_info, int id) +{ + if (eth_info.type == ETH_DEV_TYPE_INTERNAL_ETH) { + printf("Internal(%s): pins: %2d,%2d, Id: %d\n", eth_info.name, eth_info.pin.eth_internal_mdc, eth_info.pin.eth_internal_mdio, id); + } else if (eth_info.type == ETH_DEV_TYPE_SPI) { + printf(" SPI(%s): pins: %2d,%2d, Id: %d\n", eth_info.name, eth_info.pin.eth_spi_cs, eth_info.pin.eth_spi_int, id); + } else { + printf("ethernet handle id(ETH_DEV_TYPE_UNKNOWN): %d\n", id); + } +} + + esp_err_t ifcfg_eth_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) { - if (!strcmp(argv[self->start_index + 1], "show")) { + static esp_eth_handle_t *eth_handle_g = NULL; + eth_dev_info_t eth_info; + + if (!strcmp(argv[self->start_index + 1], "init")) { /* Check if ethernet is initialized */ if (eth_init_flag == false) { // Initialize Ethernet driver - if (ethernet_init(ð_handle, ð_port_cnt) != ESP_OK) { + if (ethernet_init_all(ð_handle_g, ð_port_cnt_g) != ESP_OK) { ESP_LOGE(TAG, "Unable to initialize ethernet"); return ESP_FAIL; } eth_init_flag = true; + + for (int i = 0; i < eth_port_cnt_g; i++) { + for (int j = 0; j < MAX_ETH_NETIF_COUNT; j++) { + if (iface_list[j].state == UNINITIALIZED) { + iface_list[j].eth_handle = eth_handle_g[i]; + iface_list[j].state = ETH_INITIALIZED; + break; + } + } + } + + if (eth_port_cnt_g > MAX_ETH_NETIF_COUNT) { + ESP_LOGW(TAG, "Not all ethernet ports can be assigned a network interface.\nPlease reconfigure MAX_ETH_NETIF_COUNT to a higher value."); + } + + } else { + ESP_LOGW(TAG, "Ethernet already initialized"); } /* Display available ethernet handles */ - for (int i = 0; i < eth_port_cnt; i++) { - printf("ethernet handle id: %d\n", i); + for (int i = 0; i < eth_port_cnt_g; i++) { + eth_info = ethernet_init_get_dev_info(iface_list[i].eth_handle); + print_eth_info(eth_info, i); + } + } else if (!strcmp(argv[self->start_index + 1], "show")) { + /* Check if ethernet is initialized */ + if (eth_init_flag == false) { + // Initialize Ethernet driver + ESP_LOGE(TAG, "Ethernet is not initialized."); + return ESP_OK; } + /* Display available ethernet handles */ + for (int i = 0; i < eth_port_cnt_g; i++) { + eth_info = ethernet_init_get_dev_info(iface_list[i].eth_handle); + print_eth_info(eth_info, i); + } + } else if (!strcmp(argv[self->start_index + 1], "deinit")) { + /* Check if ethernet is initialized */ + if (eth_init_flag == false) { + // Initialize Ethernet driver + ESP_LOGE(TAG, "Ethernet is not initialized."); + return ESP_OK; + } + + /* Stop and Deinit ethernet here */ + ethernet_deinit_all(eth_handle_g); + eth_port_cnt_g = 0; + eth_init_flag = false; + } else { + return ESP_FAIL; } return ESP_OK; @@ -533,7 +611,6 @@ static int do_cmd_ifconfig(int argc, char **argv) ESP_LOGE(TAG, "Usage:\n%s", cmd.help); return 0; } - } return 0; } @@ -546,13 +623,25 @@ static int do_cmd_ifconfig(int argc, char **argv) } -esp_console_cmd_t register_ifconfig(void) +/** + * @brief Registers the ifconfig command. + * + * @return + * - esp_err_t + */ +esp_err_t console_cmd_ifconfig_register(void) { + esp_err_t ret; esp_console_cmd_t command = { .command = "ifconfig", .help = "Command for network interface configuration and monitoring\nFor more info run 'ifconfig help'", .func = &do_cmd_ifconfig }; - return command; + ret = esp_console_cmd_register(&command); + if (ret) { + ESP_LOGE(TAG, "Unable to register ifconfig"); + } + + return ret; } diff --git a/components/console_cmd_ifconfig/console_ifconfig.h b/components/console_cmd_ifconfig/console_ifconfig.h index 8feacfc318c..915b60c9e00 100644 --- a/components/console_cmd_ifconfig/console_ifconfig.h +++ b/components/console_cmd_ifconfig/console_ifconfig.h @@ -4,4 +4,13 @@ * SPDX-License-Identifier: Apache-2.0 */ -esp_console_cmd_t register_ifconfig(void); +#include "console_simple_init.h" + + +/** + * @brief Registers the ifconfig command. + * + * @return + * - esp_err_t + */ +esp_err_t console_cmd_ifconfig_register(void); diff --git a/components/console_cmd_ifconfig/examples/ifconfig-basic/CMakeLists.txt b/components/console_cmd_ifconfig/examples/ifconfig-basic/CMakeLists.txt new file mode 100644 index 00000000000..9654dec5656 --- /dev/null +++ b/components/console_cmd_ifconfig/examples/ifconfig-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(ifconfig-basic) diff --git a/components/console_cmd_ifconfig/examples/ifconfig-basic/main/CMakeLists.txt b/components/console_cmd_ifconfig/examples/ifconfig-basic/main/CMakeLists.txt new file mode 100644 index 00000000000..abd01acc4cb --- /dev/null +++ b/components/console_cmd_ifconfig/examples/ifconfig-basic/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "ifconfig-basic.c" + INCLUDE_DIRS ".") diff --git a/components/console_cmd_ifconfig/examples/ifconfig-basic/main/idf_component.yml b/components/console_cmd_ifconfig/examples/ifconfig-basic/main/idf_component.yml new file mode 100644 index 00000000000..212535fe8cb --- /dev/null +++ b/components/console_cmd_ifconfig/examples/ifconfig-basic/main/idf_component.yml @@ -0,0 +1,6 @@ +dependencies: + idf: + version: '*' + console_cmd_ifconfig: + version: "*" + override_path: '../../../' diff --git a/components/console_cmd_ifconfig/examples/ifconfig-basic/main/ifconfig-basic.c b/components/console_cmd_ifconfig/examples/ifconfig-basic/main/ifconfig-basic.c new file mode 100644 index 00000000000..e02bc3411df --- /dev/null +++ b/components/console_cmd_ifconfig/examples/ifconfig-basic/main/ifconfig-basic.c @@ -0,0 +1,33 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ +#include +#include "esp_netif.h" +#include "nvs_flash.h" +#include "esp_netif.h" +#include "esp_event.h" +#include "console_ifconfig.h" + + +void app_main(void) +{ + ESP_ERROR_CHECK(esp_netif_init()); + 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()); + + ESP_ERROR_CHECK(console_cmd_ifconfig_register()); + + // start console REPL + ESP_ERROR_CHECK(console_cmd_start()); + +} diff --git a/components/console_cmd_ifconfig/examples/ifconfig-basic/pytest_ifconfig-basic.py b/components/console_cmd_ifconfig/examples/ifconfig-basic/pytest_ifconfig-basic.py new file mode 100644 index 00000000000..d9af3f83565 --- /dev/null +++ b/components/console_cmd_ifconfig/examples/ifconfig-basic/pytest_ifconfig-basic.py @@ -0,0 +1,21 @@ +# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD +# SPDX-License-Identifier: Unlicense OR CC0-1.0 + +# -*- coding: utf-8 -*- +import pytest + + +@pytest.mark.esp32 +def test_examples_ifconfig_command(dut): + dut.expect('esp>', timeout=30) + dut.write('ifconfig eth init') + dut.expect(r'Internal\(IP101\): pins:', timeout=30) + dut.write('ifconfig netif create 0') + dut.expect(r'ethernet_init: Ethernet\(IP101\[23,18\]\) Link Up', timeout=30) + dut.write('ifconfig') + dut.expect('console_ifconfig: Interface Name: en1', timeout=5) + dut.write('ifconfig netif destroy en1') + dut.expect('esp>', timeout=5) + dut.write('ifconfig eth deinit') + dut.expect('esp>', timeout=5) + pass diff --git a/components/console_cmd_ifconfig/examples/ifconfig-basic/pytest_ifconfig_basic.py b/components/console_cmd_ifconfig/examples/ifconfig-basic/pytest_ifconfig_basic.py new file mode 100644 index 00000000000..d9af3f83565 --- /dev/null +++ b/components/console_cmd_ifconfig/examples/ifconfig-basic/pytest_ifconfig_basic.py @@ -0,0 +1,21 @@ +# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD +# SPDX-License-Identifier: Unlicense OR CC0-1.0 + +# -*- coding: utf-8 -*- +import pytest + + +@pytest.mark.esp32 +def test_examples_ifconfig_command(dut): + dut.expect('esp>', timeout=30) + dut.write('ifconfig eth init') + dut.expect(r'Internal\(IP101\): pins:', timeout=30) + dut.write('ifconfig netif create 0') + dut.expect(r'ethernet_init: Ethernet\(IP101\[23,18\]\) Link Up', timeout=30) + dut.write('ifconfig') + dut.expect('console_ifconfig: Interface Name: en1', timeout=5) + dut.write('ifconfig netif destroy en1') + dut.expect('esp>', timeout=5) + dut.write('ifconfig eth deinit') + dut.expect('esp>', timeout=5) + pass diff --git a/components/console_cmd_ifconfig/idf_component.yml b/components/console_cmd_ifconfig/idf_component.yml index f935a0c2898..8c891ce7de8 100644 --- a/components/console_cmd_ifconfig/idf_component.yml +++ b/components/console_cmd_ifconfig/idf_component.yml @@ -1,8 +1,10 @@ -version: 0.0.4 -url: https://github.com/espressif-abhikroy/esp-protocols/tree/components/console_cmd_ifconfig/components/console_cmd_ifconfig +version: 0.0.9 +url: https://github.com/espressif/esp-protocols/tree/master/components/console_cmd_ifconfig description: The component offers a console that enables runtime network interface configuration and monitoring. dependencies: idf: - version: '>=4.1' - ethernet_init: - version: '>=0.0.1' + version: '>=5.0' + espressif/console_simple_init: + version: '>=1.0.2' + espressif/ethernet_init: + version: '>=0.0.7' diff --git a/components/console_cmd_ifconfig/include/console_connect.h b/components/console_cmd_ifconfig/include/console_connect.h deleted file mode 100644 index 20ad6dfc6d8..00000000000 --- a/components/console_cmd_ifconfig/include/console_connect.h +++ /dev/null @@ -1,7 +0,0 @@ - -/* - * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD - * - * SPDX-License-Identifier: Apache-2.0 - */ -esp_err_t example_start_networking_console(char *usr_cmd, int (*usr_cmd_hndl)(int argc, char **argv)); diff --git a/components/console_cmd_ping/.cz.yaml b/components/console_cmd_ping/.cz.yaml new file mode 100644 index 00000000000..85b1596a10f --- /dev/null +++ b/components/console_cmd_ping/.cz.yaml @@ -0,0 +1,8 @@ +--- +commitizen: + bump_message: 'bump(console): $current_version -> $new_version' + pre_bump_hooks: python ../../ci/changelog.py console_cmd_ping + tag_format: console_cmd_ping-v$version + version: 0.0.9 + version_files: + - idf_component.yml diff --git a/components/console_cmd_ping/CMakeLists.txt b/components/console_cmd_ping/CMakeLists.txt new file mode 100644 index 00000000000..5d6d6435f8a --- /dev/null +++ b/components/console_cmd_ping/CMakeLists.txt @@ -0,0 +1,3 @@ +idf_component_register(SRCS "console_ping.c" + INCLUDE_DIRS "." + PRIV_REQUIRES esp_netif console) diff --git a/components/console_cmd_ping/LICENSE b/components/console_cmd_ping/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/components/console_cmd_ping/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_cmd_ping/README.md b/components/console_cmd_ping/README.md new file mode 100644 index 00000000000..0700efbbdd8 --- /dev/null +++ b/components/console_cmd_ping/README.md @@ -0,0 +1,44 @@ +# Console command ping +The component provides a console where the 'ping' command can be executed. + +## 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_ping.h" + ``` +3. Ensure esp-netif and NVS flash is initialized and default event loop is created in your app_main(): + ```c + ESP_ERROR_CHECK(esp_netif_init()); + 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 + ESP_ERROR_CHECK(console_cmd_ping_register()); + ESP_ERROR_CHECK(console_cmd_start()); // Start console + ``` + + +## Suported command: + +### ping: +``` +ping [-W ] [-i ] [-s ] [-c ] [-Q ] [-T ] + send ICMP ECHO_REQUEST to network hosts + -W, --timeout= Time to wait for a response, in seconds + -i, --interval= Wait interval seconds between sending each packet + -s, --size= Specify the number of data bytes to be sent + -c, --count= Stop after sending count packets + -Q, --tos= Set Type of Service related bits in IP datagrams + -T, --ttl= Set Time to Live related bits in IP datagrams + Host address +``` diff --git a/components/console_cmd_ping/console_ping.c b/components/console_cmd_ping/console_ping.c new file mode 100644 index 00000000000..1e3d54ac17a --- /dev/null +++ b/components/console_cmd_ping/console_ping.c @@ -0,0 +1,193 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ +#include +#include +#include "sdkconfig.h" +#include "lwip/inet.h" +#include "lwip/netdb.h" +#include "lwip/sockets.h" +#include "esp_console.h" +#include "esp_event.h" +#include "esp_log.h" +#include "argtable3/argtable3.h" +#include "ping/ping_sock.h" + + +static const char *TAG = "console_ping"; + +static void cmd_ping_on_ping_success(esp_ping_handle_t hdl, void *args) +{ + uint8_t ttl; + uint16_t seqno; + uint32_t elapsed_time, recv_len; + ip_addr_t target_addr; + esp_ping_get_profile(hdl, ESP_PING_PROF_SEQNO, &seqno, sizeof(seqno)); + esp_ping_get_profile(hdl, ESP_PING_PROF_TTL, &ttl, sizeof(ttl)); + esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr)); + esp_ping_get_profile(hdl, ESP_PING_PROF_SIZE, &recv_len, sizeof(recv_len)); + esp_ping_get_profile(hdl, ESP_PING_PROF_TIMEGAP, &elapsed_time, sizeof(elapsed_time)); + printf("%" PRIu32 " bytes from %s icmp_seq=%" PRIu16 " ttl=%" PRIu16 " time=%" PRIu32 " ms\n", + recv_len, ipaddr_ntoa((ip_addr_t *)&target_addr), seqno, ttl, elapsed_time); +} + +static void cmd_ping_on_ping_timeout(esp_ping_handle_t hdl, void *args) +{ + uint16_t seqno; + ip_addr_t target_addr; + esp_ping_get_profile(hdl, ESP_PING_PROF_SEQNO, &seqno, sizeof(seqno)); + esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr)); + printf("From %s icmp_seq=%d timeout\n", ipaddr_ntoa((ip_addr_t *)&target_addr), seqno); +} + +static void cmd_ping_on_ping_end(esp_ping_handle_t hdl, void *args) +{ + ip_addr_t target_addr; + uint32_t transmitted; + uint32_t received; + uint32_t total_time_ms; + uint32_t loss; + + esp_ping_get_profile(hdl, ESP_PING_PROF_REQUEST, &transmitted, sizeof(transmitted)); + esp_ping_get_profile(hdl, ESP_PING_PROF_REPLY, &received, sizeof(received)); + esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr)); + esp_ping_get_profile(hdl, ESP_PING_PROF_DURATION, &total_time_ms, sizeof(total_time_ms)); + + if (transmitted > 0) { + loss = (uint32_t)((1 - ((float)received) / transmitted) * 100); + } else { + loss = 0; + } + if (IP_IS_V4(&target_addr)) { + printf("\n--- %s ping statistics ---\n", inet_ntoa(*ip_2_ip4(&target_addr))); + } else { + printf("\n--- %s ping statistics ---\n", inet6_ntoa(*ip_2_ip6(&target_addr))); + } + printf("%" PRIu32 " packets transmitted, %" PRIu32 " received, %" PRIu32 "%% packet loss, time %" PRIu32 "ms\n", + transmitted, received, loss, total_time_ms); + // delete the ping sessions, so that we clean up all resources and can create a new ping session + // we don't have to call delete function in the callback, instead we can call delete function from other tasks + esp_ping_delete_session(hdl); +} + +static struct { + struct arg_dbl *timeout; + struct arg_dbl *interval; + struct arg_int *data_size; + struct arg_int *count; + struct arg_int *tos; + struct arg_int *ttl; + struct arg_str *host; + struct arg_end *end; +} ping_args; + +static int do_ping_cmd(int argc, char **argv) +{ + esp_ping_config_t config = ESP_PING_DEFAULT_CONFIG(); + + int nerrors = arg_parse(argc, argv, (void **)&ping_args); + if (nerrors != 0) { + arg_print_errors(stderr, ping_args.end, argv[0]); + return 1; + } + + if (ping_args.timeout->count > 0) { + config.timeout_ms = (uint32_t)(ping_args.timeout->dval[0] * 1000); + } + + if (ping_args.interval->count > 0) { + config.interval_ms = (uint32_t)(ping_args.interval->dval[0] * 1000); + } + + if (ping_args.data_size->count > 0) { + config.data_size = (uint32_t)(ping_args.data_size->ival[0]); + } + + if (ping_args.count->count > 0) { + config.count = (uint32_t)(ping_args.count->ival[0]); + } + + if (ping_args.tos->count > 0) { + config.tos = (uint32_t)(ping_args.tos->ival[0]); + } + + if (ping_args.ttl->count > 0) { + config.ttl = (uint32_t)(ping_args.ttl->ival[0]); + } + + // parse IP address + struct sockaddr_in6 sock_addr6; + ip_addr_t target_addr = {0}; + + if (inet_pton(AF_INET6, ping_args.host->sval[0], &sock_addr6.sin6_addr) == 1) { + /* convert ip6 string to ip6 address */ + ipaddr_aton(ping_args.host->sval[0], &target_addr); + } else { + struct addrinfo hint = {0}; + struct addrinfo *res = NULL; + + /* convert ip4 string or hostname to ip4 or ip6 address */ + if (getaddrinfo(ping_args.host->sval[0], NULL, &hint, &res) != 0) { + printf("ping: unknown host %s\n", ping_args.host->sval[0]); + return 1; + } + if (res->ai_family == AF_INET) { + struct in_addr addr4 = ((struct sockaddr_in *) (res->ai_addr))->sin_addr; + inet_addr_to_ip4addr(ip_2_ip4(&target_addr), &addr4); + } else { + struct in6_addr addr6 = ((struct sockaddr_in6 *) (res->ai_addr))->sin6_addr; + inet6_addr_to_ip6addr(ip_2_ip6(&target_addr), &addr6); + } + freeaddrinfo(res); + } + config.target_addr = target_addr; + + /* set callback functions */ + esp_ping_callbacks_t cbs = { + .cb_args = NULL, + .on_ping_success = cmd_ping_on_ping_success, + .on_ping_timeout = cmd_ping_on_ping_timeout, + .on_ping_end = cmd_ping_on_ping_end + }; + esp_ping_handle_t ping; + esp_ping_new_session(&config, &cbs, &ping); + esp_ping_start(ping); + + return 0; +} + +/** + * @brief Registers the ping command. + * + * @return + * - esp_err_t + */ +esp_err_t console_cmd_ping_register(void) +{ + esp_err_t ret; + + ping_args.timeout = arg_dbl0("W", "timeout", "", "Time to wait for a response, in seconds"); + ping_args.interval = arg_dbl0("i", "interval", "", "Wait interval seconds between sending each packet"); + ping_args.data_size = arg_int0("s", "size", "", "Specify the number of data bytes to be sent"); + ping_args.count = arg_int0("c", "count", "", "Stop after sending count packets"); + ping_args.tos = arg_int0("Q", "tos", "", "Set Type of Service related bits in IP datagrams"); + ping_args.ttl = arg_int0("T", "ttl", "", "Set Time to Live related bits in IP datagrams"); + ping_args.host = arg_str1(NULL, NULL, "", "Host address"); + ping_args.end = arg_end(1); + const esp_console_cmd_t ping_cmd = { + .command = "ping", + .help = "send ICMP ECHO_REQUEST to network hosts", + .hint = NULL, + .func = &do_ping_cmd, + .argtable = &ping_args + }; + + ret = esp_console_cmd_register(&ping_cmd); + if (ret) { + ESP_LOGE(TAG, "Unable to register ping"); + } + + return ret; +} diff --git a/components/console_cmd_ping/console_ping.h b/components/console_cmd_ping/console_ping.h new file mode 100644 index 00000000000..1c6df02c94d --- /dev/null +++ b/components/console_cmd_ping/console_ping.h @@ -0,0 +1,15 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ +#include "console_simple_init.h" + + +/** + * @brief Registers the ping command. + * + * @return + * - esp_err_t + */ +esp_err_t console_cmd_ping_register(void); diff --git a/components/console_cmd_ping/examples/ping-basic/CMakeLists.txt b/components/console_cmd_ping/examples/ping-basic/CMakeLists.txt new file mode 100644 index 00000000000..83d27c262a2 --- /dev/null +++ b/components/console_cmd_ping/examples/ping-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(ping-basic) diff --git a/components/console_cmd_ping/examples/ping-basic/main/CMakeLists.txt b/components/console_cmd_ping/examples/ping-basic/main/CMakeLists.txt new file mode 100644 index 00000000000..32b6184ed94 --- /dev/null +++ b/components/console_cmd_ping/examples/ping-basic/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "ping-basic.c" + INCLUDE_DIRS ".") diff --git a/components/console_cmd_ping/examples/ping-basic/main/idf_component.yml b/components/console_cmd_ping/examples/ping-basic/main/idf_component.yml new file mode 100644 index 00000000000..ea93f2b2a98 --- /dev/null +++ b/components/console_cmd_ping/examples/ping-basic/main/idf_component.yml @@ -0,0 +1,6 @@ +dependencies: + idf: + version: '*' + console_cmd_ping: + version: "*" + override_path: '../../../' diff --git a/components/console_cmd_ping/examples/ping-basic/main/ping-basic.c b/components/console_cmd_ping/examples/ping-basic/main/ping-basic.c new file mode 100644 index 00000000000..a312b8c9fc9 --- /dev/null +++ b/components/console_cmd_ping/examples/ping-basic/main/ping-basic.c @@ -0,0 +1,34 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ +#include +#include "esp_netif.h" +#include "nvs_flash.h" +#include "esp_netif.h" +#include "esp_event.h" +#include "console_ping.h" + + +void app_main(void) +{ + ESP_ERROR_CHECK(esp_netif_init()); + 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 ping command + ESP_ERROR_CHECK(console_cmd_ping_register()); + + // start console REPL + ESP_ERROR_CHECK(console_cmd_start()); + +} diff --git a/components/console_cmd_ping/examples/ping-basic/pytest_ping_basic.py b/components/console_cmd_ping/examples/ping-basic/pytest_ping_basic.py new file mode 100644 index 00000000000..f09921b546b --- /dev/null +++ b/components/console_cmd_ping/examples/ping-basic/pytest_ping_basic.py @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD +# SPDX-License-Identifier: Unlicense OR CC0-1.0 + +# -*- coding: utf-8 -*- +import pytest + + +@pytest.mark.esp32 +def test_examples_ping_command(dut): + dut.expect('esp>', timeout=30) + dut.write('ping 127.0.0.1') + dut.expect('5 packets transmitted, 5 received, 0% packet loss, time 0ms', timeout=30) + pass diff --git a/components/console_cmd_ping/idf_component.yml b/components/console_cmd_ping/idf_component.yml new file mode 100644 index 00000000000..943709fd919 --- /dev/null +++ b/components/console_cmd_ping/idf_component.yml @@ -0,0 +1,8 @@ +version: 0.0.9 +url: https://github.com/espressif/esp-protocols/tree/master/components/console_cmd_ping +description: The component provides a console where the 'ping' command can be executed. +dependencies: + idf: + version: '>=5.0' + espressif/console_simple_init: + version: '>=1.0.2'