From 7babdeb9708787bceeaaf35f1cc4968bd75e6a7c Mon Sep 17 00:00:00 2001 From: Abhik Roy Date: Wed, 18 Oct 2023 10:57:05 +0200 Subject: [PATCH] feat(console): Added ping command to console component --- .github/workflows/console_cmd_ping__build.yml | 32 +++ .github/workflows/publish-docs-component.yml | 1 + README.md | 4 + components/console_cmd_ping/.cz.yaml | 8 + components/console_cmd_ping/CMakeLists.txt | 4 + components/console_cmd_ping/LICENSE | 201 ++++++++++++++++ components/console_cmd_ping/README.md | 55 +++++ components/console_cmd_ping/console_ping.c | 215 ++++++++++++++++++ components/console_cmd_ping/console_ping.h | 25 ++ .../examples/ping-basic/CMakeLists.txt | 8 + .../examples/ping-basic/main/CMakeLists.txt | 2 + .../ping-basic/main/idf_component.yml | 6 + .../examples/ping-basic/main/ping-basic.c | 34 +++ .../examples/ping-basic/pytest_ping_basic.py | 13 ++ components/console_cmd_ping/idf_component.yml | 10 + 15 files changed, 618 insertions(+) create mode 100644 .github/workflows/console_cmd_ping__build.yml create mode 100644 components/console_cmd_ping/.cz.yaml create mode 100644 components/console_cmd_ping/CMakeLists.txt create mode 100644 components/console_cmd_ping/LICENSE create mode 100644 components/console_cmd_ping/README.md create mode 100644 components/console_cmd_ping/console_ping.c create mode 100644 components/console_cmd_ping/console_ping.h create mode 100644 components/console_cmd_ping/examples/ping-basic/CMakeLists.txt create mode 100644 components/console_cmd_ping/examples/ping-basic/main/CMakeLists.txt create mode 100644 components/console_cmd_ping/examples/ping-basic/main/idf_component.yml create mode 100644 components/console_cmd_ping/examples/ping-basic/main/ping-basic.c create mode 100644 components/console_cmd_ping/examples/ping-basic/pytest_ping_basic.py create mode 100644 components/console_cmd_ping/idf_component.yml diff --git a/.github/workflows/console_cmd_ping__build.yml b/.github/workflows/console_cmd_ping__build.yml new file mode 100644 index 0000000000..a6729f0ff3 --- /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 f62c60b574..42a3ac09b1 100644 --- a/.github/workflows/publish-docs-component.yml +++ b/.github/workflows/publish-docs-component.yml @@ -94,5 +94,6 @@ jobs: components/esp_websocket_client; components/mdns; components/console_simple_init; + components/console_cmd_ping; namespace: "espressif" api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }} diff --git a/README.md b/README.md index 6aff976eba..fdca9ea70e 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,7 @@ Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf) ### console_simple_init * Brief introduction [README](components/console_simple_init/README.md) + +### console_cmd_ping + +* Brief introduction [README](components/console_cmd_ping/README.md) diff --git a/components/console_cmd_ping/.cz.yaml b/components/console_cmd_ping/.cz.yaml new file mode 100644 index 0000000000..85b1596a10 --- /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 0000000000..e504a6245d --- /dev/null +++ b/components/console_cmd_ping/CMakeLists.txt @@ -0,0 +1,4 @@ +idf_component_register(SRCS "console_ping.c" + INCLUDE_DIRS "." + PRIV_REQUIRES esp_netif console + WHOLE_ARCHIVE) diff --git a/components/console_cmd_ping/LICENSE b/components/console_cmd_ping/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /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 0000000000..686c0d7d96 --- /dev/null +++ b/components/console_cmd_ping/README.md @@ -0,0 +1,55 @@ +# 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 + + // Register all plugin command added to your project + ESP_ERROR_CHECK(console_cmd_all_register()); + + // To register only ifconfig command skip calling console_cmd_all_register() + ESP_ERROR_CHECK(console_cmd_ping_register()); + + ESP_ERROR_CHECK(console_cmd_start()); // Start console + ``` + +### Adding a plugin command or component: +To add a plugin command or any component from IDF component manager into your project, simply include an entry within the `idf_component.yml` file. + +For more details refer [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html) + + +## 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 0000000000..062ecf044e --- /dev/null +++ b/components/console_cmd_ping/console_ping.c @@ -0,0 +1,215 @@ +/* + * 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" +#include "console_ping.h" + + +static const char *TAG = "console_ping"; +SemaphoreHandle_t sync_semaphore; + + +/** + * Static registration of this plugin is achieved by defining the plugin description + * structure and placing it into .console_cmd_desc section. + * The name of the section and its placement is determined by linker.lf file in 'plugins' component. + */ +static const console_cmd_plugin_desc_t __attribute__((section(".console_cmd_desc"), used)) PLUGIN = { + .name = "console_cmd_ping", + .plugin_regd_fn = &console_cmd_ping_register +}; + + +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 + ESP_ERROR_CHECK(esp_ping_delete_session(hdl)); + + /* Give the semaphore as ping task is done */ + xSemaphoreGive(sync_semaphore); +} + +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_ERROR_CHECK(esp_ping_new_session(&config, &cbs, &ping)); + ESP_ERROR_CHECK(esp_ping_start(ping)); + + /* Wait till the ping task is done */ + if (xSemaphoreTake(sync_semaphore, portMAX_DELAY) != pdTRUE) { + ESP_LOGE(TAG, "Error in xSemaphoreTake\n"); + } + + return 0; +} + +/** + * @brief Registers the ping command. + * + * @return + * - esp_err_t + */ +esp_err_t console_cmd_ping_register(void) +{ + esp_err_t ret; + sync_semaphore = xSemaphoreCreateBinary(); + + 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 0000000000..58a2d92e9f --- /dev/null +++ b/components/console_cmd_ping/console_ping.h @@ -0,0 +1,25 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#pragma once + +#include "console_simple_init.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief Registers the ping command. + * + * @return + * - esp_err_t + */ +esp_err_t console_cmd_ping_register(void); + +#ifdef __cplusplus +} +#endif 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 0000000000..83d27c262a --- /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 0000000000..32b6184ed9 --- /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 0000000000..ff5ac40b2a --- /dev/null +++ b/components/console_cmd_ping/examples/ping-basic/main/idf_component.yml @@ -0,0 +1,6 @@ +dependencies: + idf: + version: ">=5.0" + 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 0000000000..a312b8c9fc --- /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 0000000000..f09921b546 --- /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 0000000000..0e51582553 --- /dev/null +++ b/components/console_cmd_ping/idf_component.yml @@ -0,0 +1,10 @@ +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.1.0' + override_path: '../console_simple_init' + public: true