Files
esp-protocols/esp_modem/docs/esp_modem_dce.hpp

64 lines
1.8 KiB
C++
Raw Normal View History

2021-04-14 17:57:42 +02:00
// 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
2021-04-13 20:29:55 +02:00
// --- DCE command documentation starts here ---
2021-04-14 17:57:42 +02:00
class esp_modem::DCE: public DCE_T<GenericModule> {
2021-04-13 20:29:55 +02:00
public:
using DCE_T<GenericModule>::DCE_T;
2021-04-14 17:57:42 +02:00
2021-04-13 20:29:55 +02:00
/**
* @brief Sends the supplied PIN code
*
* @param pin Pin
*
*/ command_result set_pin (const std::string& pin); /**
* @brief Checks if the SIM needs a PIN
*
* @param[out] pin_ok Pin
*/ command_result read_pin (bool& pin_ok); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result set_echo (const bool x); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result resume_data_mode (); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result set_pdp_context (PdpContext& x); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result set_command_mode (); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result set_cmux (); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result get_imsi (std::string& x); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result get_imei (std::string& x); /**
* @brief Reads the module name
*
* @param[out] name module name
*/ command_result get_module_name (std::string& name); /**
* @brief Sets the modem to data mode
*
*/ command_result set_data_mode (); /**
* @brief Get Signal quality
*
*/ command_result get_signal_quality (int& x, int& y);
};