Merge pull request #286 from david-cermak/feat/example_multiple_netifs

feat(examples): Add multiple netif demo: eth+wifi+PPP

Author: david-cermak

.github/workflows/examples_build-host-test.yml

@@ -0,0 +1,48 @@
+name: "examples: build/host-tests"
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+
+jobs:
+  build_all_examples:
+    if: contains(github.event.pull_request.labels.*.name, 'examples') || github.event_name == 'push'
+    name: Build examples
+    strategy:
+      matrix:
+        idf_ver: ["latest", "release-v5.1"]
+    runs-on: ubuntu-20.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout esp-protocols
+        uses: actions/checkout@v3
+      - name: Build with IDF-${{ matrix.idf_ver }}
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          python -m pip install idf-build-apps
+          # Build default configs for all targets
+          python ./ci/build_apps.py examples -m examples/.build-test-rules.yml -d -c
+
+  build_and_run_on_host:
+    if: contains(github.event.pull_request.labels.*.name, 'examples') || github.event_name == 'push'
+    name: Build and run examples on linux
+    strategy:
+      matrix:
+        idf_ver: ["latest"]
+    runs-on: ubuntu-20.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout esp-protocols
+        uses: actions/checkout@v3
+      - name: Build with IDF-${{ matrix.idf_ver }}
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          python -m pip install idf-build-apps
+          python ./ci/build_apps.py examples/mqtt -l -t linux
+          timeout 5 ./examples/mqtt/build_linux_default/esp_mqtt_demo.elf | tee test.log  || true
+          grep 'MQTT_EVENT_DATA' test.log

ci/build_apps.py

@@ -26,20 +26,29 @@
     parser.add_argument('-r', '--rules', nargs='*', default=['sdkconfig.ci=default', 'sdkconfig.ci.*=', '=default'], help='Rules how to treat configs')
     parser.add_argument('-m', '--manifests', nargs='*', default=[], help='list of manifest files')
     parser.add_argument('-d', '--delete', action='store_true', help='Delete build artifacts')
+    parser.add_argument('-c', '--recursive', action='store_true', help='Build recursively')
+    parser.add_argument('-l', '--linux', action='store_true', help='Include linux build (dont check warnings)')
     args = parser.parse_args()
 
     IDF_PATH = os.environ['IDF_PATH']
 
-    print(args.paths)
+    # Compose the ignore warning strings from the global list and from the environment
+    ignore_warning_file = os.path.join(os.path.dirname(os.path.realpath(__file__)),'ignore_build_warnings.txt')
+    ignore_warning = open(ignore_warning_file).read().rstrip('\n').split('\n')
+    if 'EXPECTED_WARNING' in os.environ:
+        ignore_warning += os.environ['EXPECTED_WARNING'].split('\n')
+    if args.linux:
+        SUPPORTED_TARGETS.append('linux')
+        ignore_warning = 'warning: '  # Ignore all common warnings on linux builds
     setup_logging(2)
     apps = find_apps(
         args.paths,
-        recursive=False,
+        recursive=args.recursive,
         target=args.target,
         build_dir='build_@t_@w',
         config_rules_str=args.rules,
         build_log_path='build_log.txt',
-        size_json_path='size.json',
+        size_json_path='size.json' if not args.linux else None,
         check_warnings=True,
         preserve=not args.delete,
         manifest_files=args.manifests,
@@ -54,5 +63,5 @@
         build_apps(apps,
                    dry_run=False,
                    keep_going=False,
-                   ignore_warning_strs=os.environ['EXPECTED_WARNING']
-                   if 'EXPECTED_WARNING' in os.environ else None))
+                   ignore_warning_strs=ignore_warning)
+    )

ci/ignore_build_warnings.txt

@@ -0,0 +1 @@
+DeprecationWarning: pkg_resources is deprecated as an API

examples/.build-test-rules.yml

@@ -0,0 +1,3 @@
+examples/esp_netif/multiple_netifs:
+  disable:
+    - if: IDF_TARGET != "esp32"

examples/esp_netif/multiple_netifs/CMakeLists.txt

@@ -0,0 +1,6 @@
+# The following 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(multiple_netifs)

examples/esp_netif/multiple_netifs/README.md

@@ -0,0 +1,25 @@
+| Supported Targets | ESP32 |
+| ----------------- | ----- |
+
+# Multiple Interface example
+
+## Overview
+
+This example demonstrates working with multiple different interfaces with different priorities. It creates these interfaces and tries to connect:
+* WiFi Station
+* Ethernet using ESP32 internal ethernet driver
+* PPPoS over cellular modem
+
+## How to use example
+
+* Set the priorities and the host name for the example to ICMP ping.
+* The example will initialize all interfaces
+* The example will start looping and checking connectivity to the host name
+  * It prints the default interface and ping output
+  * It tries to reconfigure DNS server if host name resolution fails
+  * It tries to manually change the default interface if connection fails
+
+### Hardware Required
+
+To run this example, it's recommended that you have an official ESP32 Ethernet development board - [ESP32-Ethernet-Kit](https://docs.espressif.com/projects/esp-idf/en/latest/hw-reference/get-started-ethernet-kit.html).
+You would also need a modem connected to the board using UART interface.

examples/esp_netif/multiple_netifs/main/CMakeLists.txt

@@ -0,0 +1,13 @@
+set(ppp_connect_srcs ppp_connect.c)
+if(CONFIG_EXAMPLE_PPP_CONNECT_ESP_MODEM)
+    list(APPEND ppp_connect_srcs ppp_connect_esp_modem.c)
+else()
+    list(APPEND ppp_connect_srcs ppp_connect_simple.c)
+endif()
+
+idf_component_register(SRCS multi_netif_main.c
+                            check_connection.c
+                            wifi_connect.c
+                            ethernet_connect.c
+                            ${ppp_connect_srcs}
+                       INCLUDE_DIRS ".")

examples/esp_netif/multiple_netifs/main/Kconfig.projbuild

@@ -0,0 +1,57 @@
+menu "Example Configuration"
+
+    config ESP_WIFI_SSID
+        string "WiFi SSID"
+        default "myssid"
+        help
+            SSID (network name) for the example to connect to.
+
+    config ESP_WIFI_PASSWORD
+        string "WiFi Password"
+        default "mypassword"
+        help
+            WiFi password (WPA or WPA2) for the example to use.
+
+    config ESP_MAXIMUM_RETRY
+        int "Maximum retry"
+        default 0
+        help
+            Set the Maximum retry to avoid station reconnecting. Set to 0 to keep retrying indefinitely.
+
+    config EXAMPLE_MODEM_PPP_APN
+        string "Set MODEM APN"
+        default "default.apn"
+        help
+            Set APN (Access Point Name), a logical name to choose data network
+
+    config EXAMPLE_PPP_UART_TX_PIN
+        int "TXD Pin Number"
+        default 15
+        range 0 31
+        help
+            Pin number of UART TX.
+
+    config EXAMPLE_PPP_UART_RX_PIN
+        int "RXD Pin Number"
+        default 14
+        range 0 31
+        help
+            Pin number of UART RX.
+
+    choice EXAMPLE_PPP_CONNECT
+        prompt "Connect to PPP server"
+        default EXAMPLE_PPP_CONNECT_ESP_MODEM
+        help
+            Choose modem interface library.
+            We use esp_modem by default, but in some
+            simple cases (and a very constrained environment)
+            we could simply connect UART directly to lwIP.
+            To experiment with this option, choose EXAMPLE_PPP_CONNECT_SIMPLE
+
+        config EXAMPLE_PPP_CONNECT_ESP_MODEM
+            bool "Using esp_modem library"
+        config EXAMPLE_PPP_CONNECT_SIMPLE
+            bool "Using simple UART-PPP driver"
+    endchoice
+
+endmenu

examples/esp_netif/multiple_netifs/main/check_connection.c

@@ -0,0 +1,113 @@
+/*
+ * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
+/* Checks network connectivity by pinging configured host
+
+   This example code is in the Public Domain (or CC0 licensed, at your option.)
+
+   Unless required by applicable law or agreed to in writing, this
+   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+   CONDITIONS OF ANY KIND, either express or implied.
+*/
+#include "freertos/FreeRTOS.h"
+#include "freertos/event_groups.h"
+#include "ping/ping_sock.h"
+#include "lwip/netdb.h"
+#include "esp_log.h"
+
+#define SUCCESS (1)
+#define FAIL    (2)
+
+static const char *TAG = "check_connection";
+
+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));
+    ESP_LOGI(TAG, "%" PRIu32 " bytes from %s icmp_seq=%d ttl=%d time=%" PRIu32 " ms",
+             recv_len, inet_ntoa(target_addr.u_addr.ip4), 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));
+    ESP_LOGE(TAG, "From %s icmp_seq=%d timeout", inet_ntoa(target_addr.u_addr.ip4), seqno);
+}
+
+static void cmd_ping_on_ping_end(esp_ping_handle_t hdl, void *args)
+{
+    EventGroupHandle_t events = args;
+    ip_addr_t target_addr;
+    uint32_t transmitted;
+    uint32_t received;
+    uint32_t total_time_ms;
+    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));
+    uint32_t loss = (uint32_t)((1 - ((float)received) / transmitted) * 100);
+    if (IP_IS_V4(&target_addr)) {
+        ESP_LOGI(TAG, "\n--- %s ping statistics ---", inet_ntoa(*ip_2_ip4(&target_addr)));
+    } else {
+        ESP_LOGI(TAG, "\n--- %s ping statistics ---\n", inet6_ntoa(*ip_2_ip6(&target_addr)));
+    }
+    ESP_LOGI(TAG, "%" PRIu32 " packets transmitted, %" PRIu32 " received, %" PRIu32 "%% packet loss, time %"PRIu32"ms\n",
+             transmitted, received, loss, total_time_ms);
+    xEventGroupSetBits(events, received == 0 ? FAIL : SUCCESS);
+}
+
+esp_err_t check_connectivity(const char *host)
+{
+    EventGroupHandle_t events = xEventGroupCreate();
+
+    ip_addr_t target_addr;
+    struct addrinfo hint;
+    struct addrinfo *res = NULL;
+    memset(&hint, 0, sizeof(hint));
+    memset(&target_addr, 0, sizeof(target_addr));
+    /* convert domain name to IP address */
+    if (getaddrinfo(host, NULL, &hint, &res) != 0) {
+        ESP_LOGE(TAG, "ping: unknown host %s\n", host);
+        return ESP_ERR_NOT_FOUND;
+    }
+    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);
+
+    esp_ping_config_t config = ESP_PING_DEFAULT_CONFIG();
+    config.target_addr = target_addr;
+
+    esp_ping_callbacks_t cbs = {
+        .on_ping_success = cmd_ping_on_ping_success,
+        .on_ping_timeout = cmd_ping_on_ping_timeout,
+        .on_ping_end = cmd_ping_on_ping_end,
+        .cb_args = events
+    };
+    esp_ping_handle_t ping;
+    esp_ping_new_session(&config, &cbs, &ping);
+    esp_ping_start(ping);
+    vTaskDelay(pdMS_TO_TICKS(config.count * config.interval_ms));
+    EventBits_t bits = xEventGroupWaitBits(events, FAIL | SUCCESS, pdFALSE, pdFALSE, portMAX_DELAY);
+
+    vEventGroupDelete(events);
+    esp_ping_delete_session(ping);
+
+    return bits == SUCCESS ? ESP_OK : ESP_FAIL;
+}