fix(modem): fixed minor code mistakes.

This commit is contained in:
robbedptechnics
2025-03-19 15:46:04 +01:00
parent b97dfc08b8
commit 317faf89ff
8 changed files with 123 additions and 123 deletions

View File

@ -2,7 +2,7 @@
# See https://pre-commit.com/hooks.html for more hooks # See https://pre-commit.com/hooks.html for more hooks
repos: repos:
- repo: https://github.com/pre-commit/pre-commit-hooks - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0 rev: v5.0.0
hooks: hooks:
- id: check-yaml - id: check-yaml
- id: check-added-large-files - id: check-added-large-files
@ -13,12 +13,12 @@ repos:
- id: mixed-line-ending - id: mixed-line-ending
- id: debug-statements - id: debug-statements
- repo: https://github.com/pycqa/flake8 - repo: https://github.com/pycqa/flake8
rev: 5.0.4 rev: 7.1.2
hooks: hooks:
- id: flake8 - id: flake8
args: ['--config=.flake8', '--tee', '--benchmark'] args: ['--config=.flake8', '--tee', '--benchmark']
- repo: https://github.com/pre-commit/mirrors-mypy - repo: https://github.com/pre-commit/mirrors-mypy
rev: v0.981 rev: v1.14.1
hooks: hooks:
- id: mypy - id: mypy
exclude: > exclude: >
@ -39,25 +39,25 @@ repos:
hooks: hooks:
- id: isort - id: isort
- repo: https://github.com/myint/eradicate/ - repo: https://github.com/myint/eradicate/
rev: v2.1.0 rev: 2.3.0
hooks: hooks:
- id: eradicate - id: eradicate
- repo: https://github.com/espressif/check-copyright/ - repo: https://github.com/espressif/check-copyright/
rev: v1.0.3 rev: v1.1.0
hooks: hooks:
- id: check-copyright - id: check-copyright
args: ['--ignore', 'ci/check_copyright_ignore.txt', '--config', 'ci/check_copyright_config.yaml'] args: ['--ignore', 'ci/check_copyright_ignore.txt', '--config', 'ci/check_copyright_config.yaml']
- repo: https://github.com/igrr/astyle_py.git - repo: https://github.com/igrr/astyle_py.git
rev: v1.0.5 rev: v1.1.0
hooks: hooks:
- id: astyle_py - id: astyle_py
args: ['--style=otbs', '--attach-namespaces', '--attach-classes', '--indent=spaces=4', '--convert-tabs', '--align-reference=name', '--keep-one-line-statements', '--pad-header', '--pad-oper', '--unpad-paren', '--max-continuation-indent=120', '--exclude-list=ci/ignore_astyle.txt'] args: ['--style=otbs', '--attach-namespaces', '--attach-classes', '--indent=spaces=4', '--convert-tabs', '--align-reference=name', '--keep-one-line-statements', '--pad-header', '--pad-oper', '--unpad-paren', '--max-continuation-indent=120', '--exclude-list=ci/ignore_astyle.txt']
- repo: https://github.com/commitizen-tools/commitizen - repo: https://github.com/commitizen-tools/commitizen
rev: v2.42.1 rev: v4.4.1
hooks: hooks:
- id: commitizen - id: commitizen
- id: commitizen-branch - id: commitizen-branch
stages: [push, manual] stages: [pre-push, manual]
- repo: local - repo: local
hooks: hooks:
- id: commit message scopes - id: commit message scopes

View File

@ -0,0 +1,19 @@
/*
* SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <string>
#include <list>
#include "esp_log.h"
#include "cxx_include/esp_modem_dte.hpp"
#include "cxx_include/esp_modem_dce_module.hpp"
static const char *TAG = "command_lib";
namespace esp_modem::dce_commands {
command_result generic_command(CommandableIf *t, const std::string &command,
const std::list<std::string_view> &pass_phrase,
const std::list<std::string_view> &fail_phrase,
uint32_t timeout_ms);
}

View File

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD * SPDX-FileCopyrightText: 2021-2025 Espressif Systems (Shanghai) CO LTD
* *
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
@ -115,7 +115,7 @@ public:
#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, num, ...) \ #define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, num, ...) \
virtual return_type name(__VA_ARGS__); virtual return_type name(__VA_ARGS__);
DECLARE_ALL_COMMAND_APIS(virtual return_type name(...); ) DECLARE_ALL_COMMAND_APIS(virtual return_type name(...);)
#undef ESP_MODEM_DECLARE_DCE_COMMAND #undef ESP_MODEM_DECLARE_DCE_COMMAND
@ -177,8 +177,7 @@ public:
command_result set_pdp_context(PdpContext &pdp) override; command_result set_pdp_context(PdpContext &pdp) override;
}; };
class SQNGM02S : public GenericModule class SQNGM02S : public GenericModule {
{
using GenericModule::GenericModule; using GenericModule::GenericModule;
public: public:

View File

@ -43,6 +43,8 @@ inline dce_factory::ModemType convert_modem_enum(esp_modem_dce_device_t module)
return esp_modem::dce_factory::ModemType::BG96; return esp_modem::dce_factory::ModemType::BG96;
case ESP_MODEM_DCE_SIM800: case ESP_MODEM_DCE_SIM800:
return esp_modem::dce_factory::ModemType::SIM800; return esp_modem::dce_factory::ModemType::SIM800;
case ESP_MODEM_DCE_SQNGM02S:
return esp_modem::dce_factory::ModemType::SQNGM02S;
default: default:
case ESP_MODEM_DCE_GENERIC: case ESP_MODEM_DCE_GENERIC:
return esp_modem::dce_factory::ModemType::GenericModule; return esp_modem::dce_factory::ModemType::GenericModule;

View File

@ -352,7 +352,7 @@ ESP_MODEM_DECLARE_DCE_COMMAND(config_mobile_termination_error, command_result, 1
* @param[in] edrx_value nible string containing encoded eDRX time * @param[in] edrx_value nible string containing encoded eDRX time
* @param[in] ptw_value nible string containing encoded Paging Time Window * @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), STRING_IN(p4, ptw_value)) \ 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 #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'

View File

@ -486,7 +486,7 @@ extern "C" esp_err_t esp_modem_config_mobile_termination_error(esp_modem_dce_t *
return command_response_to_esp_err(dce_wrap->dce->config_mobile_termination_error(mode)); return command_response_to_esp_err(dce_wrap->dce->config_mobile_termination_error(mode));
} }
extern "C" esp_err_t esp_modem_config_edrx(esp_modem_dce_t *dce, int mode, int access_technology, const char *edrx_value, const char *ptw_value) extern "C" esp_err_t esp_modem_config_edrx(esp_modem_dce_t *dce_wrap, int mode, int access_technology, const char *edrx_value, const char *ptw_value)
{ {
if (dce_wrap == nullptr || dce_wrap->dce == nullptr || mode > 3 || access_technology > 5) { if (dce_wrap == nullptr || dce_wrap->dce == nullptr || mode > 3 || access_technology > 5) {
return ESP_ERR_INVALID_ARG; return ESP_ERR_INVALID_ARG;

View File

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD * SPDX-FileCopyrightText: 2021-2025 Espressif Systems (Shanghai) CO LTD
* *
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
@ -12,14 +12,15 @@
#include "cxx_include/esp_modem_command_library.hpp" #include "cxx_include/esp_modem_command_library.hpp"
#include "cxx_include/esp_modem_command_library_utils.hpp" #include "cxx_include/esp_modem_command_library_utils.hpp"
#include "cxx17_include/esp_modem_command_library_17.hpp"
namespace esp_modem::dce_commands { namespace esp_modem::dce_commands {
static const char *TAG = "command_lib";
static command_result generic_command(CommandableIf *t, const std::string &command, command_result generic_command(CommandableIf *t, const std::string &command,
const std::list<std::string_view> &pass_phrase, const std::list<std::string_view> &pass_phrase,
const std::list<std::string_view> &fail_phrase, const std::list<std::string_view> &fail_phrase,
uint32_t timeout_ms) uint32_t timeout_ms)
{ {
ESP_LOGD(TAG, "%s command %s\n", __func__, command.c_str()); ESP_LOGD(TAG, "%s command %s\n", __func__, command.c_str());
return t->command(command, [&](uint8_t *data, size_t len) { return t->command(command, [&](uint8_t *data, size_t len) {
@ -45,7 +46,7 @@ command_result generic_command(CommandableIf *t, const std::string &command,
const std::string &pass_phrase, const std::string &pass_phrase,
const std::string &fail_phrase, uint32_t timeout_ms) const std::string &fail_phrase, uint32_t timeout_ms)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
const auto pass = std::list<std::string_view>({pass_phrase}); const auto pass = std::list<std::string_view>({pass_phrase});
const auto fail = std::list<std::string_view>({fail_phrase}); const auto fail = std::list<std::string_view>({fail_phrase});
return generic_command(t, command, pass, fail, timeout_ms); return generic_command(t, command, pass, fail, timeout_ms);
@ -81,7 +82,7 @@ bool set(std::span<char> &dest, std::string_view &src)
template <typename T> command_result generic_get_string(CommandableIf *t, const std::string &command, T &output, uint32_t timeout_ms) template <typename T> command_result generic_get_string(CommandableIf *t, const std::string &command, T &output, uint32_t timeout_ms)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return t->command(command, [&](uint8_t *data, size_t len) { return t->command(command, [&](uint8_t *data, size_t len) {
size_t pos = 0; size_t pos = 0;
std::string_view response((char *)data, len); std::string_view response((char *)data, len);
@ -110,67 +111,67 @@ template <typename T> command_result generic_get_string(CommandableIf *t, const
command_result generic_command_common(CommandableIf *t, const std::string &command, uint32_t timeout_ms) command_result generic_command_common(CommandableIf *t, const std::string &command, uint32_t timeout_ms)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, command, "OK", "ERROR", timeout_ms); return generic_command(t, command, "OK", "ERROR", timeout_ms);
} }
command_result sync(CommandableIf *t) command_result sync(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT\r"); return generic_command_common(t, "AT\r");
} }
command_result store_profile(CommandableIf *t) command_result store_profile(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT&W\r"); return generic_command_common(t, "AT&W\r");
} }
command_result power_down(CommandableIf *t) command_result power_down(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, "AT+QPOWD=1\r", "POWERED DOWN", "ERROR", 1000); return generic_command(t, "AT+QPOWD=1\r", "POWERED DOWN", "ERROR", 1000);
} }
command_result power_down_sim76xx(CommandableIf *t) command_result power_down_sim76xx(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CPOF\r", 1000); return generic_command_common(t, "AT+CPOF\r", 1000);
} }
command_result power_down_sim70xx(CommandableIf *t) command_result power_down_sim70xx(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, "AT+CPOWD=1\r", "POWER DOWN", "ERROR", 1000); return generic_command(t, "AT+CPOWD=1\r", "POWER DOWN", "ERROR", 1000);
} }
command_result power_down_sim8xx(CommandableIf *t) command_result power_down_sim8xx(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, "AT+CPOWD=1\r", "POWER DOWN", "ERROR", 1000); return generic_command(t, "AT+CPOWD=1\r", "POWER DOWN", "ERROR", 1000);
} }
command_result reset(CommandableIf *t) command_result reset(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, "AT+CRESET\r", "PB DONE", "ERROR", 60000); return generic_command(t, "AT+CRESET\r", "PB DONE", "ERROR", 60000);
} }
command_result set_baud(CommandableIf *t, int baud) command_result set_baud(CommandableIf *t, int baud)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+IPR=" + std::to_string(baud) + "\r"); return generic_command_common(t, "AT+IPR=" + std::to_string(baud) + "\r");
} }
command_result hang_up(CommandableIf *t) command_result hang_up(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "ATH\r", 90000); return generic_command_common(t, "ATH\r", 90000);
} }
command_result get_battery_status(CommandableIf *t, int &voltage, int &bcs, int &bcl) command_result get_battery_status(CommandableIf *t, int &voltage, int &bcs, int &bcl)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CBC\r", out); auto ret = generic_get_string(t, "AT+CBC\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -206,7 +207,7 @@ command_result get_battery_status(CommandableIf *t, int &voltage, int &bcs, int
command_result get_battery_status_sim7xxx(CommandableIf *t, int &voltage, int &bcs, int &bcl) command_result get_battery_status_sim7xxx(CommandableIf *t, int &voltage, int &bcs, int &bcl)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CBC\r", out); auto ret = generic_get_string(t, "AT+CBC\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -235,13 +236,13 @@ command_result get_battery_status_sim7xxx(CommandableIf *t, int &voltage, int &b
command_result set_flow_control(CommandableIf *t, int dce_flow, int dte_flow) command_result set_flow_control(CommandableIf *t, int dce_flow, int dte_flow)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+IFC=" + std::to_string(dce_flow) + "," + std::to_string(dte_flow) + "\r"); return generic_command_common(t, "AT+IFC=" + std::to_string(dce_flow) + "," + std::to_string(dte_flow) + "\r");
} }
command_result get_operator_name(CommandableIf *t, std::string &operator_name, int &act) command_result get_operator_name(CommandableIf *t, std::string &operator_name, int &act)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+COPS?\r", out, 75000); auto ret = generic_get_string(t, "AT+COPS?\r", out, 75000);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -272,7 +273,7 @@ command_result get_operator_name(CommandableIf *t, std::string &operator_name, i
command_result set_echo(CommandableIf *t, bool on) command_result set_echo(CommandableIf *t, bool on)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
if (on) { if (on) {
return generic_command_common(t, "ATE1\r"); return generic_command_common(t, "ATE1\r");
} }
@ -281,7 +282,7 @@ command_result set_echo(CommandableIf *t, bool on)
command_result set_pdp_context(CommandableIf *t, PdpContext &pdp, uint32_t timeout_ms) command_result set_pdp_context(CommandableIf *t, PdpContext &pdp, uint32_t timeout_ms)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string pdp_command = "AT+CGDCONT=" + std::to_string(pdp.context_id) + std::string pdp_command = "AT+CGDCONT=" + std::to_string(pdp.context_id) +
",\"" + pdp.protocol_type + "\",\"" + pdp.apn + "\"\r"; ",\"" + pdp.protocol_type + "\",\"" + pdp.apn + "\"\r";
return generic_command_common(t, pdp_command, timeout_ms); return generic_command_common(t, pdp_command, timeout_ms);
@ -294,25 +295,25 @@ command_result set_pdp_context(CommandableIf *t, PdpContext &pdp)
command_result set_data_mode(CommandableIf *t) command_result set_data_mode(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, "ATD*99#\r", "CONNECT", "ERROR", 5000); return generic_command(t, "ATD*99#\r", "CONNECT", "ERROR", 5000);
} }
command_result set_data_mode_alt(CommandableIf *t) command_result set_data_mode_alt(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, "ATD*99##\r", "CONNECT", "ERROR", 5000); return generic_command(t, "ATD*99##\r", "CONNECT", "ERROR", 5000);
} }
command_result resume_data_mode(CommandableIf *t) command_result resume_data_mode(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command(t, "ATO\r", "CONNECT", "ERROR", 5000); return generic_command(t, "ATO\r", "CONNECT", "ERROR", 5000);
} }
command_result set_command_mode(CommandableIf *t) command_result set_command_mode(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
const auto pass = std::list<std::string_view>({"NO CARRIER", "OK"}); const auto pass = std::list<std::string_view>({"NO CARRIER", "OK"});
const auto fail = std::list<std::string_view>({"ERROR"}); const auto fail = std::list<std::string_view>({"ERROR"});
return generic_command(t, "+++", pass, fail, 5000); return generic_command(t, "+++", pass, fail, 5000);
@ -320,25 +321,25 @@ command_result set_command_mode(CommandableIf *t)
command_result get_imsi(CommandableIf *t, std::string &imsi_number) command_result get_imsi(CommandableIf *t, std::string &imsi_number)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_get_string(t, "AT+CIMI\r", imsi_number, 5000); return generic_get_string(t, "AT+CIMI\r", imsi_number, 5000);
} }
command_result get_imei(CommandableIf *t, std::string &out) command_result get_imei(CommandableIf *t, std::string &out)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_get_string(t, "AT+CGSN\r", out, 5000); return generic_get_string(t, "AT+CGSN\r", out, 5000);
} }
command_result get_module_name(CommandableIf *t, std::string &out) command_result get_module_name(CommandableIf *t, std::string &out)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_get_string(t, "AT+CGMM\r", out, 5000); return generic_get_string(t, "AT+CGMM\r", out, 5000);
} }
command_result sms_txt_mode(CommandableIf *t, bool txt = true) command_result sms_txt_mode(CommandableIf *t, bool txt = true)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
if (txt) { if (txt) {
return generic_command_common(t, "AT+CMGF=1\r"); // Text mode (default) return generic_command_common(t, "AT+CMGF=1\r"); // Text mode (default)
} }
@ -348,13 +349,13 @@ command_result sms_txt_mode(CommandableIf *t, bool txt = true)
command_result sms_character_set(CommandableIf *t) command_result sms_character_set(CommandableIf *t)
{ {
// Sets the default GSM character set // Sets the default GSM character set
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CSCS=\"GSM\"\r"); return generic_command_common(t, "AT+CSCS=\"GSM\"\r");
} }
command_result send_sms(CommandableIf *t, const std::string &number, const std::string &message) command_result send_sms(CommandableIf *t, const std::string &number, const std::string &message)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
auto ret = t->command("AT+CMGS=\"" + number + "\"\r", [&](uint8_t *data, size_t len) { auto ret = t->command("AT+CMGS=\"" + number + "\"\r", [&](uint8_t *data, size_t len) {
std::string_view response((char *)data, len); std::string_view response((char *)data, len);
ESP_LOGD(TAG, "Send SMS response %.*s", static_cast<int>(response.size()), response.data()); ESP_LOGD(TAG, "Send SMS response %.*s", static_cast<int>(response.size()), response.data());
@ -372,13 +373,13 @@ command_result send_sms(CommandableIf *t, const std::string &number, const std::
command_result set_cmux(CommandableIf *t) command_result set_cmux(CommandableIf *t)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CMUX=0\r"); return generic_command_common(t, "AT+CMUX=0\r");
} }
command_result read_pin(CommandableIf *t, bool &pin_ok) command_result read_pin(CommandableIf *t, bool &pin_ok)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CPIN?\r", out); auto ret = generic_get_string(t, "AT+CPIN?\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -400,21 +401,21 @@ command_result read_pin(CommandableIf *t, bool &pin_ok)
command_result set_pin(CommandableIf *t, const std::string &pin) command_result set_pin(CommandableIf *t, const std::string &pin)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string set_pin_command = "AT+CPIN=" + pin + "\r"; std::string set_pin_command = "AT+CPIN=" + pin + "\r";
return generic_command_common(t, set_pin_command); return generic_command_common(t, set_pin_command);
} }
command_result at(CommandableIf *t, const std::string &cmd, std::string &out, int timeout = 500) command_result at(CommandableIf *t, const std::string &cmd, std::string &out, int timeout = 500)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string at_command = cmd + "\r"; std::string at_command = cmd + "\r";
return generic_get_string(t, at_command, out, timeout); return generic_get_string(t, at_command, out, timeout);
} }
command_result at_raw(CommandableIf *t, const std::string &cmd, std::string &out, const std::string &pass, const std::string &fail, int timeout = 500) command_result at_raw(CommandableIf *t, const std::string &cmd, std::string &out, const std::string &pass, const std::string &fail, int timeout = 500)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return t->command(cmd, [&](uint8_t *data, size_t len) { return t->command(cmd, [&](uint8_t *data, size_t len) {
out.assign(reinterpret_cast<char *>(data), len); out.assign(reinterpret_cast<char *>(data), len);
@ -430,7 +431,7 @@ command_result at_raw(CommandableIf *t, const std::string &cmd, std::string &out
command_result get_signal_quality(CommandableIf *t, int &rssi, int &ber) command_result get_signal_quality(CommandableIf *t, int &rssi, int &ber)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CSQ\r", out); auto ret = generic_get_string(t, "AT+CSQ\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -456,19 +457,19 @@ command_result get_signal_quality(CommandableIf *t, int &rssi, int &ber)
command_result set_operator(CommandableIf *t, int mode, int format, const std::string &oper) command_result set_operator(CommandableIf *t, int mode, int format, const std::string &oper)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+COPS=" + std::to_string(mode) + "," + std::to_string(format) + ",\"" + oper + "\"\r", 90000); return generic_command_common(t, "AT+COPS=" + std::to_string(mode) + "," + std::to_string(format) + ",\"" + oper + "\"\r", 90000);
} }
command_result set_network_attachment_state(CommandableIf *t, int state) command_result set_network_attachment_state(CommandableIf *t, int state)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CGATT=" + std::to_string(state) + "\r"); return generic_command_common(t, "AT+CGATT=" + std::to_string(state) + "\r");
} }
command_result get_network_attachment_state(CommandableIf *t, int &state) command_result get_network_attachment_state(CommandableIf *t, int &state)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CGATT?\r", out); auto ret = generic_get_string(t, "AT+CGATT?\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -489,13 +490,13 @@ command_result get_network_attachment_state(CommandableIf *t, int &state)
command_result set_radio_state(CommandableIf *t, int state) command_result set_radio_state(CommandableIf *t, int state)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CFUN=" + std::to_string(state) + "\r", 15000); return generic_command_common(t, "AT+CFUN=" + std::to_string(state) + "\r", 15000);
} }
command_result get_radio_state(CommandableIf *t, int &state) command_result get_radio_state(CommandableIf *t, int &state)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CFUN?\r", out); auto ret = generic_get_string(t, "AT+CFUN?\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -516,19 +517,19 @@ command_result get_radio_state(CommandableIf *t, int &state)
command_result set_network_mode(CommandableIf *t, int mode) command_result set_network_mode(CommandableIf *t, int mode)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CNMP=" + std::to_string(mode) + "\r"); return generic_command_common(t, "AT+CNMP=" + std::to_string(mode) + "\r");
} }
command_result set_preferred_mode(CommandableIf *t, int mode) command_result set_preferred_mode(CommandableIf *t, int mode)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CMNB=" + std::to_string(mode) + "\r"); return generic_command_common(t, "AT+CMNB=" + std::to_string(mode) + "\r");
} }
command_result set_network_bands(CommandableIf *t, const std::string &mode, const int *bands, int size) command_result set_network_bands(CommandableIf *t, const std::string &mode, const int *bands, int size)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string band_string = ""; std::string band_string = "";
for (int i = 0; i < size - 1; ++i) { for (int i = 0; i < size - 1; ++i) {
band_string += std::to_string(bands[i]) + ","; band_string += std::to_string(bands[i]) + ",";
@ -542,7 +543,7 @@ command_result set_network_bands(CommandableIf *t, const std::string &mode, cons
// any_mode = "0xFFFFFFFF7FFFFFFF"; // any_mode = "0xFFFFFFFF7FFFFFFF";
command_result set_network_bands_sim76xx(CommandableIf *t, const std::string &mode, const int *bands, int size) command_result set_network_bands_sim76xx(CommandableIf *t, const std::string &mode, const int *bands, int size)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
static const char *hexDigits = "0123456789ABCDEF"; static const char *hexDigits = "0123456789ABCDEF";
uint64_t band_bits = 0; uint64_t band_bits = 0;
int hex_len = 16; int hex_len = 16;
@ -560,7 +561,7 @@ command_result set_network_bands_sim76xx(CommandableIf *t, const std::string &mo
command_result get_network_system_mode(CommandableIf *t, int &mode) command_result get_network_system_mode(CommandableIf *t, int &mode)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CNSMOD?\r", out); auto ret = generic_get_string(t, "AT+CNSMOD?\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -582,13 +583,13 @@ command_result get_network_system_mode(CommandableIf *t, int &mode)
command_result set_gnss_power_mode(CommandableIf *t, int mode) command_result set_gnss_power_mode(CommandableIf *t, int mode)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CGNSPWR=" + std::to_string(mode) + "\r"); return generic_command_common(t, "AT+CGNSPWR=" + std::to_string(mode) + "\r");
} }
command_result get_gnss_power_mode(CommandableIf *t, int &mode) command_result get_gnss_power_mode(CommandableIf *t, int &mode)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
auto ret = generic_get_string(t, "AT+CGNSPWR?\r", out); auto ret = generic_get_string(t, "AT+CGNSPWR?\r", out);
if (ret != command_result::OK) { if (ret != command_result::OK) {
@ -610,20 +611,19 @@ command_result get_gnss_power_mode(CommandableIf *t, int &mode)
command_result config_psm(CommandableIf *t, int enabled, const std::string &TAU, const std::string &activeTime) command_result config_psm(CommandableIf *t, int enabled, const std::string &TAU, const std::string &activeTime)
{ {
ESP_LOGV(TAG, "%s", __func__); ESP_LOGV(TAG, "%s", __func__);
if (enabled == true) if (enabled == true) {
{ return generic_command_common(t, "AT+CPSMS=1,,,\"" + TAU + "\"" + ",\"" + activeTime + "\"\r", 5000);
return generic_command_common(t, "AT+CPSMS=1,,,\"" + TAU + "\"" + ",\"" + activeTime + "\"\r", 500);
} }
return generic_command_common(t, "AT+CPSMS=" + std::to_string(enabled), 500); return generic_command_common(t, "AT+CPSMS=" + std::to_string(enabled) + "\r", 5000);
} }
command_result config_network_registration_urc(CommandableIf *t, int value) command_result config_network_registration_urc(CommandableIf *t, int value)
{ {
ESP_LOGV(TAG, "%s", __func__); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t,"AT+CEREG=" + std::to_string(state) + "\r", 500); return generic_command_common(t, "AT+CEREG=" + std::to_string(value) + "\r", 500);
} }
command_result get_network_registration_state(CommandableIf *t, int& state) command_result get_network_registration_state(CommandableIf *t, int &state)
{ {
ESP_LOGV(TAG, "%s", __func__); ESP_LOGV(TAG, "%s", __func__);
std::string out; std::string out;
@ -640,7 +640,7 @@ command_result get_network_registration_state(CommandableIf *t, int& state)
return command_result::FAIL; return command_result::FAIL;
} }
if (out.find(pattern) == std::string::npos || (state_pos_end = out.find(',',state_pos_start)) == std::string::npos){ if (out.find(pattern) == std::string::npos || (state_pos_end = out.find(',', state_pos_start)) == std::string::npos) {
if (std::from_chars(out.data() + state_pos_start, out.data() + out.size(), state).ec == std::errc::invalid_argument) { if (std::from_chars(out.data() + state_pos_start, out.data() + out.size(), state).ec == std::errc::invalid_argument) {
return command_result::FAIL; return command_result::FAIL;
} }
@ -656,25 +656,22 @@ command_result config_mobile_termination_error(CommandableIf *t, int value)
ESP_LOGV(TAG, "%s", __func__); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CMEE=" + std::to_string(value) + "\r"); return generic_command_common(t, "AT+CMEE=" + std::to_string(value) + "\r");
} }
command_result config_edrx(int mode, int access_technology, const std::string &edrx_value, const std::string &ptw_value) command_result config_edrx(CommandableIf *t, int mode, int access_technology, const std::string &edrx_value)
{ {
if (mode == 1 || enabled == 2) if (mode == 1 || mode == 2) {
{ return dce_commands::generic_command_common(t,
return dce_commands::generic_command_common(dte.get(), "AT+CEDRXS=" +
"AT+SQNEDRX=" + std::to_string(mode) +
std::to_string(mode) + "," +
"," + std::to_string(access_technology) +
std::to_string(access_technology) + ",\"" +
",\"" + edrx_value + "\"\r");
edrx_value +
"\",\"" +
ptw_value + "\"\r");
} }
return dce_commands::generic_command_common(dte.get(), "AT+SQNEDRX=" + std::to_string(mode), 500); return dce_commands::generic_command_common(t, "AT+SQNEDRX=" + std::to_string(mode), 500);
} }
command_result set_gnss_power_mode_sim76xx(CommandableIf *t, int mode) command_result set_gnss_power_mode_sim76xx(CommandableIf *t, int mode)
{ {
ESP_LOGV(TAG, "%s", __func__ ); ESP_LOGV(TAG, "%s", __func__);
return generic_command_common(t, "AT+CGPS=" + std::to_string(mode) + "\r"); return generic_command_common(t, "AT+CGPS=" + std::to_string(mode) + "\r");
} }

View File

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD * SPDX-FileCopyrightText: 2021-2025 Espressif Systems (Shanghai) CO LTD
* *
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
@ -7,6 +7,7 @@
#include "cxx_include/esp_modem_api.hpp" #include "cxx_include/esp_modem_api.hpp"
#include "cxx_include/esp_modem_dce_module.hpp" #include "cxx_include/esp_modem_dce_module.hpp"
#include "generate/esp_modem_command_declare.inc" #include "generate/esp_modem_command_declare.inc"
#include "cxx17_include/esp_modem_command_library_17.hpp"
namespace esp_modem { namespace esp_modem {
@ -35,7 +36,7 @@ GenericModule::GenericModule(std::shared_ptr<DTE> dte, const dce_config *config)
#define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, arg_nr, ...) \ #define ESP_MODEM_DECLARE_DCE_COMMAND(name, return_type, arg_nr, ...) \
return_type GenericModule::name(__VA_ARGS__) { return esp_modem::dce_commands::name(dte.get() ARGS(arg_nr) ); } return_type GenericModule::name(__VA_ARGS__) { return esp_modem::dce_commands::name(dte.get() ARGS(arg_nr) ); }
DECLARE_ALL_COMMAND_APIS(return_type name(...) ) DECLARE_ALL_COMMAND_APIS(return_type name(...))
#undef ESP_MODEM_DECLARE_DCE_COMMAND #undef ESP_MODEM_DECLARE_DCE_COMMAND
@ -87,59 +88,41 @@ command_result BG96::set_pdp_context(esp_modem::PdpContext &pdp)
return dce_commands::set_pdp_context(dte.get(), pdp, 300); return dce_commands::set_pdp_context(dte.get(), pdp, 300);
} }
command_result urc_callback(uint8_t *line, size_t len) bool SQNGM02S::setup_data_mode()
{ {
ESP_LOGI("WalterModem", "Received: %s", line); return true;
if (strstr((const char *)line, "+CEREG: 1"))
{
return command_result::OK; // Succesfully registered
}
else if (strstr((const char *)line, "+CEREG: 5"))
{
return command_result::OK; // Succesfully registered
}
else if (strstr((const char *)line, "+CEREG: 3"))
{
return command_result::FAIL; // Permission denied
}
return command_result::TIMEOUT;
} }
command_result SQNGM02S::connect(PdpContext &pdp) command_result SQNGM02S::connect(PdpContext &pdp)
{ {
command_result res; command_result res;
res = set_pdp_context(pdp); configure_pdp_context(std::make_unique<PdpContext>(pdp));
if (res != command_result::OK) set_pdp_context(*this->pdp);
return res;
res = config_network_registration_urc(1); res = config_network_registration_urc(1);
if (res != command_result::OK) if (res != command_result::OK) {
return res; return res;
}
res = set_radio_state(1); res = set_radio_state(1);
if (res != command_result::OK) if (res != command_result::OK) {
return res; return res;
}
//wait for +CEREG: 5 or +CEREG: 1. //wait for +CEREG: 5 or +CEREG: 1.
const auto pass = std::list<std::string_view>({"+CEREG: 1", "+CEREG: 5"});
const auto fail = std::list<std::string_view>({"ERROR"});
res = esp_modem::dce_commands::generic_command(dte.get(), "", pass, fail, 1200000);
do if (res != command_result::OK) {
{ config_network_registration_urc(0);
res = dte->command("", urc_callback, 20000, '\r');
} while (res == command_result::TIMEOUT);
if (res != command_result::OK)
return res; return res;
}
res = config_network_registration_urc(0); res = config_network_registration_urc(0);
if (res != command_result::OK) if (res != command_result::OK) {
return res; return res;
}
return command_result::OK; return command_result::OK;
} }
bool SQNGM02S::setup_data_mode()
{
ESP_LOGI("SQNGM02S", "setyp data mode");
return set_echo(false) == command_result::OK;
// PDP context has already been set before hand because SEQUANS modem must have already been connected/registered before setting up cmux
}
} }