fix(modem): Use nicer way to override modules

Author: david-cermak

components/esp_modem/examples/modem_tcp_client/main/CMakeLists.txt

@@ -1,9 +1,11 @@
+set(module_dir "generic_module")
 if (CONFIG_EXAMPLE_MODEM_DEVICE_BG96)
     set(device_srcs sock_commands_bg96.cpp)
 elseif(CONFIG_EXAMPLE_MODEM_DEVICE_SIM7600)
     set(device_srcs sock_commands_sim7600.cpp)
 elseif(CONFIG_EXAMPLE_MODEM_DEVICE_ESPAT)
     set(device_srcs sock_commands_espat.cpp)
+    set(module_dir "espat_module")
 endif()
 
 if(CONFIG_ESP_MODEM_ENABLE_DEVELOPMENT_MODE)
@@ -16,4 +18,4 @@ idf_component_register(SRCS "modem_client.cpp"
                             "${command_dir}/sock_dce.cpp"
                             "tcp_transport_at.cpp"
                             "${device_srcs}"
-                       INCLUDE_DIRS "." "${command_dir}")
+                       INCLUDE_DIRS "." "${command_dir}" "${module_dir}")

components/esp_modem/examples/modem_tcp_client/main/command/sock_dce.cpp

@@ -8,8 +8,8 @@
 #include <sys/socket.h>
 #include "esp_vfs.h"
 #include "esp_vfs_eventfd.h"
+
 #include "sock_dce.hpp"
-#include "cxx_include/esp_modem_command_library_utils.hpp"
 
 namespace sock_dce {
 
@@ -305,21 +305,6 @@ std::unique_ptr<DCE> create(const esp_modem::dce_config *config, std::shared_ptr
 }
 
 
-esp_modem::command_result DCE::sync()
-{
-    return esp_modem::dce_commands::generic_command_common(dte.get(), "AT\r\n");
-}
-
-esp_modem::command_result DCE::set_echo(bool on)
-{
-    return esp_modem::dce_commands::generic_command_common(dte.get(), "ATE0\r\n");
-}
-
-esp_modem::command_result DCE::set_pdp_context(esp_modem::PdpContext &pdp)
-{
-    return esp_modem::command_result::OK;
-}
-
 /**
  * @brief Opens network in AT command mode
  * @return OK, FAIL or TIMEOUT

components/esp_modem/examples/modem_tcp_client/main/command/sock_dce.hpp

@@ -8,6 +8,7 @@
 #include "cxx_include/esp_modem_api.hpp"
 #include <cxx_include/esp_modem_dce_factory.hpp>
 #include "sock_commands.hpp"
+#include "sock_module.hpp"
 #include <sys/socket.h>
 
 #pragma  once
@@ -97,13 +98,10 @@ class Responder {
     std::shared_ptr<esp_modem::DTE> &dte;
 };
 
-class DCE : public ::esp_modem::GenericModule {
-    using esp_modem::GenericModule::GenericModule;
+class DCE : public Module {
+    using Module::Module;
 public:
 
-    esp_modem::command_result sync() override;
-    esp_modem::command_result set_echo(bool on) override;
-    esp_modem::command_result set_pdp_context(esp_modem::PdpContext &pdp) override;
     /**
      * @brief Opens network in AT command mode
      * @return OK, FAIL or TIMEOUT

components/esp_modem/examples/modem_tcp_client/main/espat_module/sock_module.hpp

@@ -0,0 +1,24 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "esp_modem_config.h"
+#include "cxx_include/esp_modem_api.hpp"
+
+#pragma  once
+
+namespace sock_dce {
+
+class Module: public esp_modem::GenericModule {
+    using esp_modem::GenericModule::GenericModule;
+public:
+
+    esp_modem::command_result sync() override;
+    esp_modem::command_result set_echo(bool on) override;
+    esp_modem::command_result set_pdp_context(esp_modem::PdpContext &pdp) override;
+
+};
+
+}

components/esp_modem/examples/modem_tcp_client/main/generate/sock_dce.hpp

@@ -8,6 +8,7 @@
 #include "cxx_include/esp_modem_api.hpp"
 #include <cxx_include/esp_modem_dce_factory.hpp>
 #include "sock_commands.hpp"
+#include "sock_module.hpp"
 #include <sys/socket.h>
 
 #pragma  once
@@ -97,8 +98,8 @@ class Responder {
     std::shared_ptr<esp_modem::DTE> &dte;
 };
 
-class DCE : public ::esp_modem::GenericModule {
-    using esp_modem::GenericModule::GenericModule;
+class DCE : public Module {
+    using Module::Module;
 public:
 
 //  --- ESP-MODEM command module starts here ---

components/esp_modem/examples/modem_tcp_client/main/generic_module/sock_module.hpp

@@ -0,0 +1,16 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "esp_modem_config.h"
+#include "cxx_include/esp_modem_api.hpp"
+
+#pragma  once
+
+namespace sock_dce {
+
+using Module = esp_modem::GenericModule;
+
+}

components/esp_modem/examples/modem_tcp_client/main/modem_client.cpp

@@ -124,15 +124,14 @@ extern "C" void app_main(void)
     mqtt_config.network.transport = ssl;
 #endif
     esp_mqtt_client_handle_t mqtt_client = esp_mqtt_client_init(&mqtt_config);
-    esp_mqtt_client_register_event(mqtt_client, static_cast<esp_mqtt_event_id_t>(ESP_EVENT_ANY_ID), mqtt_event_handler, NULL);
+    esp_mqtt_client_register_event(mqtt_client, static_cast<esp_mqtt_event_id_t>(ESP_EVENT_ANY_ID), mqtt_event_handler, nullptr);
     esp_mqtt_client_start(mqtt_client);
 #ifndef CONFIG_EXAMPLE_CUSTOM_TCP_TRANSPORT
-    dce->set_rx_mode(1);
     if (!dce->connect(BROKER_URL, BROKER_PORT)) {
         ESP_LOGE(TAG, "Failed to start DCE");
         return;
     }
-    while (1) {
+    while (true) {
         while (dce->perform_sock()) {
             ESP_LOGV(TAG, "...performing");
         }

components/esp_modem/examples/modem_tcp_client/main/sock_commands_espat.cpp

@@ -9,9 +9,31 @@
 #include "sock_commands.hpp"
 #include "cxx_include/esp_modem_command_library_utils.hpp"
 #include "sock_dce.hpp"
+#include "sock_module.hpp"
 
 static const char *TAG = "sock_commands_espat";
 
+namespace sock_dce {
+
+using namespace esp_modem;
+
+command_result Module::sync()
+{
+    return dce_commands::generic_command_common(dte.get(), "AT\r\n");
+}
+
+command_result Module::set_echo(bool on)
+{
+    return dce_commands::generic_command_common(dte.get(), "ATE0\r\n");
+}
+
+command_result Module::set_pdp_context(PdpContext &pdp)
+{
+    return command_result::OK;
+}
+
+}
+
 namespace sock_commands {
 
 using namespace esp_modem;
@@ -34,8 +56,14 @@ command_result net_open(CommandableIf *t)
         ESP_LOGE(TAG, "Failed to connect to WiFi");
         return ret;
     }
-
     ESP_LOGI(TAG, "WiFi connected successfully");
+
+    // Set passive receive mode (1) for better control
+    ret = set_rx_mode(t, 1);
+    if (ret != command_result::OK) {
+        ESP_LOGE(TAG, "Failed to set preferred Rx mode");
+        return ret;
+    }
     return command_result::OK;
 }
 
@@ -123,8 +151,7 @@ command_result get_ip(CommandableIf *t, std::string &ip)
 command_result set_rx_mode(CommandableIf *t, int mode)
 {
     ESP_LOGE(TAG, "%s", __func__);
-    // Set passive receive mode (1) for better control
-    // Active mode (0) would send +IPD automatically
+    // Active mode (0) sends data automatically, Passive mode (1) notifies about data for reading
     std::string cmd = "AT+CIPRECVTYPE=" + std::to_string(mode) + "\r\n";
     return dce_commands::generic_command(t, cmd, "OK", "ERROR", 1000);
 }

components/esp_modem/examples/modem_tcp_client/sdkconfig.ci.default

@@ -0,0 +1,2 @@
+CONFIG_IDF_TARGET="esp32"
+CONFIG_EXAMPLE_MODEM_DEVICE_ESPAT=y