feedc0de/esp-protocols
1
0
Fork 0
forked from espressif/esp-protocols
Code Pull Requests Activity

Deploying to gh-pages from @ espressif/esp-protocols@ab70791625 🚀

Browse Source
This commit is contained in:
david-cermak
2022-09-30 12:27:18 +00:00
parent bbf20fdfa0
commit 12d7a25c4f
18 changed files with 105 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esp_modem/api_docs.html
+61
View File
@@ -78,6 +78,18 @@
<dd><p>DCE devices: Enum list of supported devices. </p>
</dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv426esp_modem_terminal_error_t">
<span id="_CPPv326esp_modem_terminal_error_t"></span><span id="_CPPv226esp_modem_terminal_error_t"></span><span id="esp_modem_terminal_error_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gae730b31a3d07364e12100877d5351e1f"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv424esp_modem_terminal_error" title="esp_modem_terminal_error"><span class="n"><span class="pre">esp_modem_terminal_error</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_terminal_error_t</span></span></span><a class="headerlink" href="#_CPPv426esp_modem_terminal_error_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Terminal errors. </p>
</dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv428esp_modem_terminal_error_cbt">
<span id="_CPPv328esp_modem_terminal_error_cbt"></span><span id="_CPPv228esp_modem_terminal_error_cbt"></span><span id="esp_modem_terminal_error_cbt"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga3197e9035b7637496631ca827670d850"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_terminal_error_cbt</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><a class="reference internal" href="#_CPPv426esp_modem_terminal_error_t" title="esp_modem_terminal_error_t"><span class="n"><span class="pre">esp_modem_terminal_error_t</span></span></a><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#_CPPv428esp_modem_terminal_error_cbt" title="Permalink to this definition"></a><br /></dt>
<dd><p>Terminal error callback. </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
@@ -144,6 +156,38 @@
</dd></dl>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv424esp_modem_terminal_error">
<span id="_CPPv324esp_modem_terminal_error"></span><span id="_CPPv224esp_modem_terminal_error"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga1e8371fb7fa8f83f09f8d782b9aeb1ad"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_terminal_error</span></span></span><a class="headerlink" href="#_CPPv424esp_modem_terminal_error" title="Permalink to this definition"></a><br /></dt>
<dd><p>Terminal errors. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24esp_modem_terminal_error34ESP_MODEM_TERMINAL_BUFFER_OVERFLOWE">
<span id="_CPPv3N24esp_modem_terminal_error34ESP_MODEM_TERMINAL_BUFFER_OVERFLOWE"></span><span id="_CPPv2N24esp_modem_terminal_error34ESP_MODEM_TERMINAL_BUFFER_OVERFLOWE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1e8371fb7fa8f83f09f8d782b9aeb1ada0d338de3c6b32e052a20a60d38deac02"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_TERMINAL_BUFFER_OVERFLOW</span></span></span><a class="headerlink" href="#_CPPv4N24esp_modem_terminal_error34ESP_MODEM_TERMINAL_BUFFER_OVERFLOWE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24esp_modem_terminal_error33ESP_MODEM_TERMINAL_CHECKSUM_ERRORE">
<span id="_CPPv3N24esp_modem_terminal_error33ESP_MODEM_TERMINAL_CHECKSUM_ERRORE"></span><span id="_CPPv2N24esp_modem_terminal_error33ESP_MODEM_TERMINAL_CHECKSUM_ERRORE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1e8371fb7fa8f83f09f8d782b9aeb1ada3462e9625f153f52bd6c74a536bac1c4"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_TERMINAL_CHECKSUM_ERROR</span></span></span><a class="headerlink" href="#_CPPv4N24esp_modem_terminal_error33ESP_MODEM_TERMINAL_CHECKSUM_ERRORE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24esp_modem_terminal_error42ESP_MODEM_TERMINAL_UNEXPECTED_CONTROL_FLOWE">
<span id="_CPPv3N24esp_modem_terminal_error42ESP_MODEM_TERMINAL_UNEXPECTED_CONTROL_FLOWE"></span><span id="_CPPv2N24esp_modem_terminal_error42ESP_MODEM_TERMINAL_UNEXPECTED_CONTROL_FLOWE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1e8371fb7fa8f83f09f8d782b9aeb1ada7a7b24e472d1e59a3d9f42dc8fc3844b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_TERMINAL_UNEXPECTED_CONTROL_FLOW</span></span></span><a class="headerlink" href="#_CPPv4N24esp_modem_terminal_error42ESP_MODEM_TERMINAL_UNEXPECTED_CONTROL_FLOWE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24esp_modem_terminal_error30ESP_MODEM_TERMINAL_DEVICE_GONEE">
<span id="_CPPv3N24esp_modem_terminal_error30ESP_MODEM_TERMINAL_DEVICE_GONEE"></span><span id="_CPPv2N24esp_modem_terminal_error30ESP_MODEM_TERMINAL_DEVICE_GONEE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1e8371fb7fa8f83f09f8d782b9aeb1ada9cad6e1d17470f3e8de06b1fa150811a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_TERMINAL_DEVICE_GONE</span></span></span><a class="headerlink" href="#_CPPv4N24esp_modem_terminal_error30ESP_MODEM_TERMINAL_DEVICE_GONEE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24esp_modem_terminal_error32ESP_MODEM_TERMINAL_UNKNOWN_ERRORE">
<span id="_CPPv3N24esp_modem_terminal_error32ESP_MODEM_TERMINAL_UNKNOWN_ERRORE"></span><span id="_CPPv2N24esp_modem_terminal_error32ESP_MODEM_TERMINAL_UNKNOWN_ERRORE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1e8371fb7fa8f83f09f8d782b9aeb1ada08e633b23952d44ccac5c50c069fda50"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_TERMINAL_UNKNOWN_ERROR</span></span></span><a class="headerlink" href="#_CPPv4N24esp_modem_terminal_error32ESP_MODEM_TERMINAL_UNKNOWN_ERRORE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
@@ -195,6 +239,23 @@
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv422esp_modem_set_error_cbP15esp_modem_dce_t28esp_modem_terminal_error_cbt">
<span id="_CPPv322esp_modem_set_error_cbP15esp_modem_dce_t28esp_modem_terminal_error_cbt"></span><span id="_CPPv222esp_modem_set_error_cbP15esp_modem_dce_t28esp_modem_terminal_error_cbt"></span><span id="esp_modem_set_error_cb__esp_modem_dce_tP.esp_modem_terminal_error_cbt"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga84df5fd9c4b128c110d614f3b7646134"></span><span class="n"><span class="pre">esp_err_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_error_cb</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">esp_modem_dce_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dce</span></span>, <a class="reference internal" href="#_CPPv428esp_modem_terminal_error_cbt" title="esp_modem_terminal_error_cbt"><span class="n"><span class="pre">esp_modem_terminal_error_cbt</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">err_cb</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422esp_modem_set_error_cbP15esp_modem_dce_t28esp_modem_terminal_error_cbt" title="Permalink to this definition"></a><br /></dt>
<dd><p>Set DTE’s error callback. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dce</strong> – Modem DCE handle </p></li>
<li><p><strong>err_cb</strong> – <strong>[in]</strong> Error callback </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>ESP_OK on success, ESP_FAIL on failure </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t">
<span id="_CPPv318esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t"></span><span id="_CPPv218esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t"></span><span id="esp_modem_set_mode__esp_modem_dce_tP.esp_modem_dce_mode_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga8e51dd9d216256fd46bdb768dbfa5e9d"></span><span class="n"><span class="pre">esp_err_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_mode</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">esp_modem_dce_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dce</span></span>, <a class="reference internal" href="#_CPPv420esp_modem_dce_mode_t" title="esp_modem_dce_mode_t"><span class="n"><span class="pre">esp_modem_dce_mode_t</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t" title="Permalink to this definition"></a><br /></dt>