forked from espressif/esp-protocols
Deploying to gh-pages from @ espressif/esp-protocols@e7ae0301ae 🚀
This commit is contained in:
david-cermak committed
1 parent
4eb61cdc79
commit
b5101237ca
5 files changed
+7
-1
No files matched your search
Binary file not shown.
Binary file not shown.
@@ -41,6 +41,9 @@ Modem commands
|
||||
|
||||
These functions are the actual commands to communicate with the modem using AT command interface.
|
||||
|
||||
Note that the functions which implement AT commands returning textual values use plain ``char *``
|
||||
pointer as the return value. The API expects the output data to point to user allocated space of at least
|
||||
``ESP_MODEM_C_API_STR_MAX`` (64 by default) bytes, it also truncates the output data to this size.
|
||||
|
||||
.. doxygenfile:: esp_modem_api_commands.h
|
||||
|
||||
|
||||
@@ -210,6 +210,9 @@
|
||||
<section id="modem-commands">
|
||||
<span id="id2"></span><h2>Modem commands<a class="headerlink" href="#modem-commands" title="Permalink to this headline">¶</a></h2>
|
||||
<p>These functions are the actual commands to communicate with the modem using AT command interface.</p>
|
||||
<p>Note that the functions which implement AT commands returning textual values use plain <code class="docutils literal notranslate"><span class="pre">char</span> <span class="pre">*</span></code>
|
||||
pointer as the return value. The API expects the output data to point to user allocated space of at least
|
||||
<code class="docutils literal notranslate"><span class="pre">ESP_MODEM_C_API_STR_MAX</span></code> (64 by default) bytes, it also truncates the output data to this size.</p>
|
||||
<div class="breathe-sectiondef docutils container">
|
||||
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
|
||||
<dl class="cpp function">
|
||||
|
||||
@@ -1 +1 @@
|
||||
Search.setIndex({docnames:["README","advanced_api","api_docs","cxx_api_docs","cxx_api_links","index","internal_design","internal_docs"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["README.md","advanced_api.rst","api_docs.rst","cxx_api_docs.rst","cxx_api_links.rst","index.rst","internal_design.md","internal_docs.rst"],objects:{"":[[2,0,1,"c.ESP_MODEM_DCE_DEFAULT_CONFIG","ESP_MODEM_DCE_DEFAULT_CONFIG"],[7,0,1,"c.ESP_MODEM_DECLARE_DCE_COMMAND","ESP_MODEM_DECLARE_DCE_COMMAND"],[2,0,1,"c.ESP_MODEM_DTE_DEFAULT_CONFIG","ESP_MODEM_DTE_DEFAULT_CONFIG"],[1,1,1,"_CPPv4N9ModemType4BG96E","BG96"],[7,1,1,"_CPPv4N14terminal_error15BUFFER_OVERFLOWE","BUFFER_OVERFLOW"],[7,1,1,"_CPPv4N14terminal_error14CHECKSUM_ERRORE","CHECKSUM_ERROR"],[7,1,1,"_CPPv4N10modem_mode9CMUX_MODEE","CMUX_MODE"],[7,1,1,"_CPPv4N10modem_mode12COMMAND_MODEE","COMMAND_MODE"],[7,1,1,"_CPPv4N10modem_mode9DATA_MODEE","DATA_MODE"],[2,1,1,"_CPPv4N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E","ESP_MODEM_DCE_BG96"],[2,1,1,"_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_GENETICE","ESP_MODEM_DCE_GENETIC"],[2,1,1,"_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E","ESP_MODEM_DCE_SIM7600"],[2,1,1,"_CPPv4N20esp_modem_dce_device20ESP_MODEM_DCE_SIM800E","ESP_MODEM_DCE_SIM800"],[2,1,1,"_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_HWE","ESP_MODEM_FLOW_CONTROL_HW"],[2,1,1,"_CPPv4N21esp_modem_flow_ctrl_t27ESP_MODEM_FLOW_CONTROL_NONEE","ESP_MODEM_FLOW_CONTROL_NONE"],[2,1,1,"_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_SWE","ESP_MODEM_FLOW_CONTROL_SW"],[2,1,1,"_CPPv4N18esp_modem_dce_mode22ESP_MODEM_MODE_COMMANDE","ESP_MODEM_MODE_COMMAND"],[2,1,1,"_CPPv4N18esp_modem_dce_mode19ESP_MODEM_MODE_DATAE","ESP_MODEM_MODE_DATA"],[7,1,1,"_CPPv4N14command_result4FAILE","FAIL"],[7,1,1,"_CPPv4N10cmux_state6FOOTERE","FOOTER"],[1,1,1,"_CPPv4N9ModemType13GenericModuleE","GenericModule"],[7,1,1,"_CPPv4N10cmux_state6HEADERE","HEADER"],[7,1,1,"_CPPv4N10cmux_state4INITE","INIT"],[1,2,1,"_CPPv49ModemType","ModemType"],[1,1,1,"_CPPv4N9ModemType4BG96E","ModemType::BG96"],[1,1,1,"_CPPv4N9ModemType13GenericModuleE","ModemType::GenericModule"],[1,1,1,"_CPPv4N9ModemType7SIM7600E","ModemType::SIM7600"],[1,1,1,"_CPPv4N9ModemType6SIM800E","ModemType::SIM800"],[7,1,1,"_CPPv4N14command_result2OKE","OK"],[7,1,1,"_CPPv4N10cmux_state7PAYLOADE","PAYLOAD"],[7,1,1,"_CPPv4N10cmux_state7RECOVERE","RECOVER"],[1,1,1,"_CPPv4N9ModemType7SIM7600E","SIM7600"],[1,1,1,"_CPPv4N9ModemType6SIM800E","SIM800"],[7,1,1,"_CPPv4N14command_result7TIMEOUTE","TIMEOUT"],[7,1,1,"_CPPv4N10modem_mode5UNDEFE","UNDEF"],[7,1,1,"_CPPv4N14terminal_error23UNEXPECTED_CONTROL_FLOWE","UNEXPECTED_CONTROL_FLOW"],[7,2,1,"_CPPv410cmux_state","cmux_state"],[7,1,1,"_CPPv4N10cmux_state6FOOTERE","cmux_state::FOOTER"],[7,1,1,"_CPPv4N10cmux_state6HEADERE","cmux_state::HEADER"],[7,1,1,"_CPPv4N10cmux_state4INITE","cmux_state::INIT"],[7,1,1,"_CPPv4N10cmux_state7PAYLOADE","cmux_state::PAYLOAD"],[7,1,1,"_CPPv4N10cmux_state7RECOVERE","cmux_state::RECOVER"],[7,2,1,"_CPPv414command_result","command_result"],[7,1,1,"_CPPv4N14command_result4FAILE","command_result::FAIL"],[7,1,1,"_CPPv4N14command_result2OKE","command_result::OK"],[7,1,1,"_CPPv4N14command_result7TIMEOUTE","command_result::TIMEOUT"],[3,3,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce"],[3,4,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce::config"],[3,4,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce::dte"],[3,4,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce::netif"],[3,3,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce"],[3,4,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce::config"],[3,4,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce::dte"],[3,4,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce::netif"],[3,3,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce"],[3,4,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce::config"],[3,4,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce::dte"],[3,4,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce::netif"],[3,3,1,"_CPPv418create_generic_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_generic_dce"],[3,4,1,"_CPPv418create_generic_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_generic_dce:Line truncated
|
||||
Search.setIndex({docnames:["README","advanced_api","api_docs","cxx_api_docs","cxx_api_links","index","internal_design","internal_docs"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["README.md","advanced_api.rst","api_docs.rst","cxx_api_docs.rst","cxx_api_links.rst","index.rst","internal_design.md","internal_docs.rst"],objects:{"":[[2,0,1,"c.ESP_MODEM_DCE_DEFAULT_CONFIG","ESP_MODEM_DCE_DEFAULT_CONFIG"],[7,0,1,"c.ESP_MODEM_DECLARE_DCE_COMMAND","ESP_MODEM_DECLARE_DCE_COMMAND"],[2,0,1,"c.ESP_MODEM_DTE_DEFAULT_CONFIG","ESP_MODEM_DTE_DEFAULT_CONFIG"],[1,1,1,"_CPPv4N9ModemType4BG96E","BG96"],[7,1,1,"_CPPv4N14terminal_error15BUFFER_OVERFLOWE","BUFFER_OVERFLOW"],[7,1,1,"_CPPv4N14terminal_error14CHECKSUM_ERRORE","CHECKSUM_ERROR"],[7,1,1,"_CPPv4N10modem_mode9CMUX_MODEE","CMUX_MODE"],[7,1,1,"_CPPv4N10modem_mode12COMMAND_MODEE","COMMAND_MODE"],[7,1,1,"_CPPv4N10modem_mode9DATA_MODEE","DATA_MODE"],[2,1,1,"_CPPv4N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E","ESP_MODEM_DCE_BG96"],[2,1,1,"_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_GENETICE","ESP_MODEM_DCE_GENETIC"],[2,1,1,"_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E","ESP_MODEM_DCE_SIM7600"],[2,1,1,"_CPPv4N20esp_modem_dce_device20ESP_MODEM_DCE_SIM800E","ESP_MODEM_DCE_SIM800"],[2,1,1,"_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_HWE","ESP_MODEM_FLOW_CONTROL_HW"],[2,1,1,"_CPPv4N21esp_modem_flow_ctrl_t27ESP_MODEM_FLOW_CONTROL_NONEE","ESP_MODEM_FLOW_CONTROL_NONE"],[2,1,1,"_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_SWE","ESP_MODEM_FLOW_CONTROL_SW"],[2,1,1,"_CPPv4N18esp_modem_dce_mode22ESP_MODEM_MODE_COMMANDE","ESP_MODEM_MODE_COMMAND"],[2,1,1,"_CPPv4N18esp_modem_dce_mode19ESP_MODEM_MODE_DATAE","ESP_MODEM_MODE_DATA"],[7,1,1,"_CPPv4N14command_result4FAILE","FAIL"],[7,1,1,"_CPPv4N10cmux_state6FOOTERE","FOOTER"],[1,1,1,"_CPPv4N9ModemType13GenericModuleE","GenericModule"],[7,1,1,"_CPPv4N10cmux_state6HEADERE","HEADER"],[7,1,1,"_CPPv4N10cmux_state4INITE","INIT"],[1,2,1,"_CPPv49ModemType","ModemType"],[1,1,1,"_CPPv4N9ModemType4BG96E","ModemType::BG96"],[1,1,1,"_CPPv4N9ModemType13GenericModuleE","ModemType::GenericModule"],[1,1,1,"_CPPv4N9ModemType7SIM7600E","ModemType::SIM7600"],[1,1,1,"_CPPv4N9ModemType6SIM800E","ModemType::SIM800"],[7,1,1,"_CPPv4N14command_result2OKE","OK"],[7,1,1,"_CPPv4N10cmux_state7PAYLOADE","PAYLOAD"],[7,1,1,"_CPPv4N10cmux_state7RECOVERE","RECOVER"],[1,1,1,"_CPPv4N9ModemType7SIM7600E","SIM7600"],[1,1,1,"_CPPv4N9ModemType6SIM800E","SIM800"],[7,1,1,"_CPPv4N14command_result7TIMEOUTE","TIMEOUT"],[7,1,1,"_CPPv4N10modem_mode5UNDEFE","UNDEF"],[7,1,1,"_CPPv4N14terminal_error23UNEXPECTED_CONTROL_FLOWE","UNEXPECTED_CONTROL_FLOW"],[7,2,1,"_CPPv410cmux_state","cmux_state"],[7,1,1,"_CPPv4N10cmux_state6FOOTERE","cmux_state::FOOTER"],[7,1,1,"_CPPv4N10cmux_state6HEADERE","cmux_state::HEADER"],[7,1,1,"_CPPv4N10cmux_state4INITE","cmux_state::INIT"],[7,1,1,"_CPPv4N10cmux_state7PAYLOADE","cmux_state::PAYLOAD"],[7,1,1,"_CPPv4N10cmux_state7RECOVERE","cmux_state::RECOVER"],[7,2,1,"_CPPv414command_result","command_result"],[7,1,1,"_CPPv4N14command_result4FAILE","command_result::FAIL"],[7,1,1,"_CPPv4N14command_result2OKE","command_result::OK"],[7,1,1,"_CPPv4N14command_result7TIMEOUTE","command_result::TIMEOUT"],[3,3,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce"],[3,4,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce::config"],[3,4,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce::dte"],[3,4,1,"_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_BG96_dce::netif"],[3,3,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce"],[3,4,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce::config"],[3,4,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce::dte"],[3,4,1,"_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM7600_dce::netif"],[3,3,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce"],[3,4,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce::config"],[3,4,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce::dte"],[3,4,1,"_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_SIM800_dce::netif"],[3,3,1,"_CPPv418create_generic_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_generic_dce"],[3,4,1,"_CPPv418create_generic_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t","create_generic_dce:Line truncated
|
||||
Reference in new issue
Block a user