Merge pull request #332 from espressif-abhikroy/components/console_cmd_ifconfig

Added component: Console for runtime network interface configuration

.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

.github/workflows/publish-docs-component.yml

@@ -95,5 +95,6 @@ jobs:
             components/mdns;
             components/console_simple_init;
             components/console_cmd_ping;
+            components/console_cmd_ifconfig;
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

CONTRIBUTING.md

@@ -29,9 +29,8 @@ e.g.
 
 
 ## Creating a new component
-
-Steps:
-1. Add a file named .cz.yaml to the root of the component.
+Once the commit containing a new component is ready follow the steps below:
+1. Add a file named .cz.yaml to the root of the component and add it to your commit.
 
 The template for .cz.yaml should look like this:
 ```
@@ -50,6 +49,8 @@ commitizen:
 
 Replace [component], [version] and [scope] with the specific component name, version and scope you are working with. This command will help you bump the version of the component with the provided details.
 
+Note: It is crucial to adhere to the above steps when introducing a new component. Never merge the code for a new component without first implementing a bump commit.
+
 ## Release process
 
 When releasing a new component version we have to:

README.md

@@ -41,3 +41,7 @@ Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf)
 ### console_cmd_ping
 
 * Brief introduction [README](components/console_cmd_ping/README.md)
+
+### console_cmd_ifconfig
+
+* Brief introduction [README](components/console_cmd_ifconfig/README.md)

components/asio/examples/asio_chat/CMakeLists.txt

@@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)
 
-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../.. $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_chat)

components/asio/examples/asio_chat/main/idf_component.yml

@@ -4,3 +4,5 @@ dependencies:
   espressif/asio:
     version: "^1.14.1"
     override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

components/asio/examples/async_request/CMakeLists.txt

@@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)
 
-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(async_http_request)

components/asio/examples/async_request/main/idf_component.yml

@@ -4,3 +4,5 @@ dependencies:
   espressif/asio:
     version: "^1.14.1"
     override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

components/asio/examples/socks4/CMakeLists.txt

@@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)
 
-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_sock4)

components/asio/examples/socks4/main/idf_component.yml

@@ -4,3 +4,5 @@ dependencies:
   espressif/asio:
     version: "^1.14.1"
     override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

components/asio/examples/ssl_client_server/CMakeLists.txt

@@ -2,9 +2,6 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)
 
-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 set(EXCLUDE_COMPONENTS openssl)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)

components/asio/examples/ssl_client_server/main/idf_component.yml

@@ -4,3 +4,5 @@ dependencies:
   espressif/asio:
     version: "^1.14.1"
     override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

components/asio/examples/tcp_echo_server/CMakeLists.txt

@@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)
 
-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_tcp_echo_server)

components/asio/examples/tcp_echo_server/main/idf_component.yml

@@ -4,3 +4,5 @@ dependencies:
   espressif/asio:
     version: "^1.14.1"
     override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

components/asio/examples/udp_echo_server/CMakeLists.txt

@@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)
 
-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_udp_echo_server)

components/asio/examples/udp_echo_server/main/idf_component.yml

@@ -4,3 +4,5 @@ dependencies:
   espressif/asio:
     version: "^1.14.1"
     override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

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: 1.0.0
+  version_files:
+  - idf_component.yml

components/console_cmd_ifconfig/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [1.0.0](https://github.com/espressif/esp-protocols/commits/console_cmd_ifconfig-v1.0.0)
+
+### Features
+
+- Console for runtime network interface configuration and monitoring ([8bab1420](https://github.com/espressif/esp-protocols/commit/8bab1420))

components/console_cmd_ifconfig/CMakeLists.txt

@@ -0,0 +1,4 @@
+idf_component_register(SRCS "console_ifconfig.c"
+                    INCLUDE_DIRS "."
+                    PRIV_REQUIRES esp_netif console esp_eth
+                    WHOLE_ARCHIVE)

components/console_cmd_ifconfig/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.

components/console_cmd_ifconfig/README.md

@@ -0,0 +1,64 @@
+# Console command ifconfig
+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 ```idf.py add-dependency``` command.
+2. In the main file of the example, add the following line:
+    ```c
+    #include "console_ifconfig.h"
+    ```
+3. Ensure esp-netif and NVS flash is initialized and default event loop is created in your app_main():
+    ```c
+    ESP_ERROR_CHECK(esp_netif_init());
+    ESP_ERROR_CHECK(esp_event_loop_create_default());
+    esp_err_t ret = nvs_flash_init();   //Initialize NVS
+    if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) {
+        ESP_ERROR_CHECK(nvs_flash_erase());
+        ret = nvs_flash_init();
+    }
+    ESP_ERROR_CHECK(ret);
+    ```
+4. In your app_main() function, add the following line as the last line:
+    ```c
+    ESP_ERROR_CHECK(console_cmd_init());     // Initialize console
+
+    // Register all plugin command added to your project
+    ESP_ERROR_CHECK(console_cmd_all_register());
+
+    // To register only ifconfig command skip calling console_cmd_all_register()
+    ESP_ERROR_CHECK(console_cmd_ifconfig_register());
+
+    ESP_ERROR_CHECK(console_cmd_start());    // Start console
+    ```
+
+### Adding a plugin command or component:
+To add a plugin command or any component from IDF component manager into your project, simply include an entry within the `idf_component.yml` file.
+
+For more details refer [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html)
+
+
+## Suported command:
+
+### Ifconfig:
+```
+ ifconfig help: Prints the help text for all ifconfig commands
+ ifconfig netif create/destroy <ethernet handle id>/<iface>: 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 <iface>: Provide the details of the named interface
+ ifconfig <iface> default: Set the specified interface as the default interface
+ ifconfig <iface> ip6: Enable IPv6 on the specified interface
+ ifconfig <iface> up: Enable the specified interface
+ ifconfig <iface> down: Disable the specified interface
+ ifconfig <iface> link <up/down>: Enable or disable the link of the specified interface
+ ifconfig <iface> napt <enable/disable>: Enable or disable NAPT on the specified interface.
+ ifconfig <iface> ip <ipv4 addr>: Set the IPv4 address of the specified interface
+ ifconfig <iface> mask <ipv4 addr>: Set the subnet mask of the specified interface
+ ifconfig <iface> gw <ipv4 addr>: Set the default gateway of the specified interface
+ ifconfig <iface> staticip: Enables static ip
+ ifconfig <iface> dhcp server <enable/disable>: Enable or disable the DHCP server.(Note: DHCP server is not supported yet)
+ ifconfig <iface> dhcp client <enable/disable>: Enable or disable the DHCP client.
+Note: Disabling the DHCP server and client enables the use of static IP configuration.
+```

components/console_cmd_ifconfig/console_ifconfig.c

@@ -0,0 +1,657 @@
+/*
+ * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include <stdio.h>
+#include <string.h>
+#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 "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"
+#include "console_ifconfig.h"
+#if IP_NAPT
+#include "lwip/lwip_napt.h"
+#endif
+
+
+/**
+ * Static registration of this plugin is achieved by defining the plugin description
+ * structure and placing it into .console_cmd_desc section.
+ * The name of the section and its placement is determined by linker.lf file in 'plugins' component.
+ */
+static const console_cmd_plugin_desc_t __attribute__((section(".console_cmd_desc"), used)) PLUGIN = {
+    .name = "console_cmd_ifconfig",
+    .plugin_regd_fn = &console_cmd_ifconfig_register
+};
+
+
+typedef struct netif_op_t {
+    char *name;
+    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;
+    int netif_flag;
+} 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_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 <ethernet handle id>/<iface>: 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"},
+    {.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 <iface>: Provide the details of the named interface"},
+    {.name = "default",   .operation = ifcfg_basic_op,  .arg_cnt = 3, .start_index = 2, .netif_flag = true,   .help = "ifconfig <iface> 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 <iface> ip6: Enable IPv6 on the specified interface"},
+    {.name = "up",        .operation = ifcfg_lwip_op,   .arg_cnt = 3, .start_index = 2, .netif_flag = true,   .help = "ifconfig <iface> up: Enable the specified interface"},
+    {.name = "down",      .operation = ifcfg_lwip_op,   .arg_cnt = 3, .start_index = 2, .netif_flag = true,   .help = "ifconfig <iface> down: Disable the specified interface"},
+    {.name = "link",      .operation = ifcfg_lwip_op,   .arg_cnt = 4, .start_index = 2, .netif_flag = true,   .help = "ifconfig <iface> link <up/down>: 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 <iface> napt <enable/disable>: 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 <iface> ip <ipv4 addr>: 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 <iface> mask <ipv4 addr>: 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 <iface> gw <ipv4 addr>: Set the default gateway of the specified interface"},
+    {.name = "staticip",  .operation = ifcfg_addr_op,   .arg_cnt = 3, .start_index = 2, .netif_flag = true,   .help = "ifconfig <iface> staticip: Enables static ip"},
+    {.name = "dhcp",      .operation = ifcfg_addr_op,   .arg_cnt = 5, .start_index = 2, .netif_flag = true,   .help = "ifconfig <iface> dhcp server <enable/disable>: Enable or disable the DHCP server.(Note: DHCP server is not supported yet)\n ifconfig <iface> dhcp client <enable/disable>: Enable or disable the DHCP client.\nNote: Disabling the DHCP server and client enables the use of static IP configuration."},
+};
+
+
+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]);
+
+    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;
+}
+
+
+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 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)) {
+            ESP_LOGE(TAG, "No interface available");
+            return NULL;
+        }
+
+        if (!strcmp(interface, if_name)) {
+            return esp_netif;
+        }
+    }
+
+    return NULL;
+}
+
+
+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])) {
+        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;
+}
+
+
+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) {
+        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;
+}
+
+
+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};
+
+    esp_netif_dhcpc_stop(esp_netif);
+    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;
+    } 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;
+    } 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);
+        esp_netif_set_ip_info(esp_netif, &ip_info);
+        return ESP_OK;
+    }
+
+    return ESP_FAIL;
+}
+
+
+#if IP_NAPT
+static 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
+
+
+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])) {
+
+        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;
+}
+
+
+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);
+        //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);
+            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;
+        }
+
+        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;
+        }
+
+        ESP_LOGE(TAG, "Invalid argument");
+        return ESP_FAIL;
+    }
+
+    return ESP_FAIL;
+}
+
+
+static 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_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 */
+    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: %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");
+        } 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");
+
+}
+
+
+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) {
+        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 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;
+
+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)
+{
+    /* 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;
+}
+
+
+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));
+        free((void *)(eth_cfg->base));
+    }
+}
+
+
+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]);
+
+    if (!strcmp(argv[self->start_index + 1], "create")) {
+        /* Validate ethernet handle */
+        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_ERROR_CHECK(get_netif_config(eth_handle_id, &eth_cfg));
+        for (int i = 0; i < MAX_ETH_NETIF_COUNT; i++) {
+            if (iface_list[i].state == ETH_INITIALIZED) {
+                esp_netif = esp_netif_new(&eth_cfg);
+                if (esp_netif == NULL) {
+                    ESP_LOGE(TAG, "Interface with key %s already exists", argv[self->start_index + 2]);
+                    return ESP_FAIL;
+                }
+
+                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;
+                }
+
+                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(iface_list[i].eth_handle));
+
+                free_config(&eth_cfg);
+                iface_list[i].state = NETIF_CREATED;
+                netif_count++;
+                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 == 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_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);
+    }
+}
+
+
+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;
+
+    if (!strcmp(argv[self->start_index + 1], "init")) {
+
+        /* Check if ethernet is initialized */
+        if (eth_init_flag == false) {
+            // Initialize Ethernet driver
+            if (ethernet_init_all(&eth_handle_g, &eth_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_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;
+}
+
+
+/* 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_t 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;
+}
+
+
+/**
+ * @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
+    };
+
+    ret = esp_console_cmd_register(&command);
+    if (ret) {
+        ESP_LOGE(TAG, "Unable to register ifconfig");
+    }
+
+    return ret;
+}

components/console_cmd_ifconfig/console_ifconfig.h

@@ -0,0 +1,25 @@
+/*
+ * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "console_simple_init.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Registers the ifconfig command.
+ *
+ * @return
+ *          - esp_err_t
+ */
+esp_err_t console_cmd_ifconfig_register(void);
+
+#ifdef __cplusplus
+}
+#endif

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)

components/console_cmd_ifconfig/examples/ifconfig-basic/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "ifconfig-basic.c"
+                    INCLUDE_DIRS ".")

components/console_cmd_ifconfig/examples/ifconfig-basic/main/idf_component.yml

@@ -0,0 +1,6 @@
+dependencies:
+  idf:
+    version: ">=5.0"
+  console_cmd_ifconfig:
+    version: "*"
+    override_path: '../../../'

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 <stdio.h>
+#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());
+
+}

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

components/console_cmd_ifconfig/idf_component.yml

@@ -0,0 +1,12 @@
+version: 1.0.0
+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: '>=5.0'
+  espressif/console_simple_init:
+    version: '>=1.1.0'
+    override_path: '../console_simple_init'
+    public: true
+  espressif/ethernet_init:
+    version: '>=0.0.7'

components/console_cmd_ping/.cz.yaml

@@ -3,6 +3,6 @@ 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: 1.0.0
   version_files:
   - idf_component.yml

components/console_cmd_ping/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [1.0.0](https://github.com/espressif/esp-protocols/commits/console_cmd_ping-v1.0.0)
+
+### Features
+
+- Added ping command to console component ([7babdeb9](https://github.com/espressif/esp-protocols/commit/7babdeb9))

components/console_cmd_ping/idf_component.yml

@@ -1,4 +1,4 @@
-version: 0.0.9
+version: 1.0.0
 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:

components/esp_modem/examples/modem_console/main/modem_console_main.cpp

@@ -235,7 +235,9 @@ extern "C" void app_main(void)
         if (c->get_count_of(&SetModeArgs::mode)) {
             auto mode = c->get_string_of(&SetModeArgs::mode);
             modem_mode dev_mode;
-            if (mode == "CMUX1") {
+            if (mode == "UNDEF") {
+                dev_mode = esp_modem::modem_mode::UNDEF;
+            } else if (mode == "CMUX1") {
                 dev_mode = esp_modem::modem_mode::CMUX_MANUAL_MODE;
             } else if (mode == "CMUX2") {
                 dev_mode = esp_modem::modem_mode::CMUX_MANUAL_EXIT;

components/esp_modem/examples/modem_tcp_client/components/extra_tcp_transports/include/mbedtls_wrap.hpp

@@ -6,6 +6,7 @@
 #pragma once
 
 #include <utility>
+#include <memory>
 #include <span>
 #include "mbedtls/ssl.h"
 #include "mbedtls/entropy.h"
@@ -22,6 +23,7 @@ public:
     Tls();
     virtual ~Tls();
     bool init(is_server server, do_verify verify);
+    bool deinit();
     int handshake();
     int write(const unsigned char *buf, size_t len);
     int read(unsigned char *buf, size_t len);
@@ -41,6 +43,11 @@ protected:
     mbedtls_entropy_context entropy_{};
     virtual void delay() {}
 
+    bool set_session();
+    bool get_session();
+    void reset_session();
+    bool is_session_loaded();
+
 private:
     static void print_error(const char *function, int error_code);
     static int bio_write(void *ctx, const unsigned char *buf, size_t len);
@@ -48,5 +55,21 @@ private:
     int mbedtls_pk_parse_key( mbedtls_pk_context *ctx,
                               const unsigned char *key, size_t keylen,
                               const unsigned char *pwd, size_t pwdlen);
+    struct unique_session {
+        unique_session()
+        {
+            ::mbedtls_ssl_session_init(&s);
+        }
+        ~unique_session()
+        {
+            ::mbedtls_ssl_session_free(&s);
+        }
+        mbedtls_ssl_session *ptr()
+        {
+            return &s;
+        }
+        mbedtls_ssl_session s;
+    };
+    std::unique_ptr<unique_session> session_;
 
 };

components/esp_modem/examples/modem_tcp_client/components/extra_tcp_transports/mbedtls_wrap.cpp

@@ -35,6 +35,16 @@ bool Tls::init(is_server server, do_verify verify)
     return true;
 }
 
+bool Tls::deinit()
+{
+    ::mbedtls_ssl_config_free(&conf_);
+    ::mbedtls_ssl_free(&ssl_);
+    ::mbedtls_pk_free(&pk_key_);
+    ::mbedtls_x509_crt_free(&public_cert_);
+    ::mbedtls_x509_crt_free(&ca_cert_);
+    return true;
+}
+
 void Tls::print_error(const char *function, int error_code)
 {
     static char error_buf[100];
@@ -132,3 +142,39 @@ Tls::~Tls()
     ::mbedtls_x509_crt_free(&public_cert_);
     ::mbedtls_x509_crt_free(&ca_cert_);
 }
+
+bool Tls::get_session()
+{
+    if (session_ == nullptr) {
+        session_ = std::make_unique<unique_session>();
+    }
+    int ret = ::mbedtls_ssl_get_session(&ssl_, session_->ptr());
+    if (ret != 0) {
+        print_error("mbedtls_ssl_get_session() failed", ret);
+        return false;
+    }
+    return true;
+}
+
+bool Tls::set_session()
+{
+    if (session_ == nullptr) {
+        printf("session hasn't been initialized");
+        return false;
+    }
+    int ret = mbedtls_ssl_set_session(&ssl_, session_->ptr());
+    if (ret != 0) {
+        print_error("mbedtls_ssl_set_session() failed", ret);
+        return false;
+    }
+    return true;
+}
+
+void Tls::reset_session()
+{
+    session_.reset(nullptr);
+}
+bool Tls::is_session_loaded()
+{
+    return session_ != nullptr;
+}

components/esp_modem/src/esp_modem_dce.cpp

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -96,6 +96,11 @@ bool DCE_Mode::set_unsafe(DTE *dte, ModuleIf *device, Netif &netif, modem_mode m
 {
     switch (m) {
     case modem_mode::UNDEF:
+        if (!dte->set_mode(m)) {
+            return false;
+        }
+        mode = m;
+        return true;
     case modem_mode::DUAL_MODE: // Only DTE can be in Dual mode
         break;
     case modem_mode::COMMAND_MODE:
@@ -151,7 +156,7 @@ bool DCE_Mode::set_unsafe(DTE *dte, ModuleIf *device, Netif &netif, modem_mode m
         mode = modem_mode::CMUX_MANUAL_MODE;
         return true;
     case modem_mode::CMUX_MANUAL_EXIT:
-        if (mode != modem_mode::CMUX_MANUAL_MODE) {
+        if (mode != modem_mode::CMUX_MANUAL_MODE && mode != modem_mode::UNDEF) {
             return false;
         }
         if (!dte->set_mode(m)) {
@@ -160,7 +165,7 @@ bool DCE_Mode::set_unsafe(DTE *dte, ModuleIf *device, Netif &netif, modem_mode m
         mode = modem_mode::COMMAND_MODE;
         return true;
     case modem_mode::CMUX_MANUAL_SWAP:
-        if (mode != modem_mode::CMUX_MANUAL_MODE) {
+        if (mode != modem_mode::CMUX_MANUAL_MODE && mode != modem_mode::UNDEF) {
             return false;
         }
         if (!dte->set_mode(m)) {
@@ -168,12 +173,12 @@ bool DCE_Mode::set_unsafe(DTE *dte, ModuleIf *device, Netif &netif, modem_mode m
         }
         return true;
     case modem_mode::CMUX_MANUAL_DATA:
-        if (mode != modem_mode::CMUX_MANUAL_MODE) {
+        if (mode != modem_mode::CMUX_MANUAL_MODE && mode != modem_mode::UNDEF) {
             return false;
         }
         return transitions::enter_data(*dte, *device, netif);
     case modem_mode::CMUX_MANUAL_COMMAND:
-        if (mode != modem_mode::CMUX_MANUAL_MODE) {
+        if (mode != modem_mode::CMUX_MANUAL_MODE && mode != modem_mode::UNDEF) {
             return false;
         }
         return transitions::exit_data(*dte, *device, netif);

components/esp_modem/src/esp_modem_dte.cpp

@@ -151,10 +151,14 @@ command_result DTE::command(const std::string &cmd, got_line_cb got_line, uint32
 
 bool DTE::exit_cmux()
 {
+    if (!cmux_term) {
+        return false;
+    }
     if (!cmux_term->deinit()) {
         return false;
     }
     exit_cmux_internal();
+    cmux_term.reset();
     return true;
 }
 
@@ -174,6 +178,10 @@ void DTE::exit_cmux_internal()
 
 bool DTE::setup_cmux()
 {
+    if (cmux_term) {
+        ESP_LOGE("esp_modem_dte", "Cannot setup_cmux(), cmux_term already exists");
+        return false;
+    }
     cmux_term = std::make_shared<CMux>(primary_term, std::move(buffer));
     if (cmux_term == nullptr) {
         return false;
@@ -198,6 +206,11 @@ bool DTE::setup_cmux()
 
 bool DTE::set_mode(modem_mode m)
 {
+    // transitions (any) -> UNDEF
+    if (m == modem_mode::UNDEF) {
+        mode = m;
+        return true;
+    }
     // transitions (COMMAND|UNDEF) -> CMUX
     if (m == modem_mode::CMUX_MODE) {
         if (mode == modem_mode::UNDEF || mode == modem_mode::COMMAND_MODE) {
@@ -246,7 +259,7 @@ bool DTE::set_mode(modem_mode m)
         return false;
     }
     // manual CMUX transitions: Exit CMUX
-    if (m == modem_mode::CMUX_MANUAL_EXIT && mode == modem_mode::CMUX_MANUAL_MODE) {
+    if (m == modem_mode::CMUX_MANUAL_EXIT && (mode == modem_mode::CMUX_MANUAL_MODE || mode == modem_mode::UNDEF))  {
         if (exit_cmux()) {
             mode = modem_mode::COMMAND_MODE;
             return true;
@@ -255,7 +268,7 @@ bool DTE::set_mode(modem_mode m)
         return false;
     }
     // manual CMUX transitions: Swap terminals
-    if (m == modem_mode::CMUX_MANUAL_SWAP && mode == modem_mode::CMUX_MANUAL_MODE) {
+    if (m == modem_mode::CMUX_MANUAL_SWAP && (mode == modem_mode::CMUX_MANUAL_MODE || mode == modem_mode::UNDEF)) {
         secondary_term.swap(primary_term);
         set_command_callbacks();
         return true;

components/esp_modem/test/host_test/main/test_modem.cpp

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Unlicense OR CC0-1.0
  */
@@ -247,3 +247,88 @@ TEST_CASE("Test CMUX protocol by injecting payloads", "[esp_modem]")
         CHECK(ret == command_result::OK);
     }
 }
+
+TEST_CASE("Command and Data mode transitions", "[esp_modem][transitions]")
+{
+    auto term = std::make_unique<LoopbackTerm>();
+    auto loopback = term.get();
+    auto dte =  std::make_shared<DTE>(std::move(term));
+    CHECK(term == nullptr);
+
+    esp_modem_dce_config_t dce_config = ESP_MODEM_DCE_DEFAULT_CONFIG("APN");
+    esp_netif_t netif{};
+    auto dce = create_SIM7600_dce(&dce_config, dte, &netif);
+    CHECK(dce != nullptr);
+
+    // UNDEF -> CMD (OK)
+    uint8_t resp[] = "DISCONNECTED\n";
+    loopback->inject(&resp[0], sizeof(resp), sizeof(resp), /* 10ms before injecting reply */100, 0);
+    loopback->write(nullptr, 0); /* this triggers sending the injected response */
+    CHECK(dce->set_mode(esp_modem::modem_mode::COMMAND_MODE) == true);
+    loopback->inject(nullptr, 0, 0, 0, 0); /* reset injection, use synchronous replies now */
+    // CMD -> CMD (Fail)
+    CHECK(dce->set_mode(esp_modem::modem_mode::COMMAND_MODE) == false);
+
+    // Forcing transition to CMD (via UNDEF)
+    // CMD -> UNDEF (OK)
+    CHECK(dce->set_mode(esp_modem::modem_mode::UNDEF) == true);
+    // UNDEF -> CMD (OK)
+    CHECK(dce->set_mode(esp_modem::modem_mode::COMMAND_MODE) == true);
+
+    // CMD -> DATA (OK)
+    CHECK(dce->set_mode(esp_modem::modem_mode::DATA_MODE) == true);
+    // DATA -> CMD (OK)
+    CHECK(dce->set_mode(esp_modem::modem_mode::COMMAND_MODE) == true);
+}
+
+TEST_CASE("CMUX mode transitions", "[esp_modem][transitions]")
+{
+    auto term = std::make_unique<LoopbackTerm>();
+    auto dte = std::make_shared<DTE>(std::move(term));
+    CHECK(term == nullptr);
+
+    esp_modem_dce_config_t dce_config = ESP_MODEM_DCE_DEFAULT_CONFIG("APN");
+    esp_netif_t netif{};
+    auto dce = create_SIM7600_dce(&dce_config, dte, &netif);
+    CHECK(dce != nullptr);
+    // UNDEF -> CMUX (OK)
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MODE) == true);
+    // CMUX -> DATA (Fail)
+    CHECK(dce->set_mode(esp_modem::modem_mode::DATA_MODE) == false);
+    // CMUX back -> CMD (OK)
+    CHECK(dce->set_mode(esp_modem::modem_mode::COMMAND_MODE) == true);
+}
+
+TEST_CASE("CMUX manual mode transitions", "[esp_modem][transitions]")
+{
+    auto term = std::make_unique<LoopbackTerm>();
+    auto dte = std::make_shared<DTE>(std::move(term));
+    CHECK(term == nullptr);
+
+    esp_modem_dce_config_t dce_config = ESP_MODEM_DCE_DEFAULT_CONFIG("APN");
+    esp_netif_t netif{};
+    auto dce = create_SIM7600_dce(&dce_config, dte, &netif);
+    CHECK(dce != nullptr);
+
+    // Happy flow transitions of Manual CMUX transitions
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_MODE) == true);
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_EXIT) == true);
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_MODE) == true);
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_SWAP) == true);
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_DATA) == true);
+    // Cannot test CMUX_MANUAL_DATA -> CMUX_MANUAL_COMMAND with our mocked terminal for now
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_EXIT) == true);
+
+    // Check some out of order manual transitions, most of them are allowed,
+    // but some fail as modem layers report issues with specific steps
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_SWAP) == false); // cannot go directly to SWAP
+    CHECK(dce->set_mode(esp_modem::modem_mode::UNDEF) == true);
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_SWAP) == true);  // can go via UNDEF
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_EXIT) == false); // EXIT is allowed, but CMUX terms don't exist
+    CHECK(dce->set_mode(esp_modem::modem_mode::UNDEF) == true);
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_MODE) == true);  // Enter CMUX (via UNDEF)
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_DATA) == true);  // Go directly to DATA mode
+    CHECK(dce->set_mode(esp_modem::modem_mode::CMUX_MANUAL_EXIT) == true);  // Exit CMUX
+    CHECK(dce->set_mode(esp_modem::modem_mode::UNDEF) == true);             // Succeeds from any state
+
+}

components/esp_websocket_client/.cz.yaml

@@ -3,6 +3,6 @@ commitizen:
   bump_message: 'bump(websocket): $current_version -> $new_version'
   pre_bump_hooks: python ../../ci/changelog.py esp_websocket_client
   tag_format: websocket-v$version
-  version: 1.2.0
+  version: 1.2.1
   version_files:
   - idf_component.yml

components/esp_websocket_client/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.2.1](https://github.com/espressif/esp-protocols/commits/websocket-v1.2.1)
+
+### Bug Fixes
+
+- consider failure if return value of `esp_websocket_client_send_with_exact_opcode` less than 0 ([f523b4d](https://github.com/espressif/esp-protocols/commit/f523b4d))
+- fix of return value for `esp_websocket_client_send_with_opcode` API ([ba33588](https://github.com/espressif/esp-protocols/commit/ba33588))
+
 ## [1.2.0](https://github.com/espressif/esp-protocols/commits/websocket-v1.2.0)
 
 ### Features

components/esp_websocket_client/esp_websocket_client.c

@@ -545,7 +545,7 @@ static esp_err_t esp_websocket_client_create_transport(esp_websocket_client_hand
     return ESP_OK;
 }
 
-static bool esp_websocket_client_send_with_exact_opcode(esp_websocket_client_handle_t client, ws_transport_opcodes_t opcode, const uint8_t *data, int len, TickType_t timeout)
+static int esp_websocket_client_send_with_exact_opcode(esp_websocket_client_handle_t client, ws_transport_opcodes_t opcode, const uint8_t *data, int len, TickType_t timeout)
 {
     int ret = -1;
     int need_write = len;
@@ -571,14 +571,14 @@ static bool esp_websocket_client_send_with_exact_opcode(esp_websocket_client_han
                 esp_websocket_client_error(client, "esp_transport_write() returned %d, errno=%d", ret, errno);
             }
             esp_websocket_client_abort_connection(client, WEBSOCKET_ERROR_TYPE_TCP_TRANSPORT);
-            return false;
+            return ret;
         }
         opcode = 0;
         widx += wlen;
         need_write = len - widx;
     }
     esp_websocket_free_buf(client, true);
-    return true;
+    return widx;
 }
 
 esp_websocket_client_handle_t esp_websocket_client_init(const esp_websocket_client_config_t *config)
@@ -1227,9 +1227,9 @@ int esp_websocket_client_send_with_opcode(esp_websocket_client_handle_t client,
         ret = ESP_FAIL;
         goto unlock_and_return;
     }
-    if (esp_websocket_client_send_with_exact_opcode(client, opcode | WS_TRANSPORT_OPCODES_FIN, data, len, timeout) != true) {
+    ret = esp_websocket_client_send_with_exact_opcode(client, opcode | WS_TRANSPORT_OPCODES_FIN, data, len, timeout);
+    if (ret < 0) {
         ESP_LOGE(TAG, "Failed to send the buffer");
-        ret = ESP_FAIL;
         goto unlock_and_return;
     }
 unlock_and_return:

components/esp_websocket_client/examples/linux/CMakeLists.txt

@@ -8,7 +8,6 @@ set(EXTRA_COMPONENT_DIRS
   "${common_component_dir}/linux_compat"
   "${common_component_dir}/linux_compat/freertos")
 
-list(APPEND EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 list(APPEND EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/protocols/linux_stubs/esp_stubs)
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 

components/esp_websocket_client/examples/linux/main/idf_component.yml

@@ -0,0 +1,3 @@
+dependencies:
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

components/esp_websocket_client/examples/target/CMakeLists.txt

@@ -2,8 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)
 
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-list(APPEND EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(websocket_example)

components/esp_websocket_client/examples/target/main/idf_component.yml

@@ -4,3 +4,5 @@ dependencies:
   espressif/esp_websocket_client:
     version: "^1.0.0"
     override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common

components/esp_websocket_client/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.2.0"
+version: "1.2.1"
 description: WebSocket protocol client for ESP-IDF
 url: https://github.com/espressif/esp-protocols/tree/master/components/esp_websocket_client
 dependencies:

docs/esp_modem/en/README.rst

@@ -81,16 +81,68 @@ Common use cases of the esp-modem are also listed as the examples:
 - ``examples/modem_console`` is an example to exercise all possible module commands in a console application.
 - ``examples/ap_to_pppos`` this example focuses on the network connectivity of the esp-modem and provides a WiFi AP that forwards packets (and uses NAT) to and from the PPPoS connection.
 
+Working modes
+~~~~~~~~~~~~~
+
+Modem devices could work in multiple different modes, esp-modem library
+uses these states to describe them:
+- Standard modes:
+      - Command mode -- This mode is used for sending AT commands
+      - Data or PPP mode -- This mode is used for data communication (to create PPPoS tunnel between the device and the library)
+- Multiplexing modes:
+      - CMUX mode -- This mode creates two virtual channels and uses one for sending AT commands and the other one for data communication.
+      - DUAL mode -- This mode uses two physical channels the same way as CMUX. This mode is supported only by certain devices, usually with USB interface.
+- Manual CMUX modes -- These modes are designed for applications to have better control over CMUX mode transitions. It allows setting up the virtual channels,
+  switching between channels, transitioning between data and command modes for each channel separately, and exiting the CMUX.
+
+Switching between common modes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The diagram below depicts allowed transitions between the most common modes
+
+::
+
+      +---------+    +---------+
+      | COMMAND |<-->|   DATA  |
+      +---------+    +---------+
+           ^
+           |
+           v
+      +-------+
+      | CMUX  |
+      +-------+
+
+Note that it is possible to switch from any mode to the "UNDEF" mode and vice-versa.
+
+Switching between manual modes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The diagram below depicts allowed transitions between manual CMUX modes
+
+::
+                             +------------------------------------
+                             |                                   |
+      +----------+    +-------------+    +------------+    +----------+
+      |          |<-->| MANUAL_DATA |<-->| MANUAL_CMD |<-->| COMMAND  |
+      | CMUX     |    +-------------+    +------------+    |  (CMUX   |
+      | MANUAL   |           |                             |  MANUAL  |
+      |          |    +-------------+                      |  EXIT)   |
+      |          |<-->| MANUAL_SWAP |<-------------------->|          |
+      +----------+    +-------------+                      +----------+
+           |                                                     |
+           +-----------------------------------------------------+
+
+Note that transitioning between "MANUAL_DATA" and "MANUAL_CMD" switches the secondary terminal (dedicated to PPP session) and could be used for recovering data communication if PPP session gets dropped.
+
 Extensibility
 -------------
 
 CMUX
 ~~~~
 
-Implementation of virtual terminals is an experimental feature, which
-allows users to also issue commands in the data mode, after creating
-multiple virtual terminals, designating some of them solely to data
-mode, others solely to command mode.
+Implements virtual terminals which allow users to also issue commands in the data mode;
+after creating two virtual terminals, designating one of them solely to data mode, and
+another one solely to command mode.
 
 DTE
 ~~~