mirror of
https://github.com/espressif/esp-protocols.git
synced 2025-07-16 12:02:11 +02:00
100 lines
4.4 KiB
C
100 lines
4.4 KiB
C
// 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
|
|
|
|
|
|
// --- DCE command documentation starts here ---
|
|
/**
|
|
* @brief Sends the initial AT sequence to sync up with the device
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_sync (); /**
|
|
* @brief Reads the operator name
|
|
* @param[out] name module name
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_get_operator_name (char* name); /**
|
|
* @brief Stores current user profile
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_store_profile (); /**
|
|
* @brief Sets the supplied PIN code
|
|
* @param[in] pin Pin
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/command_result esp_modem_set_pin (const char* pin); /**
|
|
* @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 esp_modem_read_pin (bool* 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 esp_modem_set_echo (const bool 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 esp_modem_sms_txt_mode (const bool txt); /**
|
|
* @brief Sets the default (GSM) charater set
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_sms_character_set (); /**
|
|
* @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 esp_modem_send_sms (const char* number, const char* message); /**
|
|
* @brief Resumes data mode (Switches back to th data mode, which was temporarily suspended)
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_resume_data_mode (); /**
|
|
* @brief Sets php context
|
|
* @param[in] x PdP context struct to setup modem cellular connection
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_set_pdp_context (struct PdpContext* x); /**
|
|
* @brief Switches to the command mode
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_set_command_mode (); /**
|
|
* @brief Switches to the CMUX mode
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_set_cmux (); /**
|
|
* @brief Reads the IMSI number
|
|
* @param[out] imsi Module's IMSI number
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_get_imsi (char* imsi); /**
|
|
* @brief Reads the IMEI number
|
|
* @param[out] imei Module's IMEI number
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_get_imei (char* imei); /**
|
|
* @brief Reads the module name
|
|
* @param[out] name module name
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_get_module_name (char* name); /**
|
|
* @brief Sets the modem to data mode
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_set_data_mode (); /**
|
|
* @brief Get Signal quality
|
|
* @param[out] rssi signal strength indication
|
|
* @param[out] ber channel bit error rate
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_get_signal_quality (int* rssi, int* 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 esp_modem_set_flow_control (int dce_flow, int dte_flow); /**
|
|
* @brief Hangs up current data call
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_hang_up (); /**
|
|
* @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 esp_modem_get_battery_status (int* voltage, int* bcs, int* bcl); /**
|
|
* @brief Power down the module
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_power_down (); /**
|
|
* @brief Reset the module
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_reset (); /**
|
|
* @brief Configures the baudrate
|
|
* @param[in] baud Desired baud rate of the DTE
|
|
* @return OK, FAIL or TIMEOUT
|
|
*/ command_result esp_modem_set_baud (int baud);
|