mirror of
https://github.com/espressif/esp-protocols.git
synced 2025-10-17 08:45:22 +02:00
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)
This commit is contained in:
David Cermak
512
components/esp_modem/command/src/esp_modem_modules.cpp
Normal file
512
components/esp_modem/command/src/esp_modem_modules.cpp
Normal file
@@ -0,0 +1,512 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2021-2025 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include "cxx_include/esp_modem_api.hpp"
|
||||
#include "cxx_include/esp_modem_dce_module.hpp"
|
||||
#include "cxx17_include/esp_modem_command_library_17.hpp"
|
||||
#include "cxx_include/esp_modem_dte.hpp"
|
||||
|
||||
namespace esp_modem {
|
||||
GenericModule::GenericModule(std::shared_ptr<DTE> dte, const dce_config *config) :
|
||||
dte(std::move(dte)), pdp(std::make_unique<PdpContext>(config->apn)) {}
|
||||
/**
|
||||
* @brief Sends the initial AT sequence to sync up with the device
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::sync()
|
||||
{
|
||||
return esp_modem::dce_commands::sync(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Reads the operator name
|
||||
* @param[out] name operator name
|
||||
* @param[out] act access technology
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_operator_name(std::string &name, int &act)
|
||||
{
|
||||
return esp_modem::dce_commands::get_operator_name(dte.get(), name, act);
|
||||
}
|
||||
/**
|
||||
* @brief Stores current user profile
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::store_profile()
|
||||
{
|
||||
return esp_modem::dce_commands::store_profile(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Sets the supplied PIN code
|
||||
* @param[in] pin Pin
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_pin(const std::string &pin)
|
||||
{
|
||||
return esp_modem::dce_commands::set_pin(dte.get(), 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
|
||||
*/
|
||||
command_result GenericModule::at_raw(const std::string &cmd, std::string &out, const std::string &pass, const std::string &fail, int timeout)
|
||||
{
|
||||
return esp_modem::dce_commands::at_raw(dte.get(), cmd, out, pass, fail, 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
|
||||
*/
|
||||
command_result GenericModule::at(const std::string &cmd, std::string &out, int timeout)
|
||||
{
|
||||
return esp_modem::dce_commands::at(dte.get(), cmd, out, 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
|
||||
*/
|
||||
command_result GenericModule::read_pin(bool &pin_ok)
|
||||
{
|
||||
return esp_modem::dce_commands::read_pin(dte.get(), pin_ok);
|
||||
}
|
||||
/**
|
||||
* @brief Sets echo mode
|
||||
* @param[in] echo_on true if echo mode on (repeats the commands)
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_echo(const bool echo_on)
|
||||
{
|
||||
return esp_modem::dce_commands::set_echo(dte.get(), 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
|
||||
*/
|
||||
command_result GenericModule::sms_txt_mode(const bool txt)
|
||||
{
|
||||
return esp_modem::dce_commands::sms_txt_mode(dte.get(), txt);
|
||||
}
|
||||
/**
|
||||
* @brief Sets the default (GSM) character set
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::sms_character_set()
|
||||
{
|
||||
return esp_modem::dce_commands::sms_character_set(dte.get());
|
||||
}
|
||||
/**
|
||||
* @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
|
||||
*/
|
||||
command_result GenericModule::send_sms(const std::string &number, const std::string &message)
|
||||
{
|
||||
return esp_modem::dce_commands::send_sms(dte.get(), number, message);
|
||||
}
|
||||
/**
|
||||
* @brief Resumes data mode (Switches back to the data mode, which was temporarily suspended)
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::resume_data_mode()
|
||||
{
|
||||
return esp_modem::dce_commands::resume_data_mode(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Sets php context
|
||||
* @param[in] p1 PdP context struct to setup modem cellular connection
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_pdp_context(PdpContext &pdp)
|
||||
{
|
||||
return esp_modem::dce_commands::set_pdp_context(dte.get(), pdp);
|
||||
}
|
||||
/**
|
||||
* @brief Switches to the command mode
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_command_mode()
|
||||
{
|
||||
return esp_modem::dce_commands::set_command_mode(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Switches to the CMUX mode
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_cmux()
|
||||
{
|
||||
return esp_modem::dce_commands::set_cmux(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Reads the IMSI number
|
||||
* @param[out] imsi Module's IMSI number
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_imsi(std::string &imsi)
|
||||
{
|
||||
return esp_modem::dce_commands::get_imsi(dte.get(), imsi);
|
||||
}
|
||||
/**
|
||||
* @brief Reads the IMEI number
|
||||
* @param[out] imei Module's IMEI number
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_imei(std::string &imei)
|
||||
{
|
||||
return esp_modem::dce_commands::get_imei(dte.get(), imei);
|
||||
}
|
||||
/**
|
||||
* @brief Reads the module name
|
||||
* @param[out] name module name
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_module_name(std::string &name)
|
||||
{
|
||||
return esp_modem::dce_commands::get_module_name(dte.get(), name);
|
||||
}
|
||||
/**
|
||||
* @brief Sets the modem to data mode
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_data_mode()
|
||||
{
|
||||
return esp_modem::dce_commands::set_data_mode(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Get Signal quality
|
||||
* @param[out] rssi signal strength indication
|
||||
* @param[out] ber channel bit error rate
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_signal_quality(int &rssi, int &ber)
|
||||
{
|
||||
return esp_modem::dce_commands::get_signal_quality(dte.get(), rssi, 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
|
||||
*/
|
||||
command_result GenericModule::set_flow_control(int dce_flow, int dte_flow)
|
||||
{
|
||||
return esp_modem::dce_commands::set_flow_control(dte.get(), dce_flow, dte_flow);
|
||||
}
|
||||
/**
|
||||
* @brief Hangs up current data call
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::hang_up()
|
||||
{
|
||||
return esp_modem::dce_commands::hang_up(dte.get());
|
||||
}
|
||||
/**
|
||||
* @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
|
||||
*/
|
||||
command_result GenericModule::get_battery_status(int &voltage, int &bcs, int &bcl)
|
||||
{
|
||||
return esp_modem::dce_commands::get_battery_status(dte.get(), voltage, bcs, bcl);
|
||||
}
|
||||
/**
|
||||
* @brief Power down the module
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::power_down()
|
||||
{
|
||||
return esp_modem::dce_commands::power_down(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Reset the module
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::reset()
|
||||
{
|
||||
return esp_modem::dce_commands::reset(dte.get());
|
||||
}
|
||||
/**
|
||||
* @brief Configures the baudrate
|
||||
* @param[in] baud Desired baud rate of the DTE
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_baud(int baud)
|
||||
{
|
||||
return esp_modem::dce_commands::set_baud(dte.get(), 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
|
||||
*/
|
||||
command_result GenericModule::set_operator(int mode, int format, const std::string &oper)
|
||||
{
|
||||
return esp_modem::dce_commands::set_operator(dte.get(), mode, format, oper);
|
||||
}
|
||||
/**
|
||||
* @brief Attach or detach from the GPRS service
|
||||
* @param[in] state 1-attach 0-detach
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_network_attachment_state(int state)
|
||||
{
|
||||
return esp_modem::dce_commands::set_network_attachment_state(dte.get(), state);
|
||||
}
|
||||
/**
|
||||
* @brief Get network attachment state
|
||||
* @param[out] state 1-attached 0-detached
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_network_attachment_state(int &state)
|
||||
{
|
||||
return esp_modem::dce_commands::get_network_attachment_state(dte.get(), state);
|
||||
}
|
||||
/**
|
||||
* @brief What mode the radio should be set to
|
||||
* @param[in] state state 1-full 0-minimum ...
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_radio_state(int state)
|
||||
{
|
||||
return esp_modem::dce_commands::set_radio_state(dte.get(), state);
|
||||
}
|
||||
/**
|
||||
* @brief Get current radio state
|
||||
* @param[out] state 1-full 0-minimum ...
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_radio_state(int &state)
|
||||
{
|
||||
return esp_modem::dce_commands::get_radio_state(dte.get(), state);
|
||||
}
|
||||
/**
|
||||
* @brief Set network mode
|
||||
* @param[in] mode preferred mode
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_network_mode(int mode)
|
||||
{
|
||||
return esp_modem::dce_commands::set_network_mode(dte.get(), mode);
|
||||
}
|
||||
/**
|
||||
* @brief Preferred network mode (CAT-M and/or NB-IoT)
|
||||
* @param[in] mode preferred selection
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_preferred_mode(int mode)
|
||||
{
|
||||
return esp_modem::dce_commands::set_preferred_mode(dte.get(), 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
|
||||
*/
|
||||
command_result GenericModule::set_network_bands(const std::string &mode, const int *bands, int size)
|
||||
{
|
||||
return esp_modem::dce_commands::set_network_bands(dte.get(), mode, bands, size);
|
||||
}
|
||||
/**
|
||||
* @brief Show network system mode
|
||||
* @param[out] mode current network mode
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_network_system_mode(int &mode)
|
||||
{
|
||||
return esp_modem::dce_commands::get_network_system_mode(dte.get(), mode);
|
||||
}
|
||||
/**
|
||||
* @brief GNSS power control
|
||||
* @param[out] mode power mode (0 - off, 1 - on)
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::set_gnss_power_mode(int mode)
|
||||
{
|
||||
return esp_modem::dce_commands::set_gnss_power_mode(dte.get(), mode);
|
||||
}
|
||||
/**
|
||||
* @brief GNSS power control
|
||||
* @param[out] mode power mode (0 - off, 1 - on)
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::get_gnss_power_mode(int &mode)
|
||||
{
|
||||
return esp_modem::dce_commands::get_gnss_power_mode(dte.get(), mode);
|
||||
}
|
||||
/**
|
||||
* @brief Configure PSM
|
||||
* @param[in] mode psm mode (0 - off, 1 - on, 2 - off & discard stored params)
|
||||
* @return OK, FAIL or TIMEOUT
|
||||
*/
|
||||
command_result GenericModule::config_psm(int mode, const std::string &tau, const std::string &active_time)
|
||||
{
|
||||
return esp_modem::dce_commands::config_psm(dte.get(), mode, tau, 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
|
||||
*/
|
||||
command_result GenericModule::config_network_registration_urc(int value)
|
||||
{
|
||||
return esp_modem::dce_commands::config_network_registration_urc(dte.get(), 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
|
||||
*/
|
||||
command_result GenericModule::get_network_registration_state(int &state)
|
||||
{
|
||||
return esp_modem::dce_commands::get_network_registration_state(dte.get(), 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
|
||||
*/
|
||||
command_result GenericModule::config_mobile_termination_error(int mode)
|
||||
{
|
||||
return esp_modem::dce_commands::config_mobile_termination_error(dte.get(), 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
|
||||
*/
|
||||
command_result GenericModule::config_edrx(int mode, int access_technology, const std::string &edrx_value)
|
||||
{
|
||||
return esp_modem::dce_commands::config_edrx(dte.get(), mode, access_technology, edrx_value);
|
||||
}
|
||||
// Usage examples:
|
||||
// Zero arguments
|
||||
// Helper to apply the correct macro to each parameter
|
||||
//
|
||||
// Repeat all declarations and forward to the AT commands defined in esp_modem::dce_commands:: namespace
|
||||
//
|
||||
//
|
||||
// Handle specific commands for specific supported modems
|
||||
//
|
||||
command_result SIM7600::get_battery_status(int &voltage, int &bcs, int &bcl)
|
||||
{
|
||||
return dce_commands::get_battery_status_sim7xxx(dte.get(), voltage, bcs, bcl);
|
||||
}
|
||||
command_result SIM7600::set_network_bands(const std::string &mode, const int *bands, int size)
|
||||
{
|
||||
return dce_commands::set_network_bands_sim76xx(dte.get(), mode, bands, size);
|
||||
}
|
||||
command_result SIM7600::set_gnss_power_mode(int mode)
|
||||
{
|
||||
return dce_commands::set_gnss_power_mode_sim76xx(dte.get(), mode);
|
||||
}
|
||||
command_result SIM7600::power_down()
|
||||
{
|
||||
return dce_commands::power_down_sim76xx(dte.get());
|
||||
}
|
||||
command_result SIM7070::power_down()
|
||||
{
|
||||
return dce_commands::power_down_sim70xx(dte.get());
|
||||
}
|
||||
command_result SIM7070::set_data_mode()
|
||||
{
|
||||
return dce_commands::set_data_mode_alt(dte.get());
|
||||
}
|
||||
command_result SIM7000::power_down()
|
||||
{
|
||||
return dce_commands::power_down_sim70xx(dte.get());
|
||||
}
|
||||
command_result SIM800::power_down()
|
||||
{
|
||||
return dce_commands::power_down_sim8xx(dte.get());
|
||||
}
|
||||
command_result BG96::set_pdp_context(esp_modem::PdpContext &pdp)
|
||||
{
|
||||
return dce_commands::set_pdp_context(dte.get(), pdp, 300);
|
||||
}
|
||||
bool SQNGM02S::setup_data_mode()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
command_result SQNGM02S::connect(PdpContext &pdp)
|
||||
{
|
||||
command_result res;
|
||||
configure_pdp_context(std::make_unique<PdpContext>(pdp));
|
||||
set_pdp_context(*this->pdp);
|
||||
res = config_network_registration_urc(1);
|
||||
if (res != command_result::OK) {
|
||||
return res;
|
||||
}
|
||||
res = set_radio_state(1);
|
||||
if (res != command_result::OK) {
|
||||
return res;
|
||||
}
|
||||
//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);
|
||||
if (res != command_result::OK) {
|
||||
config_network_registration_urc(0);
|
||||
return res;
|
||||
}
|
||||
res = config_network_registration_urc(0);
|
||||
if (res != command_result::OK) {
|
||||
return res;
|
||||
}
|
||||
return command_result::OK;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user