From 30cd21f0bcab33e5692e8fb970b250fbf021c675 Mon Sep 17 00:00:00 2001 From: Abhik Roy Date: Sat, 29 Jul 2023 00:08:33 +1000 Subject: [PATCH 1/5] feat(console): Console for runtime network interface configuration and monitoring --- .../console_cmd_ifconfig/CMakeLists.txt | 4 + .../console_cmd_ifconfig/Kconfig.projbuild | 18 + components/console_cmd_ifconfig/LICENSE | 1 + components/console_cmd_ifconfig/README.md | 57 ++ .../console_cmd_ifconfig/console_connect.c | 96 +++ .../console_cmd_ifconfig/console_ifconfig.c | 558 ++++++++++++++++++ .../console_cmd_ifconfig/console_ifconfig.h | 7 + .../console_cmd_ifconfig/idf_component.yml | 8 + .../include/console_connect.h | 7 + 9 files changed, 756 insertions(+) create mode 100644 components/console_cmd_ifconfig/CMakeLists.txt create mode 100644 components/console_cmd_ifconfig/Kconfig.projbuild create mode 100644 components/console_cmd_ifconfig/LICENSE create mode 100644 components/console_cmd_ifconfig/README.md create mode 100644 components/console_cmd_ifconfig/console_connect.c create mode 100644 components/console_cmd_ifconfig/console_ifconfig.c create mode 100644 components/console_cmd_ifconfig/console_ifconfig.h create mode 100644 components/console_cmd_ifconfig/idf_component.yml create mode 100644 components/console_cmd_ifconfig/include/console_connect.h diff --git a/components/console_cmd_ifconfig/CMakeLists.txt b/components/console_cmd_ifconfig/CMakeLists.txt new file mode 100644 index 0000000000..6be427437a --- /dev/null +++ b/components/console_cmd_ifconfig/CMakeLists.txt @@ -0,0 +1,4 @@ +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) diff --git a/components/console_cmd_ifconfig/Kconfig.projbuild b/components/console_cmd_ifconfig/Kconfig.projbuild new file mode 100644 index 0000000000..e93b6a1ea7 --- /dev/null +++ b/components/console_cmd_ifconfig/Kconfig.projbuild @@ -0,0 +1,18 @@ +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 new file mode 100644 index 0000000000..b91d006974 --- /dev/null +++ b/components/console_cmd_ifconfig/LICENSE @@ -0,0 +1 @@ +console_cmd_ifconfig/LICENSE diff --git a/components/console_cmd_ifconfig/README.md b/components/console_cmd_ifconfig/README.md new file mode 100644 index 0000000000..f304b6b7ca --- /dev/null +++ b/components/console_cmd_ifconfig/README.md @@ -0,0 +1,57 @@ +# Console command ifconfig +The component offers a console 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 + ``` +2. In the main file of the example, add the following line: + ```c + #include "console_connect.h" + ``` +3. Ensure esp-netif 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()); + ``` +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) + ``` + + +## Suported commands: + +### 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. + +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 new file mode 100644 index 0000000000..6290a8dea2 --- /dev/null +++ b/components/console_cmd_ifconfig/console_connect.c @@ -0,0 +1,96 @@ +/* + * 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 new file mode 100644 index 0000000000..f40bf548b2 --- /dev/null +++ b/components/console_cmd_ifconfig/console_ifconfig.c @@ -0,0 +1,558 @@ +/* + * 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_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" +#include "lwip/ip6.h" +#include "lwip/opt.h" +#include "ethernet_init.h" +#if IP_NAPT +#include "lwip/lwip_napt.h" +#endif + + +typedef struct netif_op_ netif_op; + +typedef struct netif_op_ { + char *name; + esp_err_t (*operation)(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); + int arg_cnt; + int start_index; + char *help; + int netif_flag; +} netif_op; + +esp_err_t ifcfg_help_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); +esp_err_t ifcfg_print_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); +esp_err_t ifcfg_lwip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); +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_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); + +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 = "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"}, + {.name = "ip6", .operation = ifcfg_basic_op, .arg_cnt = 3, .start_index = 2, .netif_flag = true, .help = "ifconfig ip6: Enable IPv6 on the specified interface"}, + {.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 = "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."}, +}; + + +esp_err_t ifcfg_help_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +{ + int cmd_count = sizeof(cmd_list) / sizeof(cmd_list[0]); + + for (int i = 0; i < cmd_count; i++) { + if ((cmd_list[i].help != NULL) && (strlen(cmd_list[i].help) != 0)) { + printf(" %s\n", cmd_list[i].help); + } + } + + return ESP_OK; +} + + +esp_netif_t *get_esp_netif_from_ifname(char *if_name) +{ + esp_netif_t *esp_netif = NULL; + esp_err_t ret = ESP_FAIL; + char interface[10]; + + /* Get interface details and own global ipv6 address */ + for (int i = 0; i < esp_netif_get_nr_of_ifs(); ++i) { + esp_netif = esp_netif_next(esp_netif); + ret = esp_netif_get_netif_impl_name(esp_netif, interface); + + if ((ESP_FAIL == ret) || (NULL == esp_netif)) { + ESP_LOGE(TAG, "No interface available"); + return NULL; + } + + if (!strcmp(interface, if_name)) { + return esp_netif; + } + } + + return NULL; +} + + +esp_err_t ifcfg_basic_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +{ + /* Set Default */ + if (!strcmp("default", argv[self->start_index])) { + esp_netif_set_default_netif(esp_netif); + return ESP_OK; + } + + /* Enable IPv6 on this interface */ + if (!strcmp("ip6", argv[self->start_index])) { + ESP_ERROR_CHECK(esp_netif_create_ip6_linklocal(esp_netif)); + return ESP_OK; + } + + return ESP_FAIL; +} + + +esp_err_t ifcfg_lwip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +{ + struct netif *lwip_netif = esp_netif_get_netif_impl(esp_netif); + if (NULL == lwip_netif) { + ESP_LOGE(TAG, "lwip interface %s not available", argv[1]); + return ESP_OK; + } + + /* Enable/Disable Interface */ + if (!strcmp("up", argv[self->start_index])) { + netif_set_up(lwip_netif); + return ESP_OK; + } + + if (!strcmp("down", argv[self->start_index])) { + netif_set_down(lwip_netif); + return ESP_OK; + } + + /* Enable/Disable link */ + if (!strcmp("link", argv[self->start_index])) { + + if (!strcmp("up", argv[self->start_index + 1])) { + netif_set_link_up(lwip_netif); + } + + if (!strcmp("down", argv[self->start_index + 1])) { + netif_set_down(lwip_netif); + netif_set_link_down(lwip_netif); + } + + return ESP_OK; + } + + return ESP_FAIL; +} + + +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_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])) { + ESP_LOGI(TAG, "Setting ip: %s", argv[self->start_index + 1]); + + 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])) { + 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])) { + ESP_LOGI(TAG, "Setting gw: %s", argv[self->start_index + 1]); + + inet_aton(argv[self->start_index + 1], &ip_info.gw.addr); + esp_netif_set_ip_info(esp_netif, &ip_info); + return ESP_OK; + } + + return ESP_FAIL; +} + + +#if IP_NAPT +esp_err_t set_napt(char *if_name, bool state) +{ + esp_netif_t *esp_netif = NULL; + esp_err_t ret = ESP_FAIL; + char interface[10]; + + /* Get interface details and own global ipv6 address */ + for (int i = 0; i < esp_netif_get_nr_of_ifs(); ++i) { + esp_netif = esp_netif_next(esp_netif); + + ret = esp_netif_get_netif_impl_name(esp_netif, interface); + if ((ESP_FAIL == ret) || (NULL == esp_netif)) { + ESP_LOGE(TAG, "No interface available"); + return ESP_FAIL; + } + + if (!strcmp(interface, if_name)) { + struct netif *lwip_netif = esp_netif_get_netif_impl(esp_netif); + ip_napt_enable_netif(lwip_netif, state); + return ESP_OK; + } + } + + return ESP_FAIL; +} +#endif + + +esp_err_t ifcfg_napt_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +{ +#if IP_NAPT + if (!strcmp("napt", argv[self->start_index])) { + + ESP_LOGI(TAG, "Setting napt %s on %s", argv[self->start_index + 1], argv[1]); + if (!strcmp(argv[self->start_index + 1], "enable")) { + return set_napt(argv[1], true); + } else if (!strcmp(argv[self->start_index + 1], "disable")) { + return set_napt(argv[1], false); + } else { + ESP_LOGI(TAG, "Invalid argument: %s", argv[self->start_index + 1]); + } + + return ESP_FAIL; + } +#endif + ESP_LOGE(TAG, "NAPT not enabled in menuconfig"); + return ESP_OK; +} + + +esp_err_t ifcfg_dhcp_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +{ + /* Server */ + if (!strcmp("server", argv[self->start_index + 1])) { + 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); + return ESP_OK; + } else if (!strcmp("disable", argv[self->start_index + 2])) { + 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])) { + 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; + } + } + + return ESP_FAIL; +} + + +void print_iface_details(esp_netif_t *esp_netif) +{ + esp_netif_ip_info_t ip_info; + uint8_t mac[NETIF_MAX_HWADDR_LEN]; + char interface[10]; + int ip6_addrs_count = 0; + esp_ip6_addr_t ip6[LWIP_IPV6_NUM_ADDRESSES]; + esp_err_t ret = ESP_FAIL; + esp_netif_dhcp_status_t status; + + struct netif *lwip_netif = esp_netif_get_netif_impl(esp_netif); + + /* Print Interface Name and Number */ + ret = esp_netif_get_netif_impl_name(esp_netif, interface); + if ((ESP_FAIL == ret) || (NULL == esp_netif)) { + ESP_LOGE(TAG, "No interface available"); + return; + } + + if (esp_netif_get_default_netif() == esp_netif) { + ESP_LOGI(TAG, "Interface Name: %s (DEF)", interface); + } else { + ESP_LOGI(TAG, "Interface Name: %s", interface); + } + ESP_LOGI(TAG, "Interface Number: %d", lwip_netif->num); + + /* Print MAC address */ + esp_netif_get_mac(esp_netif, mac); + ESP_LOGI(TAG, "MAC: %02x:%02x:%02x:%02x:%02x:%02x", mac[0], mac[1], + mac[2], mac[3], mac[4], mac[5]); + + /* Print DHCP status */ + if (ESP_OK == esp_netif_dhcps_get_status(esp_netif, &status)) { + ESP_LOGI(TAG, "DHCP Server Status: %d", status); + } else if ((ESP_OK == esp_netif_dhcpc_get_status(esp_netif, &status))) { + if (ESP_NETIF_DHCP_STOPPED == status) { + ESP_LOGI(TAG, "Static IP"); + } else { + ESP_LOGI(TAG, "DHCP Client Status: %s", status ? "enabled" : "disabled"); + } + } + + /* Print IP Info */ + esp_netif_get_ip_info(esp_netif, &ip_info); + ESP_LOGI(TAG, "IP: " IPSTR ", MASK: " IPSTR ", GW: " IPSTR, IP2STR(&(ip_info.ip)), IP2STR(&(ip_info.netmask)), IP2STR(&(ip_info.gw))); + +#if IP_NAPT + /* Print NAPT status*/ + ESP_LOGI(TAG, "NAPT: %s", lwip_netif->napt ? "enabled" : "disabled"); +#endif + + /* Print IPv6 Address */ + ip6_addrs_count = esp_netif_get_all_ip6(esp_netif, ip6); + for (int j = 0; j < ip6_addrs_count; ++j) { + ESP_LOGI(TAG, "IPv6 address: " IPV6STR, IPV62STR(ip6[j])); + } + + /* Print Interface and Link Status*/ + ESP_LOGI(TAG, "Interface Status: %s", esp_netif_is_netif_up(esp_netif) ? "UP" : "DOWN"); + ESP_LOGI(TAG, "Link Status: %s\n", netif_is_link_up(lwip_netif) ? "UP" : "DOWN"); + +} + + +esp_err_t ifcfg_print_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +{ + /* Print interface details */ + if (2 == argc) { + print_iface_details(esp_netif); + return ESP_OK; + } + + /* Get interface details and own global ipv6 address of all interfaces */ + for (int i = 0; i < esp_netif_get_nr_of_ifs(); ++i) { + esp_netif = esp_netif_next(esp_netif); + print_iface_details(esp_netif); + } + + return ESP_OK; +} + + +/* 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; + +uint8_t eth_init_flag = false; +uint8_t eth_port_cnt = 0; +esp_eth_handle_t *eth_handle = NULL; + + +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; + if (asprintf(&if_key, "IFC_ETH%d", id) == -1) { + return ESP_FAIL; + } + + esp_netif_inherent_config_t *esp_eth_base_config = malloc(sizeof(esp_netif_inherent_config_t)); + if (NULL == esp_eth_base_config) { + return ESP_FAIL; + } + *esp_eth_base_config = (esp_netif_inherent_config_t)ESP_NETIF_INHERENT_DEFAULT_ETH(); + esp_eth_base_config->if_key = if_key; + + eth_cfg_o->base = esp_eth_base_config; + eth_cfg_o->driver = NULL; + eth_cfg_o->stack = ESP_NETIF_NETSTACK_DEFAULT_ETH; + + return ESP_OK; +} + + +void free_config(esp_netif_config_t *eth_cfg) +{ + if ((NULL != eth_cfg) && (NULL != eth_cfg->base)) { + free((void *)(eth_cfg->base->if_key)); + free((void *)(eth_cfg->base)); + } +} + + +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)) { + 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_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) { + 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) { + ESP_LOGE(TAG, "%s: eth_glue is NULL", __func__); + } + ESP_ERROR_CHECK(esp_netif_attach(netif_list.esp_netif[i], eth_glue)); + + sleep(10); + + // start Ethernet driver state machine + ESP_ERROR_CHECK(esp_eth_start(eth_handle[eth_handle_id])); + + free_config(ð_cfg); + break; + } + } + + return ESP_OK; + } else if (!strcmp(argv[self->start_index + 1], "destroy")) { + esp_netif = get_esp_netif_from_ifname(argv[self->start_index + 2]); + if (NULL == esp_netif) { + ESP_LOGE(TAG, "interface %s not available", argv[1]); + return ESP_FAIL; + } + + for (int i = 0; i < MAX_ETH_NETIF_COUNT; i++) { + if (esp_netif == netif_list.esp_netif[i]) { + netif_list.created_flag[i] = 0; + break; + } + } + esp_netif_destroy(esp_netif); + netif_list.netif_count--; + + return ESP_OK; + } + + return ESP_FAIL; +} + + +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")) { + + /* Check if ethernet is initialized */ + if (eth_init_flag == false) { + // Initialize Ethernet driver + if (ethernet_init(ð_handle, ð_port_cnt) != ESP_OK) { + ESP_LOGE(TAG, "Unable to initialize ethernet"); + return ESP_FAIL; + } + eth_init_flag = true; + } + + /* Display available ethernet handles */ + for (int i = 0; i < eth_port_cnt; i++) { + printf("ethernet handle id: %d\n", i); + } + + } + + return ESP_OK; +} + + +/* handle 'ifconfig' command */ +static int do_cmd_ifconfig(int argc, char **argv) +{ + esp_netif_t *esp_netif = NULL; + int cmd_count = sizeof(cmd_list) / sizeof(cmd_list[0]); + netif_op cmd; + + for (int i = 0; i < cmd_count; i++) { + cmd = cmd_list[i]; + + if (argc < cmd.start_index + 1) { + continue; + } + + if (!strcmp(cmd.name, argv[cmd.start_index])) { + + /* Get interface for eligible commands */ + if (cmd.netif_flag == true) { + esp_netif = get_esp_netif_from_ifname(argv[1]); + if (NULL == esp_netif) { + ESP_LOGE(TAG, "interface %s not available", argv[1]); + return 0; + } + } + + if (cmd.arg_cnt == argc) { + if (cmd.operation != NULL) { + if (cmd.operation(&cmd, argc, argv, esp_netif) != ESP_OK) { + ESP_LOGE(TAG, "Usage:\n%s", cmd.help); + return 0; + } + + } + return 0; + } + } + } + + ESP_LOGE(TAG, "Command not available"); + + return 1; +} + + +esp_console_cmd_t register_ifconfig(void) +{ + 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; +} diff --git a/components/console_cmd_ifconfig/console_ifconfig.h b/components/console_cmd_ifconfig/console_ifconfig.h new file mode 100644 index 0000000000..8feacfc318 --- /dev/null +++ b/components/console_cmd_ifconfig/console_ifconfig.h @@ -0,0 +1,7 @@ +/* + * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ + +esp_console_cmd_t register_ifconfig(void); diff --git a/components/console_cmd_ifconfig/idf_component.yml b/components/console_cmd_ifconfig/idf_component.yml new file mode 100644 index 0000000000..f935a0c289 --- /dev/null +++ b/components/console_cmd_ifconfig/idf_component.yml @@ -0,0 +1,8 @@ +version: 0.0.4 +url: https://github.com/espressif-abhikroy/esp-protocols/tree/components/console_cmd_ifconfig/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' diff --git a/components/console_cmd_ifconfig/include/console_connect.h b/components/console_cmd_ifconfig/include/console_connect.h new file mode 100644 index 0000000000..20ad6dfc6d --- /dev/null +++ b/components/console_cmd_ifconfig/include/console_connect.h @@ -0,0 +1,7 @@ + +/* + * 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)); From fefd1b4f56700a90d47056157ac415554de5746a Mon Sep 17 00:00:00 2001 From: Abhik Roy Date: Tue, 17 Oct 2023 12:11:10 +0200 Subject: [PATCH 2/5] feat(console): Added fully operational ifconfig and ping command --- .../workflows/console_cmd_ifconfig__build.yml | 32 +++ .github/workflows/console_cmd_ping__build.yml | 32 +++ .github/workflows/publish-docs-component.yml | 2 + components/console_cmd_ifconfig/.cz.yaml | 8 + .../console_cmd_ifconfig/CMakeLists.txt | 7 +- .../console_cmd_ifconfig/Kconfig.projbuild | 18 -- components/console_cmd_ifconfig/LICENSE | 202 ++++++++++++++++- components/console_cmd_ifconfig/README.md | 70 +++--- .../console_cmd_ifconfig/console_connect.c | 96 -------- .../console_cmd_ifconfig/console_ifconfig.c | 209 +++++++++++++----- .../console_cmd_ifconfig/console_ifconfig.h | 11 +- .../examples/ifconfig-basic/CMakeLists.txt | 8 + .../ifconfig-basic/main/CMakeLists.txt | 2 + .../ifconfig-basic/main/idf_component.yml | 6 + .../ifconfig-basic/main/ifconfig-basic.c | 33 +++ .../ifconfig-basic/pytest_ifconfig-basic.py | 21 ++ .../console_cmd_ifconfig/idf_component.yml | 12 +- .../include/console_connect.h | 7 - components/console_cmd_ping/.cz.yaml | 8 + components/console_cmd_ping/CMakeLists.txt | 3 + components/console_cmd_ping/LICENSE | 201 +++++++++++++++++ components/console_cmd_ping/README.md | 44 ++++ components/console_cmd_ping/console_ping.c | 193 ++++++++++++++++ components/console_cmd_ping/console_ping.h | 15 ++ .../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 | 8 + 30 files changed, 1082 insertions(+), 229 deletions(-) create mode 100644 .github/workflows/console_cmd_ifconfig__build.yml create mode 100644 .github/workflows/console_cmd_ping__build.yml create mode 100644 components/console_cmd_ifconfig/.cz.yaml delete mode 100644 components/console_cmd_ifconfig/Kconfig.projbuild delete mode 100644 components/console_cmd_ifconfig/console_connect.c create mode 100644 components/console_cmd_ifconfig/examples/ifconfig-basic/CMakeLists.txt create mode 100644 components/console_cmd_ifconfig/examples/ifconfig-basic/main/CMakeLists.txt create mode 100644 components/console_cmd_ifconfig/examples/ifconfig-basic/main/idf_component.yml create mode 100644 components/console_cmd_ifconfig/examples/ifconfig-basic/main/ifconfig-basic.c create mode 100644 components/console_cmd_ifconfig/examples/ifconfig-basic/pytest_ifconfig-basic.py delete mode 100644 components/console_cmd_ifconfig/include/console_connect.h 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_ifconfig__build.yml b/.github/workflows/console_cmd_ifconfig__build.yml new file mode 100644 index 0000000000..8d94314a9a --- /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 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..43eec0ee39 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 0000000000..21a4aa9985 --- /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 6be427437a..146e894443 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 e93b6a1ea7..0000000000 --- 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 b91d006974..261eeb9e9f 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 f304b6b7ca..d483c69051 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 6290a8dea2..0000000000 --- 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 f40bf548b2..3f9f068a43 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 8feacfc318..915b60c9e0 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 0000000000..9654dec565 --- /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 0000000000..abd01acc4c --- /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 0000000000..212535fe8c --- /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 0000000000..e02bc3411d --- /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 0000000000..d9af3f8356 --- /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 f935a0c289..8c891ce7de 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 20ad6dfc6d..0000000000 --- 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 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..5d6d6435f8 --- /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 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..0700efbbdd --- /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 0000000000..1e3d54ac17 --- /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 0000000000..1c6df02c94 --- /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 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..ea93f2b2a9 --- /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 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..943709fd91 --- /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' From 63f668dcb484696682d4af9bd2a80df622584bff Mon Sep 17 00:00:00 2001 From: Abhik Roy Date: Tue, 17 Oct 2023 12:13:45 +0200 Subject: [PATCH 3/5] fix(common): Fix pytest exclusion of managed components, add root directory gitignore --- components/esp_modem/.gitignore => .gitignore | 0 components/esp_websocket_client/.gitignore | 93 ------------------- pytest.ini | 3 + 3 files changed, 3 insertions(+), 93 deletions(-) rename components/esp_modem/.gitignore => .gitignore (100%) delete mode 100644 components/esp_websocket_client/.gitignore diff --git a/components/esp_modem/.gitignore b/.gitignore similarity index 100% rename from components/esp_modem/.gitignore rename to .gitignore diff --git a/components/esp_websocket_client/.gitignore b/components/esp_websocket_client/.gitignore deleted file mode 100644 index 8d681ae3ec..0000000000 --- a/components/esp_websocket_client/.gitignore +++ /dev/null @@ -1,93 +0,0 @@ -.config -*.o -*.pyc - -# gtags -GTAGS -GRTAGS -GPATH - -# emacs -.dir-locals.el - -# emacs temp file suffixes -*~ -.#* -\#*# - -# eclipse setting -.settings - -# MacOS directory files -.DS_Store - -# Components Unit Test Apps files -components/**/build -components/**/sdkconfig -components/**/sdkconfig.old - -# Example project files -examples/**/sdkconfig -examples/**/sdkconfig.old -examples/**/build - -# Doc build artifacts -docs/_build/ -docs/doxygen_sqlite3.db - -# Downloaded font files -docs/_static/DejaVuSans.ttf -docs/_static/NotoSansSC-Regular.otf - -# Unit test app files -tools/unit-test-app/sdkconfig -tools/unit-test-app/sdkconfig.old -tools/unit-test-app/build -tools/unit-test-app/builds -tools/unit-test-app/output -tools/unit-test-app/test_configs - -# Unit Test CMake compile log folder -log_ut_cmake - -# test application build files -test/**/build -test/**/sdkconfig -test/**/sdkconfig.old - -# IDF monitor test -tools/test_idf_monitor/outputs - -TEST_LOGS - -# gcov coverage reports -*.gcda -*.gcno -coverage.info -coverage_report/ - -test_multi_heap_host - -# VS Code Settings -.vscode/ - -# VIM files -*.swp -*.swo - -# Clion IDE CMake build & config -.idea/ -cmake-build-*/ - -# Results for the checking of the Python coding style and static analysis -.mypy_cache -flake8_output.txt - -# ESP-IDF default build directory name -build - -# lock files for examples and components -dependencies.lock - -# ignore generated docs -docs/html diff --git a/pytest.ini b/pytest.ini index 3705d704f8..7d368d6fdc 100644 --- a/pytest.ini +++ b/pytest.ini @@ -23,3 +23,6 @@ log_file = test.log log_file_level = INFO log_file_format = %(asctime)s %(levelname)s %(message)s log_file_date_format = %Y-%m-%d %H:%M:%S + +# Directory patterns to avoid for recursion +norecursedirs = "managed_components" From deae5db55f149319b7a2ee0a91ff4f5604dc3145 Mon Sep 17 00:00:00 2001 From: Abhik Roy Date: Tue, 17 Oct 2023 17:19:05 +0200 Subject: [PATCH 4/5] fix(console): Fixed function access and removed depricated api calls --- .../console_cmd_ifconfig/console_ifconfig.c | 69 +++++++++---------- .../ifconfig-basic/main/idf_component.yml | 2 +- .../ping-basic/main/idf_component.yml | 2 +- .../console_basic/main/idf_component.yml | 2 +- 4 files changed, 37 insertions(+), 38 deletions(-) diff --git a/components/console_cmd_ifconfig/console_ifconfig.c b/components/console_cmd_ifconfig/console_ifconfig.c index 3f9f068a43..e2f9f2102a 100644 --- a/components/console_cmd_ifconfig/console_ifconfig.c +++ b/components/console_cmd_ifconfig/console_ifconfig.c @@ -24,30 +24,30 @@ #endif -typedef struct netif_op_ netif_op; +typedef struct netif_op_ netif_op_t; typedef struct netif_op_ { char *name; - esp_err_t (*operation)(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); + esp_err_t (*operation)(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); int arg_cnt; int start_index; char *help; int netif_flag; -} netif_op; - -esp_err_t ifcfg_help_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); -esp_err_t ifcfg_print_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); -esp_err_t ifcfg_lwip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif); -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_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); +} netif_op_t; + +static esp_err_t ifcfg_help_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_print_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_lwip_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_basic_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_ip_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_napt_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_addr_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_netif_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); +static esp_err_t ifcfg_eth_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); static const char *TAG = "console_ifconfig"; -netif_op cmd_list[] = { +netif_op_t 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 init/deinit/show: Initialize, deinitialize and display a list of available ethernet handle"}, @@ -67,7 +67,7 @@ netif_op cmd_list[] = { }; -esp_err_t ifcfg_help_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +static esp_err_t ifcfg_help_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { int cmd_count = sizeof(cmd_list) / sizeof(cmd_list[0]); @@ -81,15 +81,14 @@ esp_err_t ifcfg_help_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp } -esp_netif_t *get_esp_netif_from_ifname(char *if_name) +static esp_netif_t *get_esp_netif_from_ifname(char *if_name) { esp_netif_t *esp_netif = NULL; esp_err_t ret = ESP_FAIL; char interface[10]; - /* Get interface details and own global ipv6 address */ - for (int i = 0; i < esp_netif_get_nr_of_ifs(); ++i) { - esp_netif = esp_netif_next(esp_netif); + /* Get interface details and obtain the global IPv6 address */ + while ((esp_netif = esp_netif_next(esp_netif)) != NULL) { ret = esp_netif_get_netif_impl_name(esp_netif, interface); if ((ESP_FAIL == ret) || (NULL == esp_netif)) { @@ -106,7 +105,7 @@ esp_netif_t *get_esp_netif_from_ifname(char *if_name) } -esp_err_t ifcfg_basic_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +static esp_err_t ifcfg_basic_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { /* Set Default */ if (!strcmp("default", argv[self->start_index])) { @@ -124,7 +123,7 @@ esp_err_t ifcfg_basic_op(netif_op *self, int argc, char *argv[], esp_netif_t *es } -esp_err_t ifcfg_lwip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +static esp_err_t ifcfg_lwip_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { struct netif *lwip_netif = esp_netif_get_netif_impl(esp_netif); if (NULL == lwip_netif) { @@ -162,7 +161,7 @@ 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) +static esp_err_t ifcfg_ip_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { esp_netif_ip_info_t ip_info = {0}; @@ -194,7 +193,7 @@ esp_err_t ifcfg_ip_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_n #if IP_NAPT -esp_err_t set_napt(char *if_name, bool state) +static esp_err_t set_napt(char *if_name, bool state) { esp_netif_t *esp_netif = NULL; esp_err_t ret = ESP_FAIL; @@ -222,7 +221,7 @@ esp_err_t set_napt(char *if_name, bool state) #endif -esp_err_t ifcfg_napt_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +static esp_err_t ifcfg_napt_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { #if IP_NAPT if (!strcmp("napt", argv[self->start_index])) { @@ -244,7 +243,7 @@ esp_err_t ifcfg_napt_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp } -esp_err_t ifcfg_addr_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +static esp_err_t ifcfg_addr_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { if (!strcmp("staticip", argv[self->start_index])) { esp_netif_dhcpc_stop(esp_netif); @@ -281,7 +280,7 @@ esp_err_t ifcfg_addr_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp } -void print_iface_details(esp_netif_t *esp_netif) +static void print_iface_details(esp_netif_t *esp_netif) { esp_netif_ip_info_t ip_info; uint8_t mac[NETIF_MAX_HWADDR_LEN]; @@ -318,7 +317,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: %s", status ? "enabled" : "disabled"); + ESP_LOGI(TAG, "DHCP Server Status: %s", (status == ESP_NETIF_DHCP_STARTED) || (status == ESP_NETIF_DHCP_STOPPED) ? "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"); @@ -349,7 +348,7 @@ void print_iface_details(esp_netif_t *esp_netif) } -esp_err_t ifcfg_print_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +static esp_err_t ifcfg_print_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { /* Print interface details */ if (2 == argc) { @@ -385,10 +384,10 @@ typedef struct { 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_g = 0; +static iface_desc iface_list[MAX_ETH_NETIF_COUNT]; +static uint8_t netif_count; +static uint8_t eth_init_flag = false; +static uint8_t eth_port_cnt_g = 0; static esp_err_t get_netif_config(uint16_t id, esp_netif_config_t *eth_cfg_o) { @@ -422,7 +421,7 @@ static 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_err_t ifcfg_netif_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { int eth_handle_id = atoi(argv[self->start_index + 2]); @@ -508,7 +507,7 @@ static void print_eth_info(eth_dev_info_t eth_info, int id) } -esp_err_t ifcfg_eth_op(netif_op *self, int argc, char *argv[], esp_netif_t *esp_netif) +static esp_err_t ifcfg_eth_op(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif) { static esp_eth_handle_t *eth_handle_g = NULL; eth_dev_info_t eth_info; @@ -585,7 +584,7 @@ static int do_cmd_ifconfig(int argc, char **argv) { esp_netif_t *esp_netif = NULL; int cmd_count = sizeof(cmd_list) / sizeof(cmd_list[0]); - netif_op cmd; + netif_op_t cmd; for (int i = 0; i < cmd_count; i++) { cmd = cmd_list[i]; 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 index 212535fe8c..9340f03f85 100644 --- a/components/console_cmd_ifconfig/examples/ifconfig-basic/main/idf_component.yml +++ b/components/console_cmd_ifconfig/examples/ifconfig-basic/main/idf_component.yml @@ -1,6 +1,6 @@ dependencies: idf: - version: '*' + version: ">=5.0" console_cmd_ifconfig: version: "*" override_path: '../../../' 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 index ea93f2b2a9..ff5ac40b2a 100644 --- a/components/console_cmd_ping/examples/ping-basic/main/idf_component.yml +++ b/components/console_cmd_ping/examples/ping-basic/main/idf_component.yml @@ -1,6 +1,6 @@ dependencies: idf: - version: '*' + version: ">=5.0" console_cmd_ping: version: "*" override_path: '../../../' diff --git a/components/console_simple_init/examples/console_basic/main/idf_component.yml b/components/console_simple_init/examples/console_basic/main/idf_component.yml index a6027e49e6..a3d59b813f 100644 --- a/components/console_simple_init/examples/console_basic/main/idf_component.yml +++ b/components/console_simple_init/examples/console_basic/main/idf_component.yml @@ -1,6 +1,6 @@ dependencies: idf: - version: '*' + version: ">=5.0" console_simple_init: version: "*" override_path: '../../../' From 091cd8aa728f57476b93611e0821655f64f75fef Mon Sep 17 00:00:00 2001 From: Abhik Roy Date: Thu, 19 Oct 2023 07:33:40 +0000 Subject: [PATCH 5/5] fix(console): Fixed branch with ping component removal --- .github/workflows/console_cmd_ping__build.yml | 32 --- .github/workflows/publish-docs-component.yml | 111 +++++----- README.md | 4 + .../console_cmd_ifconfig/console_ifconfig.c | 5 +- components/console_cmd_ping/.cz.yaml | 8 - components/console_cmd_ping/CMakeLists.txt | 3 - components/console_cmd_ping/LICENSE | 201 ------------------ components/console_cmd_ping/README.md | 44 ---- components/console_cmd_ping/console_ping.c | 193 ----------------- components/console_cmd_ping/console_ping.h | 15 -- .../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 | 8 - 16 files changed, 61 insertions(+), 626 deletions(-) delete mode 100644 .github/workflows/console_cmd_ping__build.yml delete mode 100644 components/console_cmd_ping/.cz.yaml delete mode 100644 components/console_cmd_ping/CMakeLists.txt delete mode 100644 components/console_cmd_ping/LICENSE delete mode 100644 components/console_cmd_ping/README.md delete mode 100644 components/console_cmd_ping/console_ping.c delete mode 100644 components/console_cmd_ping/console_ping.h delete mode 100644 components/console_cmd_ping/examples/ping-basic/CMakeLists.txt delete mode 100644 components/console_cmd_ping/examples/ping-basic/main/CMakeLists.txt delete mode 100644 components/console_cmd_ping/examples/ping-basic/main/idf_component.yml delete mode 100644 components/console_cmd_ping/examples/ping-basic/main/ping-basic.c delete mode 100644 components/console_cmd_ping/examples/ping-basic/pytest_ping_basic.py delete 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 deleted file mode 100644 index a6729f0ff3..0000000000 --- a/.github/workflows/console_cmd_ping__build.yml +++ /dev/null @@ -1,32 +0,0 @@ -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 43eec0ee39..9b7634d3ac 100644 --- a/.github/workflows/publish-docs-component.yml +++ b/.github/workflows/publish-docs-component.yml @@ -17,7 +17,7 @@ jobs: name: Publish Tag, Release, Docs, Component runs-on: ubuntu-latest # Skip running on forks since it won't have access to secrets - if: github.repository == 'espressif/esp-protocols' + #if: github.repository == 'espressif/esp-protocols' steps: - name: Checkout esp-protocols uses: actions/checkout@v3 @@ -43,58 +43,57 @@ jobs: tag_name: ${{ env.BUMP_TAG }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Generate docs - shell: bash - run: | - sudo apt-get update - sudo apt-get -y install doxygen clang python3-pip - python -m pip install breathe recommonmark esp-docs==1.4.1 - for comp in `ls components`; do - if [[ -d $GITHUB_WORKSPACE/docs/${comp} ]]; then - cd $GITHUB_WORKSPACE/docs/${comp} - if [[ "${{ env.BUMP_COMPONENT }}" == "${comp}" ]]; then - echo "Building specific version of ${comp} (${{ env.BUMP_VERSION }})" - ./generate_docs ${{ env.BUMP_VERSION }} - else - echo "Building latest version of ${comp}" - ./generate_docs - fi - fi - done - - name: Deploying generated docs - shell: bash - run: | - source $GITHUB_WORKSPACE/docs/utils.sh - add_doc_server_ssh_keys $DOCS_DEPLOY_KEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER - export GIT_VER=$(git describe --always) - export GITHUB_REF_NAME=latest - for comp in `ls components`; do - if [[ -d $GITHUB_WORKSPACE/docs/${comp} ]]; then - echo "Deploying latest of ${comp}" - export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/${comp} - export DOCS_DEPLOY_PATH=$DOCS_DEPLOY_PATH_ORIG/${comp} - cd $GITHUB_WORKSPACE/docs/${comp} - deploy-docs - fi - done; - # Deploy docs with version path - if [[ "${{ env.BUMP_VERSION }}" != "" ]] && [[ -d $GITHUB_WORKSPACE/docs/${{ env.BUMP_COMPONENT }} ]]; then - echo "Deploying specific version of ${{ env.BUMP_COMPONENT }} (${{ env.BUMP_VERSION }})" - cd $GITHUB_WORKSPACE/docs/${{ env.BUMP_COMPONENT }} - export GITHUB_REF_NAME=${{ env.BUMP_VERSION }} - deploy-docs - fi - - name: Upload components to component service - uses: espressif/upload-components-ci-action@v1 - with: - directories: > - components/asio; - components/esp_modem; - components/esp_mqtt_cxx; - 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 }} +# - name: Generate docs +# shell: bash +# run: | +# sudo apt-get update +# sudo apt-get -y install doxygen clang python3-pip +# python -m pip install breathe recommonmark esp-docs==1.4.1 +# for comp in `ls components`; do +# if [[ -d $GITHUB_WORKSPACE/docs/${comp} ]]; then +# cd $GITHUB_WORKSPACE/docs/${comp} +# if [[ "${{ env.BUMP_COMPONENT }}" == "${comp}" ]]; then +# echo "Building specific version of ${comp} (${{ env.BUMP_VERSION }})" +# ./generate_docs ${{ env.BUMP_VERSION }} +# else +# echo "Building latest version of ${comp}" +# ./generate_docs +# fi +# fi +# done +# - name: Deploying generated docs +# shell: bash +# run: | +# source $GITHUB_WORKSPACE/docs/utils.sh +# add_doc_server_ssh_keys $DOCS_DEPLOY_KEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER +# export GIT_VER=$(git describe --always) +# export GITHUB_REF_NAME=latest +# for comp in `ls components`; do +# if [[ -d $GITHUB_WORKSPACE/docs/${comp} ]]; then +# echo "Deploying latest of ${comp}" +# export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/${comp} +# export DOCS_DEPLOY_PATH=$DOCS_DEPLOY_PATH_ORIG/${comp} +# cd $GITHUB_WORKSPACE/docs/${comp} +# deploy-docs +# fi +# done; +# # Deploy docs with version path +# if [[ "${{ env.BUMP_VERSION }}" != "" ]] && [[ -d $GITHUB_WORKSPACE/docs/${{ env.BUMP_COMPONENT }} ]]; then +# echo "Deploying specific version of ${{ env.BUMP_COMPONENT }} (${{ env.BUMP_VERSION }})" +# cd $GITHUB_WORKSPACE/docs/${{ env.BUMP_COMPONENT }} +# export GITHUB_REF_NAME=${{ env.BUMP_VERSION }} +# deploy-docs +# fi +# - name: Upload components to component service +# uses: espressif/upload-components-ci-action@v1 +# with: +# directories: > +# components/asio; +# components/esp_modem; +# components/esp_mqtt_cxx; +# components/esp_websocket_client; +# components/mdns; +# components/console_simple_init; +# components/console_cmd_ifconfig; +# namespace: "espressif" +# api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }} diff --git a/README.md b/README.md index 6aff976eba..a9ef2683ad 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_ifconfig + +* Brief introduction [README](components/console_cmd_ifconfig/README.md) diff --git a/components/console_cmd_ifconfig/console_ifconfig.c b/components/console_cmd_ifconfig/console_ifconfig.c index e2f9f2102a..44ed11d24e 100644 --- a/components/console_cmd_ifconfig/console_ifconfig.c +++ b/components/console_cmd_ifconfig/console_ifconfig.c @@ -24,11 +24,10 @@ #endif -typedef struct netif_op_ netif_op_t; -typedef struct netif_op_ { +typedef struct netif_op_t { char *name; - esp_err_t (*operation)(netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); + esp_err_t (*operation)(struct netif_op_t *self, int argc, char *argv[], esp_netif_t *esp_netif); int arg_cnt; int start_index; char *help; diff --git a/components/console_cmd_ping/.cz.yaml b/components/console_cmd_ping/.cz.yaml deleted file mode 100644 index 85b1596a10..0000000000 --- a/components/console_cmd_ping/.cz.yaml +++ /dev/null @@ -1,8 +0,0 @@ ---- -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 deleted file mode 100644 index 5d6d6435f8..0000000000 --- a/components/console_cmd_ping/CMakeLists.txt +++ /dev/null @@ -1,3 +0,0 @@ -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 deleted file mode 100644 index 261eeb9e9f..0000000000 --- a/components/console_cmd_ping/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - 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 deleted file mode 100644 index 0700efbbdd..0000000000 --- a/components/console_cmd_ping/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# 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 deleted file mode 100644 index 1e3d54ac17..0000000000 --- a/components/console_cmd_ping/console_ping.c +++ /dev/null @@ -1,193 +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_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 deleted file mode 100644 index 1c6df02c94..0000000000 --- a/components/console_cmd_ping/console_ping.h +++ /dev/null @@ -1,15 +0,0 @@ -/* - * 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 deleted file mode 100644 index 83d27c262a..0000000000 --- a/components/console_cmd_ping/examples/ping-basic/CMakeLists.txt +++ /dev/null @@ -1,8 +0,0 @@ -# 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 deleted file mode 100644 index 32b6184ed9..0000000000 --- a/components/console_cmd_ping/examples/ping-basic/main/CMakeLists.txt +++ /dev/null @@ -1,2 +0,0 @@ -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 deleted file mode 100644 index ff5ac40b2a..0000000000 --- a/components/console_cmd_ping/examples/ping-basic/main/idf_component.yml +++ /dev/null @@ -1,6 +0,0 @@ -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 deleted file mode 100644 index a312b8c9fc..0000000000 --- a/components/console_cmd_ping/examples/ping-basic/main/ping-basic.c +++ /dev/null @@ -1,34 +0,0 @@ -/* - * 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 deleted file mode 100644 index f09921b546..0000000000 --- a/components/console_cmd_ping/examples/ping-basic/pytest_ping_basic.py +++ /dev/null @@ -1,13 +0,0 @@ -# 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 deleted file mode 100644 index 943709fd91..0000000000 --- a/components/console_cmd_ping/idf_component.yml +++ /dev/null @@ -1,8 +0,0 @@ -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'