From 433a033fcc6adf944e7260cf0e05dd241a5f331e Mon Sep 17 00:00:00 2001 From: David Cermak Date: Wed, 20 Nov 2024 10:51:08 +0100 Subject: [PATCH] fix(modem): Remove tests and support for IDFv4.4, added IDFv5.4 --- .github/workflows/modem__build-host-tests.yml | 15 +++------------ .../esp_modem/examples/ap_to_pppos/README.md | 4 ---- .../esp_modem/examples/linux_modem/README.md | 4 ---- .../esp_modem/examples/modem_console/README.md | 6 ------ .../esp_modem/examples/modem_tcp_client/README.md | 4 ---- .../esp_modem/examples/pppos_client/README.md | 6 ------ .../examples/simple_cmux_client/README.md | 8 -------- 7 files changed, 3 insertions(+), 44 deletions(-) diff --git a/.github/workflows/modem__build-host-tests.yml b/.github/workflows/modem__build-host-tests.yml index 675fb9c691..7e9bbafd52 100644 --- a/.github/workflows/modem__build-host-tests.yml +++ b/.github/workflows/modem__build-host-tests.yml @@ -13,11 +13,8 @@ jobs: name: Build examples strategy: matrix: - idf_ver: ["latest", "release-v4.4", "release-v5.0", "release-v5.1", "release-v5.2", "release-v5.3"] + idf_ver: ["latest", "release-v5.0", "release-v5.1", "release-v5.2", "release-v5.3", "release-v5.4"] example: ["pppos_client", "modem_console", "modem_tcp_client", "ap_to_pppos", "simple_cmux_client"] - exclude: - - idf_ver: "release-v4.4" - example: modem_tcp_client include: - idf_ver: "release-v5.0" example: "simple_cmux_client" @@ -26,13 +23,7 @@ jobs: runs-on: ubuntu-22.04 container: espressif/idf:${{ matrix.idf_ver }} steps: - - name: Check out code (v3) # @v4 failed due to Node 20's requirement, incompatible with older IDF versions - if: matrix.idf_ver != 'latest' && matrix.idf_ver < 'release-v5.0' - uses: actions/checkout@v3 - with: - path: protocols - - name: Check out code (v4) - if: matrix.idf_ver == 'latest' || matrix.idf_ver >= 'release-v5.0' + - name: Check out code uses: actions/checkout@v4 with: path: protocols @@ -53,7 +44,7 @@ jobs: name: Build tests strategy: matrix: - idf_ver: ["release-v5.0", "release-v5.1", "release-v5.2", "release-v5.3", "latest"] + idf_ver: ["release-v5.0", "release-v5.1", "release-v5.2", "release-v5.3", "release-v5.4", "latest"] test: ["target", "target_ota", "target_iperf"] runs-on: ubuntu-22.04 diff --git a/components/esp_modem/examples/ap_to_pppos/README.md b/components/esp_modem/examples/ap_to_pppos/README.md index 715c846fd4..8a22a730dd 100644 --- a/components/esp_modem/examples/ap_to_pppos/README.md +++ b/components/esp_modem/examples/ap_to_pppos/README.md @@ -15,7 +15,3 @@ By default, this example simply connects to the PPP server using a supported dev This example however, doesn't rely on sending specific AT commands, just the bare minimum to setup the cellular network. Thus, if the `EXAMPLE_USE_MINIMAL_DCE` option is enabled, we directly inherit from the `ModuleIf` and implement only the basic commands. Also, to demonstrate the dce_factory functionality, a new `NetDCE_Factory` is implemented for creating the network module and the DCE. - -### Supported IDF versions - -This example is only supported from `v4.2`, since is uses NAPT feature. diff --git a/components/esp_modem/examples/linux_modem/README.md b/components/esp_modem/examples/linux_modem/README.md index 25f670f7b9..47873cd5d7 100644 --- a/components/esp_modem/examples/linux_modem/README.md +++ b/components/esp_modem/examples/linux_modem/README.md @@ -17,7 +17,3 @@ over PPPoS, i.e. over the modem serial line. * Experiment with the network, after getting the IP from the modem device - directly in the code - in the system (need to set `tun` interface IP, dns servers, and routing the desired traffic over the tun interface) - -### Supported IDF versions - -This example (using the default CMake IDF build system) is only supported from `v4.4`, since is uses `idf.py`'s linux target. diff --git a/components/esp_modem/examples/modem_console/README.md b/components/esp_modem/examples/modem_console/README.md index 07ef2b1e49..c6b7821b2b 100644 --- a/components/esp_modem/examples/modem_console/README.md +++ b/components/esp_modem/examples/modem_console/README.md @@ -25,9 +25,3 @@ USB example uses Quactel BG96 modem device. BG96 needs a positive pulse on its P This example supports USB modem hot-plugging and reconnection. There is one limitation coming from esp_console component: When esp_console REPL is being destroyed (after USB mode disconnection or after `exit` command), it will block on UART read. You must send a character to it (via idf.py monitor), so it unblocks and properly exits. - -### Supported IDF versions - -This example is only supported from `v4.2`, due to support of the console repl mode. - -USB example is supported from `v4.4`. diff --git a/components/esp_modem/examples/modem_tcp_client/README.md b/components/esp_modem/examples/modem_tcp_client/README.md index 1d91892155..a54f9dcec1 100644 --- a/components/esp_modem/examples/modem_tcp_client/README.md +++ b/components/esp_modem/examples/modem_tcp_client/README.md @@ -22,7 +22,3 @@ To enable this mode, please set `EXAMPLE_CUSTOM_TCP_TRANSPORT=y` This configuration could be used with any network library, which is connecting to a localhost endpoint instead of remote one. This example creates a localhost listener which basically mimics the remote endpoint by forwarding the traffic between the library and the TCP/socket layer of the modem (which is already secure if the TLS is used in the network library) ![with localhost listener](at_client_localhost.png) - -### Supported IDF versions - -This example is supported from IDF `v5.0`. diff --git a/components/esp_modem/examples/pppos_client/README.md b/components/esp_modem/examples/pppos_client/README.md index d4ef494381..bd0bc8f58b 100644 --- a/components/esp_modem/examples/pppos_client/README.md +++ b/components/esp_modem/examples/pppos_client/README.md @@ -18,9 +18,3 @@ For USB enabled targets (ESP32-S2, ESP32-S3, or ESP32-P4), it is possible to con USB example uses Quactel BG96 modem device. BG96 needs a positive pulse on its PWK pin to boot-up. This example supports USB modem hot-plugging and reconnection. - -### Supported IDF versions - -This example is only supported from `v4.1`, as this is the default dependency of `esp-modem` component. - -USB example is supported from `v4.4`. diff --git a/components/esp_modem/examples/simple_cmux_client/README.md b/components/esp_modem/examples/simple_cmux_client/README.md index f0242fe853..b09e36edc6 100644 --- a/components/esp_modem/examples/simple_cmux_client/README.md +++ b/components/esp_modem/examples/simple_cmux_client/README.md @@ -11,11 +11,3 @@ The example uses the following configuration options to demonstrate basic esp-mo * `EXAMPLE_NEED_SIM_PIN`: To unlock the SIM card with a PIN code if needed * `EXAMPLE_PERFORM_OTA`: To start simple OTA at the end of the example to exercise basic CMUX/modem networking. Please note that the option `CONFIG_UART_ISR_IN_IRAM` is not enabled automatically, so that buffer overflows are expected and CMUX/PPP and networking should recover. * `EXAMPLE_USE_VFS_TERM`: To demonstrate using an abstract file descriptor to talk to the device (instead of the UART driver directly). This option could be used when implementing a custom VFS driver. - -## About the esp_modem - -Please check the component [README](../../README.md) - -### Supported IDF versions - -This example is only supported from `v4.3`, since is uses an experimental `esp_event_cxx` component.