fix(modem): Use generated AT command definitions for IDE navigation

BREAKING CHANGE: inc headers for AT command definitions are no longer used directly, but pregenerated into *.h(pp)

components/esp_modem/include/cxx_include/esp_modem_command_library.hpp

@@ -1,65 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-#pragma once
-
-#include "esp_modem_dte.hpp"
-#include "esp_modem_dce_module.hpp"
-#include "esp_modem_types.hpp"
-#include "generate/esp_modem_command_declare.inc"
-
-namespace esp_modem {
-namespace dce_commands {
-
-/**
- * @defgroup ESP_MODEM_DCE_COMMAND ESP_MODEM DCE command library
- * @brief Library of the most useful DCE commands
- */
-/** @addtogroup ESP_MODEM_DCE_COMMAND
- * @{
- */
-
-/**
- * @brief Generic AT command to be send with pass and fail phrases
- *
- * @param t Commandable object (anything that can accept commands)
- * @param command Command to be sent do the commandable object
- * @param pass_phrase String to be present in the reply to pass this command
- * @param fail_phrase String to be present in the reply to fail this command
- * @param timeout_ms Timeout in ms
- */
-command_result generic_command(CommandableIf *t, const std::string &command,
-                               const std::string &pass_phrase,
-                               const std::string &fail_phrase, uint32_t timeout_ms);
-
-/**
- * @brief Declaration of all commands is generated from esp_modem_command_declare.inc
- */
-#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, num, ...) \
-        return_type name(CommandableIf *t, ## __VA_ARGS__);
-
-DECLARE_ALL_COMMAND_APIS(declare name(Commandable *p, ...);)
-
-#undef ESP_MODEM_DECLARE_DCE_COMMAND
-
-/**
- * @brief Following commands that are different for some specific modules
- */
-command_result get_battery_status_sim7xxx(CommandableIf *t, int &voltage, int &bcs, int &bcl);
-command_result set_gnss_power_mode_sim76xx(CommandableIf *t, int mode);
-command_result power_down_sim76xx(CommandableIf *t);
-command_result power_down_sim70xx(CommandableIf *t);
-command_result set_network_bands_sim76xx(CommandableIf *t, const std::string &mode, const int *bands, int size);
-command_result power_down_sim8xx(CommandableIf *t);
-command_result set_data_mode_alt(CommandableIf *t);
-command_result set_pdp_context(CommandableIf *t, PdpContext &pdp, uint32_t timeout_ms);
-
-/**
- * @}
- */
-
-} // dce_commands
-} // esp_modem

components/esp_modem/include/cxx_include/esp_modem_dce.hpp

@@ -6,164 +6,5 @@
 
 #pragma once
 
-#include <utility>
-#include "cxx_include/esp_modem_netif.hpp"
-#include "cxx_include/esp_modem_dce_module.hpp"
-
-namespace esp_modem {
-
-/**
- * @defgroup ESP_MODEM_DCE
- * @brief Definition of DCE abstraction
- */
-/** @addtogroup ESP_MODEM_DCE
- * @{
- */
-
-
-/**
- * @brief Helper class responsible for switching modes of the DCE's
- */
-class DCE_Mode {
-public:
-    DCE_Mode(): mode(modem_mode::UNDEF) {}
-    ~DCE_Mode() = default;
-    bool set(DTE *dte, ModuleIf *module, Netif &netif, modem_mode m);
-    modem_mode get();
-    modem_mode guess(DTE *dte, bool with_cmux = false);
-
-private:
-    bool set_unsafe(DTE *dte, ModuleIf *module, Netif &netif, modem_mode m);
-    modem_mode guess_unsafe(DTE *dte, bool with_cmux);
-    modem_mode mode;
-
-};
-
-/**
- * @brief General DCE class templated on a specific module. It is responsible for all the necessary transactions
- * related to switching modes and consequent synergy with aggregated objects of DTE, Netif and a specific Module
- */
-template<class SpecificModule>
-class DCE_T {
-    static_assert(std::is_base_of<ModuleIf, SpecificModule>::value, "DCE must be instantiated with Module class only");
-public:
-    explicit DCE_T(const std::shared_ptr<DTE> &dte, std::shared_ptr<SpecificModule> dev, esp_netif_t *netif):
-        dte(dte), device(std::move(dev)), netif(dte, netif)
-    { }
-
-    ~DCE_T() = default;
-
-    /**
-     * @brief Set data mode!
-     */
-    void set_data()
-    {
-        set_mode(modem_mode::DATA_MODE);
-    }
-
-    void exit_data()
-    {
-        set_mode(modem_mode::COMMAND_MODE);
-    }
-
-    void set_cmux()
-    {
-        set_mode(modem_mode::CMUX_MODE);
-    }
-
-    SpecificModule *get_module()
-    {
-        return device.get();
-    }
-
-    command_result command(const std::string &command, got_line_cb got_line, uint32_t time_ms)
-    {
-        return dte->command(command, std::move(got_line), time_ms);
-    }
-
-    modem_mode guess_mode(bool with_cmux = false)
-    {
-        return mode.guess(dte.get(), with_cmux);
-    }
-
-    bool set_mode(modem_mode m)
-    {
-        return mode.set(dte.get(), device.get(), netif, m);
-    }
-
-    modem_mode get_mode()
-    {
-        return mode.get();
-    }
-
-    bool recover()
-    {
-        return dte->recover();
-    }
-
-#ifdef CONFIG_ESP_MODEM_URC_HANDLER
-    void set_urc(got_line_cb on_read_cb)
-    {
-        dte->set_urc_cb(on_read_cb);
-    }
-#endif
-
-    /**
-     * @brief Pauses/Unpauses network temporarily
-     * @param do_pause true to pause, false to unpause
-     * @param force true to ignore command failures and continue
-     * @return command_result of the underlying commands
-     */
-    command_result pause_netif(bool do_pause, bool force = false, int delay = 1000)
-    {
-        command_result result;
-        if (do_pause) {
-            netif.pause();
-            Task::Delay(delay); // Mandatory 1s pause before
-            dte->set_command_callbacks();
-            result = device->set_command_mode();
-        } else {
-            result = device->resume_data_mode();
-            if (result == command_result::OK || force) {
-                netif.resume();
-            }
-        }
-        return result;
-    }
-
-protected:
-    std::shared_ptr<DTE> dte;
-    std::shared_ptr<SpecificModule> device;
-    Netif netif;
-    DCE_Mode mode;
-};
-
-/**
- * @brief Common abstraction of the modem DCE, specialized by the GenericModule which is a parent class for the supported
- * devices and most common modems, as well.
- */
-class DCE : public DCE_T<GenericModule> {
-public:
-
-    using DCE_T<GenericModule>::DCE_T;
-#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, num, ...) \
-    template <typename ...Agrs> \
-    return_type name(Agrs&&... args)   \
-    {   \
-        return device->name(std::forward<Agrs>(args)...); \
-    }
-
-    DECLARE_ALL_COMMAND_APIS(forwards name(...)
-    {
-        device->name(...);
-    } )
-
-#undef ESP_MODEM_DECLARE_DCE_COMMAND
-
-};
-
-/**
- * @}
- */
-
-} // esp_modem
+#include "cxx_include/esp_modem_dce_template.hpp"
+#include "cxx_include/esp_modem_dce_generic.hpp"

components/esp_modem/include/cxx_include/esp_modem_dce_module.hpp

@@ -1,192 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2021-2025 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-#pragma once
-
-#include <memory>
-#include <utility>
-#include "generate/esp_modem_command_declare.inc"
-#include "cxx_include/esp_modem_command_library.hpp"
-#include "cxx_include/esp_modem_types.hpp"
-#include "esp_modem_dce_config.h"
-
-namespace esp_modem {
-
-/**
- * @defgroup ESP_MODEM_MODULE
- * @brief Definition of modules representing specific modem devices
- */
-
-/** @addtogroup ESP_MODEM_MODULE
-* @{
-*/
-
-enum class command_result;
-class DTE;
-struct PdpContext;
-
-/**
- * @brief This is a basic building block for custom modules as well as for the supported modules in the esp-modem component
- * It derives from the ModuleIf.
- */
-class GenericModule: public ModuleIf {
-public:
-    /**
-     * @brief We can construct a generic device with an existent DTE and it's configuration
-     * The configuration could be either the dce-config struct or just a pdp context
-     */
-    explicit GenericModule(std::shared_ptr<DTE> dte, std::unique_ptr<PdpContext> pdp):
-        dte(std::move(dte)), pdp(std::move(pdp)) {}
-    explicit GenericModule(std::shared_ptr<DTE> dte, const esp_modem_dce_config *config);
-
-    /**
-     * @brief This is a mandatory method for ModuleIf class, which sets up the device
-     * to be able to connect to the network. This typically consists of setting basic
-     * communication parameters and setting the PDP (defining logical access point
-     * to cellular network)
-     */
-    bool setup_data_mode() override
-    {
-        if (set_echo(false) != command_result::OK) {
-            return false;
-        }
-        if (set_pdp_context(*pdp) != command_result::OK) {
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * @brief This is a mandatory method of ModuleIf class, which defines
-     * basic commands for switching between DATA, COMMAND and CMUX modes
-     */
-    bool set_mode(modem_mode mode) override
-    {
-        if (mode == modem_mode::DATA_MODE) {
-            if (set_data_mode() != command_result::OK) {
-                return resume_data_mode() == command_result::OK;
-            }
-            return true;
-        } else if (mode == modem_mode::COMMAND_MODE) {
-            Task::Delay(1000); // Mandatory 1s pause before
-            int retry = 0;
-            while (retry++ < 3) {
-                if (set_command_mode() == command_result::OK) {
-                    return true;
-                }
-                // send a newline to delimit the escape from the upcoming sync command
-                uint8_t delim = '\n';
-                dte->write(&delim, 1);
-                if (sync() == command_result::OK) {
-                    return true;
-                }
-                Task::Delay(1000); // Mandatory 1s pause before escape
-            }
-            return false;
-        } else if (mode == modem_mode::CMUX_MODE) {
-            return set_cmux() == command_result::OK;
-        }
-        return true;
-    }
-
-    /**
-     * @brief Additional method providing runtime configuration of PDP context
-     */
-    void configure_pdp_context(std::unique_ptr<PdpContext> new_pdp)
-    {
-        pdp = std::move(new_pdp);
-    }
-
-    /**
-     * @brief Simplified version of operator name (without the ACT, which is included in the command library)
-     */
-    command_result get_operator_name(std::string &name)
-    {
-        int dummy_act;
-        return get_operator_name(name, dummy_act);
-    }
-
-    /**
-     * @brief Common DCE commands generated from the API AT list
-     */
-#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, num, ...) \
-    virtual return_type name(__VA_ARGS__);
-
-    DECLARE_ALL_COMMAND_APIS(virtual return_type name(...);)
-
-#undef ESP_MODEM_DECLARE_DCE_COMMAND
-
-
-protected:
-    std::shared_ptr<DTE> dte;         /*!< Generic device needs the DTE as a channel talk to the module using AT commands */
-    std::unique_ptr<PdpContext> pdp;  /*!< It also needs a PDP data, const information used for setting up cellular network */
-};
-
-// Definitions of other supported modules with some specific commands overwritten
-
-/**
- * @brief Specific definition of the SIM7600 module
- */
-class SIM7600: public GenericModule {
-    using GenericModule::GenericModule;
-public:
-    command_result get_battery_status(int &voltage, int &bcs, int &bcl) override;
-    command_result power_down() override;
-    command_result set_gnss_power_mode(int mode) override;
-    command_result set_network_bands(const std::string &mode, const int *bands, int size) override;
-};
-
-/**
- * @brief Specific definition of the SIM7070 module
- */
-class SIM7070: public GenericModule {
-    using GenericModule::GenericModule;
-public:
-    command_result power_down() override;
-    command_result set_data_mode() override;
-
-};
-
-/**
- * @brief Specific definition of the SIM7000 module
- */
-class SIM7000: public GenericModule {
-    using GenericModule::GenericModule;
-public:
-    command_result power_down() override;
-};
-
-/**
- * @brief Specific definition of the SIM800 module
- */
-class SIM800: public GenericModule {
-    using GenericModule::GenericModule;
-public:
-    command_result power_down() override;
-};
-
-/**
- * @brief Specific definition of the BG96 module
- */
-class BG96: public GenericModule {
-    using GenericModule::GenericModule;
-public:
-    command_result set_pdp_context(PdpContext &pdp) override;
-};
-
-class SQNGM02S : public GenericModule {
-    using GenericModule::GenericModule;
-
-public:
-    command_result connect(PdpContext &pdp);
-    bool setup_data_mode() override;
-};
-
-/**
- * @}
- */
-
-} // namespace esp_modem

components/esp_modem/include/cxx_include/esp_modem_dce_template.hpp

@@ -0,0 +1,142 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include <utility>
+#include "cxx_include/esp_modem_netif.hpp"
+#include "cxx_include/esp_modem_dce_module.hpp"
+
+namespace esp_modem {
+
+/**
+ * @defgroup ESP_MODEM_DCE
+ * @brief Definition of DCE abstraction
+ */
+/** @addtogroup ESP_MODEM_DCE
+ * @{
+ */
+
+
+/**
+ * @brief Helper class responsible for switching modes of the DCE's
+ */
+class DCE_Mode {
+public:
+    DCE_Mode(): mode(modem_mode::UNDEF) {}
+    ~DCE_Mode() = default;
+    bool set(DTE *dte, ModuleIf *module, Netif &netif, modem_mode m);
+    modem_mode get();
+    modem_mode guess(DTE *dte, bool with_cmux = false);
+
+private:
+    bool set_unsafe(DTE *dte, ModuleIf *module, Netif &netif, modem_mode m);
+    modem_mode guess_unsafe(DTE *dte, bool with_cmux);
+    modem_mode mode;
+
+};
+
+/**
+ * @brief General DCE class templated on a specific module. It is responsible for all the necessary transactions
+ * related to switching modes and consequent synergy with aggregated objects of DTE, Netif and a specific Module
+ */
+template<class SpecificModule>
+class DCE_T {
+    static_assert(std::is_base_of<ModuleIf, SpecificModule>::value, "DCE must be instantiated with Module class only");
+public:
+    explicit DCE_T(const std::shared_ptr<DTE> &dte, std::shared_ptr<SpecificModule> dev, esp_netif_t *netif):
+        dte(dte), device(std::move(dev)), netif(dte, netif)
+    { }
+
+    ~DCE_T() = default;
+
+    /**
+     * @brief Set data mode!
+     */
+    void set_data()
+    {
+        set_mode(modem_mode::DATA_MODE);
+    }
+
+    void exit_data()
+    {
+        set_mode(modem_mode::COMMAND_MODE);
+    }
+
+    void set_cmux()
+    {
+        set_mode(modem_mode::CMUX_MODE);
+    }
+
+    SpecificModule *get_module()
+    {
+        return device.get();
+    }
+
+    command_result command(const std::string &command, got_line_cb got_line, uint32_t time_ms)
+    {
+        return dte->command(command, std::move(got_line), time_ms);
+    }
+
+    modem_mode guess_mode(bool with_cmux = false)
+    {
+        return mode.guess(dte.get(), with_cmux);
+    }
+
+    bool set_mode(modem_mode m)
+    {
+        return mode.set(dte.get(), device.get(), netif, m);
+    }
+
+    modem_mode get_mode()
+    {
+        return mode.get();
+    }
+
+    bool recover()
+    {
+        return dte->recover();
+    }
+
+#ifdef CONFIG_ESP_MODEM_URC_HANDLER
+    void set_urc(got_line_cb on_read_cb)
+    {
+        dte->set_urc_cb(on_read_cb);
+    }
+#endif
+
+    /**
+     * @brief Pauses/Unpauses network temporarily
+     * @param do_pause true to pause, false to unpause
+     * @param force true to ignore command failures and continue
+     * @return command_result of the underlying commands
+     */
+    command_result pause_netif(bool do_pause, bool force = false, int delay = 1000)
+    {
+        command_result result;
+        if (do_pause) {
+            netif.pause();
+            Task::Delay(delay); // Mandatory 1s pause before
+            dte->set_command_callbacks();
+            result = device->set_command_mode();
+        } else {
+            result = device->resume_data_mode();
+            if (result == command_result::OK || force) {
+                netif.resume();
+            }
+        }
+        return result;
+    }
+
+protected:
+    std::shared_ptr<DTE> dte;
+    std::shared_ptr<SpecificModule> device;
+    Netif netif;
+    DCE_Mode mode;
+};
+
+/**
+ * @}
+ */
+
+} // esp_modem

components/esp_modem/include/esp_modem_api.h

@@ -1,28 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-#pragma once
-
-#include "esp_err.h"
-#include "generate/esp_modem_command_declare.inc"
-#include "esp_modem_c_api_types.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-
-#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, num, ...) \
-        esp_err_t esp_modem_ ## name(esp_modem_dce_t *dce, ##__VA_ARGS__);
-
-DECLARE_ALL_COMMAND_APIS(declares esp_modem_<API>(esp_modem_t *dce, ...);)
-
-#undef ESP_MODEM_DECLARE_DCE_COMMAND
-
-
-#ifdef __cplusplus
-}
-#endif

components/esp_modem/include/generate/esp_modem_command_declare.inc

@@ -1,383 +0,0 @@
-// Copyright 2021-2022 Espressif Systems (Shanghai) PTE LTD
-//
-// 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.
-#pragma once
-
-#include "generate/esp_modem_command_declare_helper.inc"
-
-
-#define DECLARE_ALL_COMMAND_APIS(...) \
-/**
- * @brief Sends the initial AT sequence to sync up with the device
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(sync, command_result, 0) \
-    \
-/**
- * @brief Reads the operator name
- * @param[out] name operator name
- * @param[out] act access technology
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_operator_name, command_result, 2, STRING_OUT(p1, name), INT_OUT(p2, act)) \
-    \
-/**
- * @brief Stores current user profile
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(store_profile, command_result, 0) \
-    \
-/**
- * @brief Sets the supplied PIN code
- * @param[in] pin Pin
- * @return OK, FAIL or TIMEOUT
- */\
-ESP_MODEM_DECLARE_DCE_COMMAND(set_pin, command_result, 1, STRING_IN(p1, pin)) \
-    \
-/**
- * @brief Execute the supplied AT command in raw mode (doesn't append '\r' to command, returns everything)
- * @param[in] cmd String command that's send to DTE
- * @param[out] out Raw output from DTE
- * @param[in] pass Pattern in response for the API to return OK
- * @param[in] fail Pattern in response for the API to return FAIL
- * @param[in] timeout AT command timeout in milliseconds
- * @return OK, FAIL or TIMEOUT
- */\
-ESP_MODEM_DECLARE_DCE_COMMAND(at_raw, command_result, 5, STRING_IN(p1, cmd), STRING_OUT(p2, out), STRING_IN(p3, pass), STRING_IN(p4, fail), INT_IN(p5, timeout)) \
-    \
-/**
- * @brief Execute the supplied AT command
- * @param[in] cmd AT command
- * @param[out] out Command output string
- * @param[in] timeout AT command timeout in milliseconds
- * @return OK, FAIL or TIMEOUT
- */\
-ESP_MODEM_DECLARE_DCE_COMMAND(at, command_result, 3, STRING_IN(p1, cmd), STRING_OUT(p2, out), INT_IN(p3, timeout)) \
-    \
-/**
- * @brief Checks if the SIM needs a PIN
- * @param[out] pin_ok true if the SIM card doesn't need a PIN to unlock
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(read_pin, command_result, 1, BOOL_OUT(p1, pin_ok)) \
-    \
-/**
- * @brief Sets echo mode
- * @param[in] echo_on true if echo mode on (repeats the commands)
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_echo, command_result, 1, BOOL_IN(p1, echo_on)) \
-    \
-/**
- * @brief Sets the Txt or Pdu mode for SMS (only txt is supported)
- * @param[in] txt true if txt mode
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(sms_txt_mode, command_result, 1, BOOL_IN(p1, txt)) \
-    \
-/**
- * @brief Sets the default (GSM) character set
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(sms_character_set, command_result, 0) \
-    \
-/**
- * @brief Sends SMS message in txt mode
- * @param[in] number Phone number to send the message to
- * @param[in] message Text message to be sent
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(send_sms, command_result, 2, STRING_IN(p1, number), STRING_IN(p2, message)) \
-    \
-/**
- * @brief Resumes data mode (Switches back to the data mode, which was temporarily suspended)
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(resume_data_mode, command_result, 0) \
-    \
-/**
- * @brief Sets php context
- * @param[in] p1 PdP context struct to setup modem cellular connection
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_pdp_context, command_result, 1, STRUCT_OUT(PdpContext, p1)) \
-    \
-/**
- * @brief Switches to the command mode
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_command_mode, command_result, 0) \
-    \
-/**
- * @brief Switches to the CMUX mode
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_cmux, command_result, 0) \
-    \
-/**
- * @brief Reads the IMSI number
- * @param[out] imsi Module's IMSI number
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_imsi, command_result, 1, STRING_OUT(p1, imsi)) \
-    \
-/**
- * @brief Reads the IMEI number
- * @param[out] imei Module's IMEI number
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_imei, command_result, 1, STRING_OUT(p1, imei)) \
-    \
-/**
- * @brief Reads the module name
- * @param[out] name module name
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_module_name, command_result, 1, STRING_OUT(p1, name)) \
-    \
-/**
- * @brief Sets the modem to data mode
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_data_mode, command_result, 0) \
-    \
-/**
- * @brief Get Signal quality
- * @param[out] rssi signal strength indication
- * @param[out] ber channel bit error rate
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_signal_quality, command_result, 2, INT_OUT(p1, rssi), INT_OUT(p2, ber)) \
-    \
-/**
- * @brief Sets HW control flow
- * @param[in] dce_flow 0=none, 2=RTS hw flow control of DCE
- * @param[in] dte_flow 0=none, 2=CTS hw flow control of DTE
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_flow_control, command_result, 2, INT_IN(p1, dce_flow), INT_IN(p2, dte_flow)) \
-    \
-/**
- * @brief Hangs up current data call
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(hang_up, command_result, 0) \
-    \
-/**
- * @brief Get voltage levels of modem power up circuitry
- * @param[out] voltage Current status in mV
- * @param[out] bcs charge status (-1-Not available, 0-Not charging, 1-Charging, 2-Charging done)
- * @param[out] bcl 1-100% battery capacity, -1-Not available
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_battery_status, command_result, 3, INT_OUT(p1, voltage), INT_OUT(p2, bcs), INT_OUT(p3, bcl)) \
-    \
-/**
- * @brief Power down the module
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(power_down, command_result, 0) \
-    \
-/**
- * @brief Reset the module
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(reset, command_result, 0) \
-    \
-/**
- * @brief Configures the baudrate
- * @param[in] baud Desired baud rate of the DTE
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_baud, command_result, 1, INT_IN(p1, baud)) \
-    \
-/**
- * @brief Force an attempt to connect to a specific operator
- * @param[in] mode mode of attempt
- * mode=0 - automatic
- * mode=1 - manual
- * mode=2 - deregister
- * mode=3 - set format for read operation
- * mode=4 - manual with fallback to automatic
- * @param[in] format what format the operator is given in
- * format=0 - long format
- * format=1 - short format
- * format=2 - numeric
- * @param[in] oper the operator to connect to
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_operator, command_result, 3, INT_IN(p1, mode), INT_IN(p2, format), STRING_IN(p3, oper)) \
-    \
-/**
- * @brief Attach or detach from the GPRS service
- * @param[in] state 1-attach 0-detach
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_network_attachment_state, command_result, 1, INT_IN(p1, state)) \
-    \
-/**
- * @brief Get network attachment state
- * @param[out] state 1-attached 0-detached
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_network_attachment_state, command_result, 1, INT_OUT(p1, state)) \
-    \
-/**
- * @brief What mode the radio should be set to
- * @param[in] state state 1-full 0-minimum ...
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_radio_state, command_result, 1, INT_IN(p1, state)) \
-    \
-/**
- * @brief Get current radio state
- * @param[out] state 1-full 0-minimum ...
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_radio_state, command_result, 1, INT_OUT(p1, state)) \
-    \
-/**
- * @brief Set network mode
- * @param[in] mode preferred mode
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_network_mode, command_result, 1, INT_IN(p1, mode)) \
-    \
-/**
- * @brief Preferred network mode (CAT-M and/or NB-IoT)
- * @param[in] mode preferred selection
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_preferred_mode, command_result, 1, INT_IN(p1, mode)) \
-    \
-/**
- * @brief Set network bands for CAT-M or NB-IoT
- * @param[in] mode CAT-M or NB-IoT
- * @param[in] bands bitmap in hex representing bands
- * @param[in] size size of teh bands bitmap
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_network_bands, command_result, 3, STRING_IN(p1, mode), INTEGER_LIST_IN(p2, bands), INT_IN(p3, size)) \
-    \
-/**
- * @brief Show network system mode
- * @param[out] mode current network mode
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_network_system_mode, command_result, 1, INT_OUT(p1, mode)) \
-    \
-/**
- * @brief GNSS power control
- * @param[out] mode power mode (0 - off, 1 - on)
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(set_gnss_power_mode, command_result, 1, INT_IN(p1, mode)) \
-    \
-/**
- * @brief GNSS power control
- * @param[out] mode power mode (0 - off, 1 - on)
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_gnss_power_mode, command_result, 1, INT_OUT(p1, mode)) \
-    \
-/**
- * @brief Configure PSM
- * @param[in] mode psm mode (0 - off, 1 - on, 2 - off & discard stored params)
- * @return OK, FAIL or TIMEOUT
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(config_psm, command_result, 3, INT_IN(p1, mode), STRING_IN(p2, tau), STRING_IN(p3, active_time)) \
-    \
-/**
- * @brief Configure CEREG urc
- * @param[in] value
- * value = 0 - Disable network URC
- * value = 1 - Enable network URC
- * value = 2 - Enable network URC with location information
- * value = 3 - Enable network URC with location information and EMM cause
- * value = 4 - Enable network URC with location information and PSM value
- * value = 5 - Enable network URC with location information and PSM value, EMM cause
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(config_network_registration_urc, command_result, 1, INT_IN(p1, value)) \
-    \
-/**
- *  @brief Gets the current network registration state
- *  @param[out] state The current network registration state
- *  state = 0 - Not registered, MT is not currently searching an operator to register to
- *  state = 1 - Registered, home network
- *  state = 2 - Not registered, but MT is currently trying to attach or searching an operator to register to
- *  state = 3 - Registration denied
- *  state = 4 - Unknown
- *  state = 5 - Registered, Roaming
- *  state = 6 - Registered, for SMS only, home network (NB-IoT only)
- *  state = 7 - Registered, for SMS only, roaming (NB-IoT only)
- *  state = 8 - Attached for emergency bearer services only
- *  state = 9 - Registered for CSFB not preferred, home network
- *  state = 10 - Registered for CSFB not preferred, roaming
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(get_network_registration_state, command_result, 1, INT_OUT(p1,state)) \
-    \
-/**
- *  @brief Configures the mobile termination error (+CME ERROR)
- *  @param[in] mode The form of the final result code
- *  mode = 0 - Disable, use and send ERROR instead
- *  mode = 1 - Enable, use numeric error values
- *  mode = 2 - Enable, result code and use verbose error values
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(config_mobile_termination_error, command_result, 1, INT_IN(p1, mode)) \
-    \
-/**
- * @brief Configure eDRX
- * @param[in] mode
- * mode = 0 - Disable
- * mode = 1 - Enable
- * mode = 2 - Enable + URC
- * mode = 3 - Disable + Reset parameter.
- * @param[in] access_technology
- * act = 0 - ACT is not using eDRX (used in URC)
- * act = 1 - EC-GSM-IoT (A/Gb mode)
- * act = 2 - GSM (A/Gb mode)
- * act = 3 - UTRAN (Iu mode)
- * act = 4 - E-UTRAN (WB-S1 mode)
- * act = 5 - E-UTRAN (NB-S1 mode)
- * @param[in] edrx_value nible string containing encoded eDRX time
- * @param[in] ptw_value nible string containing encoded Paging Time Window
- */ \
-ESP_MODEM_DECLARE_DCE_COMMAND(config_edrx, command_result, 3, INT_IN(p1, mode), INT_IN(p2, access_technology), STRING_IN(p3, edrx_value)) \
-
-#ifdef GENERATE_DOCS
-// cat ../include/generate/esp_modem_command_declare.inc | clang++ -E -P -CC  -xc++ -I../include -DGENERATE_DOCS  - | sed -n '1,/DCE command documentation/!p'
-// cat ../include/generate/esp_modem_command_declare.inc | clang -E -P -CC  -xc -I../include -DGENERATE_DOCS  - | sed -n '1,/DCE command documentation/!p' > c_api.h
-// cat ../include/generate/esp_modem_command_declare.inc | clang -E -P  -xc -I../include -DGENERATE_DOCS -DGENERATE_RST_LINKS - | sed 's/NL/\n/g' > cxx_api_links.rst
-
-// call parametrs by names for documentation
-#undef _ARG
-#define _ARG(param, name) name
-//  --- DCE command documentation starts here ---
-#ifdef __cplusplus
-class esp_modem::DCE : public DCE_T<GenericModule> {
-public:
-    using DCE_T<GenericModule>::DCE_T;
-#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, TEMPLATE_ARG, ...) return_type name (__VA_ARGS__);
-#elif defined(GENERATE_RST_LINKS)
-#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, TEMPLATE_ARG, ...) NL- :cpp:func:`esp_modem::DCE::name`
-#else
-#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, TEMPLATE_ARG, ...) return_type esp_modem_ ## name (__VA_ARGS__);
-#endif
-
-    DECLARE_ALL_COMMAND_APIS()
-
-#ifdef __cplusplus
-};
-#endif
-
-#endif

components/esp_modem/include/generate/esp_modem_command_declare_helper.inc

@@ -1,27 +0,0 @@
-
-
-// Parameters
-// * handle different parameters for C++ and C API
-// * make parameter unique names, so they could be easily referenced and forwarded
-#define INT_IN(param, name) int  _ARG(param, name)
-#ifdef __cplusplus
-#define _ARG(param, name) param
-#include <string>
-#define STRING_IN(param, name) const std::string& _ARG(param, name)
-#define STRING_OUT(param, name) std::string& _ARG(param, name)
-#define BOOL_IN(param, name) const bool  _ARG(param, name)
-#define BOOL_OUT(param, name) bool&  _ARG(param, name)
-#define INT_OUT(param, name) int&  _ARG(param, name)
-#define INTEGER_LIST_IN(param, name) const int* _ARG(param, name)
-
-#define STRUCT_OUT(struct_name, p1)  struct_name& p1
-#else
-#define _ARG(param, name) name
-#define STRING_IN(param, name) const char* _ARG(param, name)
-#define STRING_OUT(param, name) char* _ARG(param, name)
-#define BOOL_IN(param, name) const bool _ARG(param, name)
-#define BOOL_OUT(param, name) bool* _ARG(param, name)
-#define INT_OUT(param, name) int* _ARG(param, name)
-#define INTEGER_LIST_IN(param, name) const int* _ARG(param, name)
-#define STRUCT_OUT(struct_name, p1)  esp_modem_ ## struct_name ## _t* p1
-#endif