espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-11-04 08:31:37 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
24844b3dc987ef87217471cffaaa70169fcbbfb0
esp-protocols/esp_modem/api_docs.html

855 lines
85 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>C API Documentation &#8212; esp-modem documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="C++ API Documentation" href="cxx_api_docs.html" />
<link rel="prev" title="ESP MODEM" href="README.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="c-api-documentation">
<span id="c-api"></span><h1>C API Documentation<a class="headerlink" href="#c-api-documentation" title="Permalink to this headline"></a></h1>
<p>The C API is very simple and consist of these two basic parts:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#lifecycle-api"><span class="std std-ref">Lifecycle API</span></a></p></li>
<li><p><a class="reference internal" href="#modem-commands"><span class="std std-ref">Modem commands</span></a></p></li>
</ul>
<p>The Typical application workflow is to:</p>
<ul class="simple">
<li><p>Create a DCE instance (using <a class="reference internal" href="#_CPPv413esp_modem_newPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t" title="esp_modem_new"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem_new()</span></code></a>)</p></li>
<li><p>Call specific functions to issue AT commands (<a class="reference internal" href="#modem-commands"><span class="std std-ref">Modem commands</span></a>)</p></li>
<li><p>Switch to the data mode (using <a class="reference internal" href="#_CPPv418esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t" title="esp_modem_set_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem_set_mode()</span></code></a>)</p></li>
<li><p>Perform desired network operations (using standard networking API, unrelated to ESP-MODEM)</p></li>
<li><p>Optionally switch back to command mode (again <a class="reference internal" href="#_CPPv418esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t" title="esp_modem_set_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem_set_mode()</span></code></a>)</p></li>
<li><p>Destroy the DCE handle (sing <a class="reference internal" href="#_CPPv417esp_modem_destroyP15esp_modem_dce_t" title="esp_modem_destroy"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem_destroy()</span></code></a>)</p></li>
</ul>
<p>Note the configuration structures for DTE and DCE, needed for creating the DCE instance, is documented in <a class="reference internal" href="#api-config"><span class="std std-ref">Configuration structures</span></a></p>
<section id="lifecycle-api">
<span id="id1"></span><h2>Lifecycle API<a class="headerlink" href="#lifecycle-api" title="Permalink to this headline"></a></h2>
<p>These functions are used to create, destroy and set modem working mode.</p>
<ul class="simple">
<li><p><a class="reference internal" href="#_CPPv413esp_modem_newPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t" title="esp_modem_new"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem_new()</span></code></a></p></li>
<li><p><a class="reference internal" href="#_CPPv417esp_modem_destroyP15esp_modem_dce_t" title="esp_modem_destroy"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem_destroy()</span></code></a></p></li>
<li><p><a class="reference internal" href="#_CPPv418esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t" title="esp_modem_set_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem_set_mode()</span></code></a></p></li>
</ul>
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i"></span><em><span class="pre">group</span></em> <span class="sig-name descname"><span class="pre">ESP_MODEM_C_API</span></span></dt>
<dd><p>Set of basic C API for ESP-MODEM. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv420esp_modem_dce_mode_t">
<span id="_CPPv320esp_modem_dce_mode_t"></span><span id="_CPPv220esp_modem_dce_mode_t"></span><span id="esp_modem_dce_mode_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga98ece4b331e8906161f1b6823039a28f"></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="#_CPPv418esp_modem_dce_mode" title="esp_modem_dce_mode"><span class="n"><span class="pre">esp_modem_dce_mode</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_dce_mode_t</span></span></span><a class="headerlink" href="#_CPPv420esp_modem_dce_mode_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>DCE mode: This enum is used to set desired operation mode of the DCE. </p>
</dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv422esp_modem_dce_device_t">
<span id="_CPPv322esp_modem_dce_device_t"></span><span id="_CPPv222esp_modem_dce_device_t"></span><span id="esp_modem_dce_device_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga30660e790f39fc663aa02b2419568d65"></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="#_CPPv420esp_modem_dce_device" title="esp_modem_dce_device"><span class="n"><span class="pre">esp_modem_dce_device</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_dce_device_t</span></span></span><a class="headerlink" href="#_CPPv422esp_modem_dce_device_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>DCE devices: Enum list of supported devices. </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_dce_mode">
<span id="_CPPv318esp_modem_dce_mode"></span><span id="_CPPv218esp_modem_dce_mode"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gaf760e55ec8ab7da6d0bf0b10642510c5"></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_dce_mode</span></span></span><a class="headerlink" href="#_CPPv418esp_modem_dce_mode" title="Permalink to this definition"></a><br /></dt>
<dd><p>DCE mode: This enum is used to set desired operation mode of the DCE. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18esp_modem_dce_mode22ESP_MODEM_MODE_COMMANDE">
<span id="_CPPv3N18esp_modem_dce_mode22ESP_MODEM_MODE_COMMANDE"></span><span id="_CPPv2N18esp_modem_dce_mode22ESP_MODEM_MODE_COMMANDE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ggaf760e55ec8ab7da6d0bf0b10642510c5a1421fb5a33ec7896917f6e2e3139440e"></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_MODE_COMMAND</span></span></span><a class="headerlink" href="#_CPPv4N18esp_modem_dce_mode22ESP_MODEM_MODE_COMMANDE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Default mode after modem startup, used for sending AT commands </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18esp_modem_dce_mode19ESP_MODEM_MODE_DATAE">
<span id="_CPPv3N18esp_modem_dce_mode19ESP_MODEM_MODE_DATAE"></span><span id="_CPPv2N18esp_modem_dce_mode19ESP_MODEM_MODE_DATAE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ggaf760e55ec8ab7da6d0bf0b10642510c5a86b7874c6ea985390d4b90381826c805"></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_MODE_DATA</span></span></span><a class="headerlink" href="#_CPPv4N18esp_modem_dce_mode19ESP_MODEM_MODE_DATAE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Used for switching to PPP mode for the modem to connect to a network </p>
</dd></dl>
</dd></dl>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv420esp_modem_dce_device">
<span id="_CPPv320esp_modem_dce_device"></span><span id="_CPPv220esp_modem_dce_device"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga1f3ff76188839171bc16bb8eee550a89"></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_dce_device</span></span></span><a class="headerlink" href="#_CPPv420esp_modem_dce_device" title="Permalink to this definition"></a><br /></dt>
<dd><p>DCE devices: Enum list of supported devices. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_GENETICE">
<span id="_CPPv3N20esp_modem_dce_device21ESP_MODEM_DCE_GENETICE"></span><span id="_CPPv2N20esp_modem_dce_device21ESP_MODEM_DCE_GENETICE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1f3ff76188839171bc16bb8eee550a89a40bd78d5ccbdec1288092552ce981664"></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_DCE_GENETIC</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_GENETICE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The most generic device </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E">
<span id="_CPPv3N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E"></span><span id="_CPPv2N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1f3ff76188839171bc16bb8eee550a89aaa3656984e4f5cd71d44b4e2cc0422b2"></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_DCE_SIM7600</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E">
<span id="_CPPv3N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E"></span><span id="_CPPv2N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1f3ff76188839171bc16bb8eee550a89acb6e3cb25dd20b7199069b925b1590b9"></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_DCE_BG96</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dce_device20ESP_MODEM_DCE_SIM800E">
<span id="_CPPv3N20esp_modem_dce_device20ESP_MODEM_DCE_SIM800E"></span><span id="_CPPv2N20esp_modem_dce_device20ESP_MODEM_DCE_SIM800E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1f3ff76188839171bc16bb8eee550a89a73cae337bfc4c99c88071b477e50bfcc"></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_DCE_SIM800</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dce_device20ESP_MODEM_DCE_SIM800E" 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>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv413esp_modem_newPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t">
<span id="_CPPv313esp_modem_newPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t"></span><span id="_CPPv213esp_modem_newPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t"></span><span id="esp_modem_new__esp_modem_dte_config_tCP.esp_modem_dce_config_tCP.esp_netif_tP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga52970f4ff9c5359857119b7f28707360"></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="sig-name descname"><span class="n"><span class="pre">esp_modem_new</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv422esp_modem_dte_config_t" title="esp_modem_dte_config_t"><span class="n"><span class="pre">esp_modem_dte_config_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dte_config</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv422esp_modem_dce_config_t" title="esp_modem_dce_config_t"><span class="n"><span class="pre">esp_modem_dce_config_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dce_config</span></span>, <span class="n"><span class="pre">esp_netif_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">netif</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413esp_modem_newPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Create a generic DCE handle for new modem API. </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>dte_config</strong> – DTE configuration (UART config for now) </p></li>
<li><p><strong>dce_config</strong> – DCE configuration </p></li>
<li><p><strong>netif</strong> – Network interface handle for the data mode</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>DCE pointer on success, NULL on failure </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417esp_modem_new_dev22esp_modem_dce_device_tPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t">
<span id="_CPPv317esp_modem_new_dev22esp_modem_dce_device_tPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t"></span><span id="_CPPv217esp_modem_new_dev22esp_modem_dce_device_tPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t"></span><span id="esp_modem_new_dev__esp_modem_dce_device_t.esp_modem_dte_config_tCP.esp_modem_dce_config_tCP.esp_netif_tP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga102ace0a2f93dc4838e28b7fee24d290"></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="sig-name descname"><span class="n"><span class="pre">esp_modem_new_dev</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv422esp_modem_dce_device_t" title="esp_modem_dce_device_t"><span class="n"><span class="pre">esp_modem_dce_device_t</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">module</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv422esp_modem_dte_config_t" title="esp_modem_dte_config_t"><span class="n"><span class="pre">esp_modem_dte_config_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dte_config</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv422esp_modem_dce_config_t" title="esp_modem_dce_config_t"><span class="n"><span class="pre">esp_modem_dce_config_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dce_config</span></span>, <span class="n"><span class="pre">esp_netif_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">netif</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417esp_modem_new_dev22esp_modem_dce_device_tPK22esp_modem_dte_config_tPK22esp_modem_dce_config_tP11esp_netif_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Create a DCE handle using the supplied device. </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>module</strong> – Specific device for creating this DCE </p></li>
<li><p><strong>dte_config</strong> – DTE configuration (UART config for now) </p></li>
<li><p><strong>dce_config</strong> – DCE configuration </p></li>
<li><p><strong>netif</strong> – Network interface handle for the data mode</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>DCE pointer on success, NULL on failure </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417esp_modem_destroyP15esp_modem_dce_t">
<span id="_CPPv317esp_modem_destroyP15esp_modem_dce_t"></span><span id="_CPPv217esp_modem_destroyP15esp_modem_dce_t"></span><span id="esp_modem_destroy__esp_modem_dce_tP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gad7ea1bd023285cd7c827b66e00cb085a"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_destroy</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417esp_modem_destroyP15esp_modem_dce_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Destroys modem’s DCE handle. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dce</strong> – DCE to destroy </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>
<dd><p>Set operation mode for this DCE. </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>mode</strong> – Desired MODE </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>
</div>
</dd></dl>
</section>
<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">
<dt class="sig sig-object cpp" id="_CPPv414esp_modem_syncv">
<span id="_CPPv314esp_modem_syncv"></span><span id="_CPPv214esp_modem_syncv"></span><span id="esp_modem_sync"></span><span class="target" id="esp__modem__api__commands_8h_1aae389a69782d2e373396b07b26ae003b"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_sync</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414esp_modem_syncv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sends the initial AT sequence to sync up with the device. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv427esp_modem_get_operator_namePc">
<span id="_CPPv327esp_modem_get_operator_namePc"></span><span id="_CPPv227esp_modem_get_operator_namePc"></span><span id="esp_modem_get_operator_name__cP"></span><span class="target" id="esp__modem__api__commands_8h_1a87b4aaa311dde2f8679fea2c58fa4f92"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_get_operator_name</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427esp_modem_get_operator_namePc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Reads the operator name. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>operator</strong> – <strong>[out]</strong> name </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv423esp_modem_store_profilev">
<span id="_CPPv323esp_modem_store_profilev"></span><span id="_CPPv223esp_modem_store_profilev"></span><span id="esp_modem_store_profile"></span><span class="target" id="esp__modem__api__commands_8h_1a7aa4b5cc28b0d1440cfc416e3d60ec74"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_store_profile</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423esp_modem_store_profilev" title="Permalink to this definition"></a><br /></dt>
<dd><p>Stores current user profile. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417esp_modem_set_pinPKc">
<span id="_CPPv317esp_modem_set_pinPKc"></span><span id="_CPPv217esp_modem_set_pinPKc"></span><span id="esp_modem_set_pin__cCP"></span><span class="target" id="esp__modem__api__commands_8h_1adcf823ecf81bad4469105e051ab74c02"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_pin</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pin</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417esp_modem_set_pinPKc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets the supplied PIN code. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pin</strong> – <strong>[in]</strong> Pin </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_read_pinPb">
<span id="_CPPv318esp_modem_read_pinPb"></span><span id="_CPPv218esp_modem_read_pinPb"></span><span id="esp_modem_read_pin__bP"></span><span class="target" id="esp__modem__api__commands_8h_1a5f4eee22b3b0e41850e535c3ef9a2d97"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_read_pin</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pin_ok</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_read_pinPb" title="Permalink to this definition"></a><br /></dt>
<dd><p>Checks if the SIM needs a PIN. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pin_ok</strong> – <strong>[out]</strong> true if the SIM card doesn’t need a PIN to unlock </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_set_echoKb">
<span id="_CPPv318esp_modem_set_echoKb"></span><span id="_CPPv218esp_modem_set_echoKb"></span><span id="esp_modem_set_echo__bC"></span><span class="target" id="esp__modem__api__commands_8h_1a48bee17bab23e4e245564212ec5230d5"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_echo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">echo_on</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_set_echoKb" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets echo mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>echo_on</strong> – <strong>[in]</strong> true if echo mode on (repeats the commands) </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv422esp_modem_sms_txt_modeKb">
<span id="_CPPv322esp_modem_sms_txt_modeKb"></span><span id="_CPPv222esp_modem_sms_txt_modeKb"></span><span id="esp_modem_sms_txt_mode__bC"></span><span class="target" id="esp__modem__api__commands_8h_1a277771d525daa3bf11007554ce7b65dc"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_sms_txt_mode</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">txt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422esp_modem_sms_txt_modeKb" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets the Txt or Pdu mode for SMS (only txt is supported) </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>txt</strong> – <strong>[in]</strong> true if txt mode </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv427esp_modem_sms_character_setv">
<span id="_CPPv327esp_modem_sms_character_setv"></span><span id="_CPPv227esp_modem_sms_character_setv"></span><span id="esp_modem_sms_character_set"></span><span class="target" id="esp__modem__api__commands_8h_1ae214058edfeecd33fb4e266247c5f9c2"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_sms_character_set</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427esp_modem_sms_character_setv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets the default (GSM) charater set. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_send_smsPKcPKc">
<span id="_CPPv318esp_modem_send_smsPKcPKc"></span><span id="_CPPv218esp_modem_send_smsPKcPKc"></span><span id="esp_modem_send_sms__cCP.cCP"></span><span class="target" id="esp__modem__api__commands_8h_1a2e5f9ba75172c7a767b86259d405c74a"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_send_sms</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">number</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">message</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_send_smsPKcPKc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sends SMS message in txt mode. </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>number</strong> – <strong>[in]</strong> Phone number to send the message to </p></li>
<li><p><strong>message</strong> – <strong>[in]</strong> Text message to be sent </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv426esp_modem_resume_data_modev">
<span id="_CPPv326esp_modem_resume_data_modev"></span><span id="_CPPv226esp_modem_resume_data_modev"></span><span id="esp_modem_resume_data_mode"></span><span class="target" id="esp__modem__api__commands_8h_1a92e73f6ace9a8516701f85548f6f26be"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_resume_data_mode</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426esp_modem_resume_data_modev" title="Permalink to this definition"></a><br /></dt>
<dd><p>Resumes data mode (Switches back to th data mode, which was temporarily suspended) </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv425esp_modem_set_pdp_contextP10PdpContext">
<span id="_CPPv325esp_modem_set_pdp_contextP10PdpContext"></span><span id="_CPPv225esp_modem_set_pdp_contextP10PdpContext"></span><span id="esp_modem_set_pdp_context__PdpContextP"></span><span class="target" id="esp__modem__api__commands_8h_1a72d8c02823b03780f37367d5b4fddd1e"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_pdp_context</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">PdpContext</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">p1</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425esp_modem_set_pdp_contextP10PdpContext" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets php context. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>p1</strong> – <strong>[in]</strong> PdP context struct to setup modem cellular connection </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv426esp_modem_set_command_modev">
<span id="_CPPv326esp_modem_set_command_modev"></span><span id="_CPPv226esp_modem_set_command_modev"></span><span id="esp_modem_set_command_mode"></span><span class="target" id="esp__modem__api__commands_8h_1a88e7013264c81f6238920f2e42312bc9"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_command_mode</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426esp_modem_set_command_modev" title="Permalink to this definition"></a><br /></dt>
<dd><p>Switches to the command mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_set_cmuxv">
<span id="_CPPv318esp_modem_set_cmuxv"></span><span id="_CPPv218esp_modem_set_cmuxv"></span><span id="esp_modem_set_cmux"></span><span class="target" id="esp__modem__api__commands_8h_1a5e06c4a95333c696c776a819343cb178"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_cmux</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_set_cmuxv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Switches to the CMUX mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_get_imsiPc">
<span id="_CPPv318esp_modem_get_imsiPc"></span><span id="_CPPv218esp_modem_get_imsiPc"></span><span id="esp_modem_get_imsi__cP"></span><span class="target" id="esp__modem__api__commands_8h_1a741a7428f72055e2fa35939985373643"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_get_imsi</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">imsi</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_get_imsiPc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Reads the IMSI number. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>imsi</strong> – <strong>[out]</strong> Module’s IMSI number </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_get_imeiPc">
<span id="_CPPv318esp_modem_get_imeiPc"></span><span id="_CPPv218esp_modem_get_imeiPc"></span><span id="esp_modem_get_imei__cP"></span><span class="target" id="esp__modem__api__commands_8h_1abf5fd52813daf3e37ffc8e0e72dbb365"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_get_imei</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">imei</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_get_imeiPc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Reads the IMEI number. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>imei</strong> – <strong>[out]</strong> Module’s IMEI number </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv425esp_modem_get_module_namePc">
<span id="_CPPv325esp_modem_get_module_namePc"></span><span id="_CPPv225esp_modem_get_module_namePc"></span><span id="esp_modem_get_module_name__cP"></span><span class="target" id="esp__modem__api__commands_8h_1ab104cfa5988a274f3e3e3a4501c1f271"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_get_module_name</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425esp_modem_get_module_namePc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Reads the module name. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> – <strong>[out]</strong> module name </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv423esp_modem_set_data_modev">
<span id="_CPPv323esp_modem_set_data_modev"></span><span id="_CPPv223esp_modem_set_data_modev"></span><span id="esp_modem_set_data_mode"></span><span class="target" id="esp__modem__api__commands_8h_1aa5ed2c30147eeebeed57b57f989aa8e1"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_data_mode</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423esp_modem_set_data_modev" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets the modem to data mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv428esp_modem_get_signal_qualityPiPi">
<span id="_CPPv328esp_modem_get_signal_qualityPiPi"></span><span id="_CPPv228esp_modem_get_signal_qualityPiPi"></span><span id="esp_modem_get_signal_quality__iP.iP"></span><span class="target" id="esp__modem__api__commands_8h_1a19183c257cf1522d2fd65105e81e850e"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_get_signal_quality</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">rssi</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ber</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428esp_modem_get_signal_qualityPiPi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get Signal quality. </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>rssi</strong> – <strong>[out]</strong> signal strength indication </p></li>
<li><p><strong>ber</strong> – <strong>[out]</strong> channel bit error rate </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv426esp_modem_set_flow_controlii">
<span id="_CPPv326esp_modem_set_flow_controlii"></span><span id="_CPPv226esp_modem_set_flow_controlii"></span><span id="esp_modem_set_flow_control__i.i"></span><span class="target" id="esp__modem__api__commands_8h_1aa3c08efe9006a239196fc3eb09504989"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_flow_control</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">dce_flow</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">dte_flow</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426esp_modem_set_flow_controlii" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets HW control flow. </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_flow</strong> – <strong>[in]</strong> 0=none, 2=RTS hw flow control of DCE </p></li>
<li><p><strong>dte_flow</strong> – <strong>[in]</strong> 0=none, 2=CTS hw flow control of DTE </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417esp_modem_hang_upv">
<span id="_CPPv317esp_modem_hang_upv"></span><span id="_CPPv217esp_modem_hang_upv"></span><span id="esp_modem_hang_up"></span><span class="target" id="esp__modem__api__commands_8h_1ad718da0bb46d6e2e7c2939eb69a9b040"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_hang_up</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417esp_modem_hang_upv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Hangs up current data call. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv428esp_modem_get_battery_statusPiPiPi">
<span id="_CPPv328esp_modem_get_battery_statusPiPiPi"></span><span id="_CPPv228esp_modem_get_battery_statusPiPiPi"></span><span id="esp_modem_get_battery_status__iP.iP.iP"></span><span class="target" id="esp__modem__api__commands_8h_1a8e1856361e95e24ccac5afd8cce2028f"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_get_battery_status</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">voltage</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">bcs</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">bcl</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428esp_modem_get_battery_statusPiPiPi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get voltage levels of modem power up circuitry. </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>voltage</strong> – <strong>[out]</strong> Current status in mV </p></li>
<li><p><strong>bcs</strong> – <strong>[out]</strong> charge status (-1-Not available, 0-Not charging, 1-Charging, 2-Charging done) </p></li>
<li><p><strong>bcl</strong> – <strong>[out]</strong> 1-100% battery capacity, -1-Not available </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv420esp_modem_power_downv">
<span id="_CPPv320esp_modem_power_downv"></span><span id="_CPPv220esp_modem_power_downv"></span><span id="esp_modem_power_down"></span><span class="target" id="esp__modem__api__commands_8h_1a872c6216f9b7d432a2ae79ef8b8132a2"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_power_down</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420esp_modem_power_downv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Power down the module. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv415esp_modem_resetv">
<span id="_CPPv315esp_modem_resetv"></span><span id="_CPPv215esp_modem_resetv"></span><span id="esp_modem_reset"></span><span class="target" id="esp__modem__api__commands_8h_1a35e5bd24fca6dda7f5d328a7876554a1"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415esp_modem_resetv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Reset the module. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418esp_modem_set_baudi">
<span id="_CPPv318esp_modem_set_baudi"></span><span id="_CPPv218esp_modem_set_baudi"></span><span id="esp_modem_set_baud__i"></span><span class="target" id="esp__modem__api__commands_8h_1a20107425f600190a441c77efbbbb991b"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_set_baud</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">baud</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_set_baudi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Configures the baudrate. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>baud</strong> – <strong>[in]</strong> Desired baud rate of the DTE </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>OK, FAIL or TIMEOUT </p>
</dd>
</dl>
</dd></dl>
</div>
</section>
<section id="configuration-structures">
<span id="api-config"></span><h2>Configuration structures<a class="headerlink" href="#configuration-structures" title="Permalink to this headline"></a></h2>
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g"></span><em><span class="pre">group</span></em> <span class="sig-name descname"><span class="pre">ESP_MODEM_CONFIG</span></span></dt>
<dd><p>Configuration structures for DTE and DCE. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.ESP_MODEM_DTE_DEFAULT_CONFIG">
<span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1gadda1b12d9db18d3030a694107a4d33e2"></span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_DTE_DEFAULT_CONFIG</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ESP_MODEM_DTE_DEFAULT_CONFIG" title="Permalink to this definition"></a><br /></dt>
<dd><p>ESP Modem DTE Default Configuration. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.ESP_MODEM_DCE_DEFAULT_CONFIG">
<span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1ga7bb5e5f29bd26426aebb48c6894e65fc"></span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_DCE_DEFAULT_CONFIG</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">APN</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.ESP_MODEM_DCE_DEFAULT_CONFIG" title="Permalink to this definition"></a><br /></dt>
<dd><p>ESP Modem DCE Default Configuration. </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv422esp_modem_dte_config_t">
<span id="_CPPv322esp_modem_dte_config_t"></span><span id="_CPPv222esp_modem_dte_config_t"></span><span id="esp_modem_dte_config_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1ga0195fab8c90095bb289a6265abc85243"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv420esp_modem_dte_config" title="esp_modem_dte_config"><span class="n"><span class="pre">esp_modem_dte_config</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_dte_config_t</span></span></span><a class="headerlink" href="#_CPPv422esp_modem_dte_config_t" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv422esp_modem_dce_config_t">
<span id="_CPPv322esp_modem_dce_config_t"></span><span id="_CPPv222esp_modem_dce_config_t"></span><span id="esp_modem_dce_config_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1ga1868a57156890d831cb6dc3be400b14a"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv420esp_modem_dce_config" title="esp_modem_dce_config"><span class="n"><span class="pre">esp_modem_dce_config</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_dce_config_t</span></span></span><a class="headerlink" href="#_CPPv422esp_modem_dce_config_t" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv421esp_modem_flow_ctrl_t">
<span id="_CPPv321esp_modem_flow_ctrl_t"></span><span id="_CPPv221esp_modem_flow_ctrl_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1gae9adf6b726a1f385b966ed8719cc67cb"></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_flow_ctrl_t</span></span></span><a class="headerlink" href="#_CPPv421esp_modem_flow_ctrl_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Modem flow control type. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N21esp_modem_flow_ctrl_t27ESP_MODEM_FLOW_CONTROL_NONEE">
<span id="_CPPv3N21esp_modem_flow_ctrl_t27ESP_MODEM_FLOW_CONTROL_NONEE"></span><span id="_CPPv2N21esp_modem_flow_ctrl_t27ESP_MODEM_FLOW_CONTROL_NONEE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1ggae9adf6b726a1f385b966ed8719cc67cbaa936838a0e33c3eca980953a3fde8cd0"></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_FLOW_CONTROL_NONE</span></span></span><a class="headerlink" href="#_CPPv4N21esp_modem_flow_ctrl_t27ESP_MODEM_FLOW_CONTROL_NONEE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_SWE">
<span id="_CPPv3N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_SWE"></span><span id="_CPPv2N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_SWE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1ggae9adf6b726a1f385b966ed8719cc67cba9cb864b33cb644e01d63d71ecb29dc54"></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_FLOW_CONTROL_SW</span></span></span><a class="headerlink" href="#_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_SWE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_HWE">
<span id="_CPPv3N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_HWE"></span><span id="_CPPv2N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_HWE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1ggae9adf6b726a1f385b966ed8719cc67cba0cb194c1fb71aefbadf9d5f0a730430b"></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_FLOW_CONTROL_HW</span></span></span><a class="headerlink" href="#_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_HWE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv426esp_modem_uart_term_config">
<span id="_CPPv326esp_modem_uart_term_config"></span><span id="_CPPv226esp_modem_uart_term_config"></span><span id="esp_modem_uart_term_config"></span><span class="target" id="structesp__modem__uart__term__config"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_uart_term_config</span></span></span><a class="headerlink" href="#_CPPv426esp_modem_uart_term_config" title="Permalink to this definition"></a><br /></dt>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_config.h&gt;</em></div>
<p>UART configuration structure. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config8port_numE">
<span id="_CPPv3N26esp_modem_uart_term_config8port_numE"></span><span id="_CPPv2N26esp_modem_uart_term_config8port_numE"></span><span id="esp_modem_uart_term_config::port_num__uart_port_t"></span><span class="target" id="structesp__modem__uart__term__config_1a1f29a8d86f5817f7b38bd511922b6ab5"></span><span class="n"><span class="pre">uart_port_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">port_num</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config8port_numE" title="Permalink to this definition"></a><br /></dt>
<dd><p>UART port number </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config9data_bitsE">
<span id="_CPPv3N26esp_modem_uart_term_config9data_bitsE"></span><span id="_CPPv2N26esp_modem_uart_term_config9data_bitsE"></span><span id="esp_modem_uart_term_config::data_bits__uart_word_length_t"></span><span class="target" id="structesp__modem__uart__term__config_1a0636a1e67878080993a4e9d9c1841a72"></span><span class="n"><span class="pre">uart_word_length_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">data_bits</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config9data_bitsE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Data bits of UART </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config9stop_bitsE">
<span id="_CPPv3N26esp_modem_uart_term_config9stop_bitsE"></span><span id="_CPPv2N26esp_modem_uart_term_config9stop_bitsE"></span><span id="esp_modem_uart_term_config::stop_bits__uart_stop_bits_t"></span><span class="target" id="structesp__modem__uart__term__config_1add65566af80336e4f1b423cb9636d7ea"></span><span class="n"><span class="pre">uart_stop_bits_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">stop_bits</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config9stop_bitsE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Stop bits of UART </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config6parityE">
<span id="_CPPv3N26esp_modem_uart_term_config6parityE"></span><span id="_CPPv2N26esp_modem_uart_term_config6parityE"></span><span id="esp_modem_uart_term_config::parity__uart_parity_t"></span><span class="target" id="structesp__modem__uart__term__config_1a08097cf3f886c1b81f391f1c695ed8d9"></span><span class="n"><span class="pre">uart_parity_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">parity</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config6parityE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Parity type </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config12flow_controlE">
<span id="_CPPv3N26esp_modem_uart_term_config12flow_controlE"></span><span id="_CPPv2N26esp_modem_uart_term_config12flow_controlE"></span><span id="esp_modem_uart_term_config::flow_control__esp_modem_flow_ctrl_t"></span><span class="target" id="structesp__modem__uart__term__config_1a0ee6871653936e03da8be660b360a563"></span><a class="reference internal" href="#_CPPv421esp_modem_flow_ctrl_t" title="esp_modem_flow_ctrl_t"><span class="n"><span class="pre">esp_modem_flow_ctrl_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">flow_control</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config12flow_controlE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Flow control type </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config9baud_rateE">
<span id="_CPPv3N26esp_modem_uart_term_config9baud_rateE"></span><span id="_CPPv2N26esp_modem_uart_term_config9baud_rateE"></span><span id="esp_modem_uart_term_config::baud_rate__i"></span><span class="target" id="structesp__modem__uart__term__config_1a8a0437b3deae3583a06e1ef382a0dc6b"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">baud_rate</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config9baud_rateE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Communication baud rate </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config9tx_io_numE">
<span id="_CPPv3N26esp_modem_uart_term_config9tx_io_numE"></span><span id="_CPPv2N26esp_modem_uart_term_config9tx_io_numE"></span><span id="esp_modem_uart_term_config::tx_io_num__i"></span><span class="target" id="structesp__modem__uart__term__config_1ad41ec9c314e33c49fc2efd454ac39c8a"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">tx_io_num</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config9tx_io_numE" title="Permalink to this definition"></a><br /></dt>
<dd><p>TXD Pin Number </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config9rx_io_numE">
<span id="_CPPv3N26esp_modem_uart_term_config9rx_io_numE"></span><span id="_CPPv2N26esp_modem_uart_term_config9rx_io_numE"></span><span id="esp_modem_uart_term_config::rx_io_num__i"></span><span class="target" id="structesp__modem__uart__term__config_1acb2201574e9c4e5732d4e6520d07ed2a"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">rx_io_num</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config9rx_io_numE" title="Permalink to this definition"></a><br /></dt>
<dd><p>RXD Pin Number </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config10rts_io_numE">
<span id="_CPPv3N26esp_modem_uart_term_config10rts_io_numE"></span><span id="_CPPv2N26esp_modem_uart_term_config10rts_io_numE"></span><span id="esp_modem_uart_term_config::rts_io_num__i"></span><span class="target" id="structesp__modem__uart__term__config_1a1140336a861007a6fbc7fba7643d55d0"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">rts_io_num</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config10rts_io_numE" title="Permalink to this definition"></a><br /></dt>
<dd><p>RTS Pin Number </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config10cts_io_numE">
<span id="_CPPv3N26esp_modem_uart_term_config10cts_io_numE"></span><span id="_CPPv2N26esp_modem_uart_term_config10cts_io_numE"></span><span id="esp_modem_uart_term_config::cts_io_num__i"></span><span class="target" id="structesp__modem__uart__term__config_1a5f040f6c3f16afa36c7ef54536e86988"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cts_io_num</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config10cts_io_numE" title="Permalink to this definition"></a><br /></dt>
<dd><p>CTS Pin Number </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config14rx_buffer_sizeE">
<span id="_CPPv3N26esp_modem_uart_term_config14rx_buffer_sizeE"></span><span id="_CPPv2N26esp_modem_uart_term_config14rx_buffer_sizeE"></span><span id="esp_modem_uart_term_config::rx_buffer_size__i"></span><span class="target" id="structesp__modem__uart__term__config_1a1f08dc2c40578cb28556bf3e7b308301"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">rx_buffer_size</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config14rx_buffer_sizeE" title="Permalink to this definition"></a><br /></dt>
<dd><p>UART RX Buffer Size </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config14tx_buffer_sizeE">
<span id="_CPPv3N26esp_modem_uart_term_config14tx_buffer_sizeE"></span><span id="_CPPv2N26esp_modem_uart_term_config14tx_buffer_sizeE"></span><span id="esp_modem_uart_term_config::tx_buffer_size__i"></span><span class="target" id="structesp__modem__uart__term__config_1a8d0ecdf311a28be3a2d73acc86d63136"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">tx_buffer_size</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config14tx_buffer_sizeE" title="Permalink to this definition"></a><br /></dt>
<dd><p>UART TX Buffer Size </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N26esp_modem_uart_term_config16event_queue_sizeE">
<span id="_CPPv3N26esp_modem_uart_term_config16event_queue_sizeE"></span><span id="_CPPv2N26esp_modem_uart_term_config16event_queue_sizeE"></span><span id="esp_modem_uart_term_config::event_queue_size__i"></span><span class="target" id="structesp__modem__uart__term__config_1ad754cac881b7e9045dca213b8caca6bc"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">event_queue_size</span></span></span><a class="headerlink" href="#_CPPv4N26esp_modem_uart_term_config16event_queue_sizeE" title="Permalink to this definition"></a><br /></dt>
<dd><p>UART Event Queue Size, set to 0 if no event queue needed </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv425esp_modem_vfs_term_config">
<span id="_CPPv325esp_modem_vfs_term_config"></span><span id="_CPPv225esp_modem_vfs_term_config"></span><span id="esp_modem_vfs_term_config"></span><span class="target" id="structesp__modem__vfs__term__config"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_vfs_term_config</span></span></span><a class="headerlink" href="#_CPPv425esp_modem_vfs_term_config" title="Permalink to this definition"></a><br /></dt>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_config.h&gt;</em></div>
<p>VFS configuration structure. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N25esp_modem_vfs_term_config2fdE">
<span id="_CPPv3N25esp_modem_vfs_term_config2fdE"></span><span id="_CPPv2N25esp_modem_vfs_term_config2fdE"></span><span id="esp_modem_vfs_term_config::fd__i"></span><span class="target" id="structesp__modem__vfs__term__config_1a2ba1842a07721e3ac3aad84a73ddd9b6"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">fd</span></span></span><a class="headerlink" href="#_CPPv4N25esp_modem_vfs_term_config2fdE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Already created file descriptor </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N25esp_modem_vfs_term_config7deleterE">
<span id="_CPPv3N25esp_modem_vfs_term_config7deleterE"></span><span id="_CPPv2N25esp_modem_vfs_term_config7deleterE"></span><span class="target" id="structesp__modem__vfs__term__config_1aacff06998b04d41ef3df9b6040b22c35"></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">deleter</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem_vfs_resource</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#_CPPv4N25esp_modem_vfs_term_config7deleterE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Custom close function for the fd </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N25esp_modem_vfs_term_config8resourceE">
<span id="_CPPv3N25esp_modem_vfs_term_config8resourceE"></span><span id="_CPPv2N25esp_modem_vfs_term_config8resourceE"></span><span id="esp_modem_vfs_term_config::resource__esp_modem_vfs_resourceP"></span><span class="target" id="structesp__modem__vfs__term__config_1a3bb430daa0e25d794c9ffbefe14405a0"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem_vfs_resource</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">resource</span></span></span><a class="headerlink" href="#_CPPv4N25esp_modem_vfs_term_config8resourceE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Resource attached to the VFS (need for clenaup) </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420esp_modem_dte_config">
<span id="_CPPv320esp_modem_dte_config"></span><span id="_CPPv220esp_modem_dte_config"></span><span id="esp_modem_dte_config"></span><span class="target" id="structesp__modem__dte__config"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_dte_config</span></span></span><a class="headerlink" href="#_CPPv420esp_modem_dte_config" title="Permalink to this definition"></a><br /></dt>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_config.h&gt;</em></div>
<p>Complete DTE configuration structure. </p>
<p>Note that the generic part is common for DTE and its SW resources The following portions for config is dedicated to the chosen HW resource used as a communication terminal for this DTE </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dte_config15dte_buffer_sizeE">
<span id="_CPPv3N20esp_modem_dte_config15dte_buffer_sizeE"></span><span id="_CPPv2N20esp_modem_dte_config15dte_buffer_sizeE"></span><span id="esp_modem_dte_config::dte_buffer_size__s"></span><span class="target" id="structesp__modem__dte__config_1af0040044f146f5db3f6f0d7a56abee70"></span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">dte_buffer_size</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dte_config15dte_buffer_sizeE" title="Permalink to this definition"></a><br /></dt>
<dd><p>DTE buffer size </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dte_config15task_stack_sizeE">
<span id="_CPPv3N20esp_modem_dte_config15task_stack_sizeE"></span><span id="_CPPv2N20esp_modem_dte_config15task_stack_sizeE"></span><span id="esp_modem_dte_config::task_stack_size__uint32_t"></span><span class="target" id="structesp__modem__dte__config_1a7dae362b026278f25b590c23736db3c8"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">task_stack_size</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dte_config15task_stack_sizeE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Terminal task stack size </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dte_config13task_priorityE">
<span id="_CPPv3N20esp_modem_dte_config13task_priorityE"></span><span id="_CPPv2N20esp_modem_dte_config13task_priorityE"></span><span id="esp_modem_dte_config::task_priority__unsigned"></span><span class="target" id="structesp__modem__dte__config_1af7aa5ffd39069b6d466d0029e5345ab7"></span><span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">task_priority</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dte_config13task_priorityE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Terminal task priority </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dte_config11uart_configE">
<span id="_CPPv3N20esp_modem_dte_config11uart_configE"></span><span id="_CPPv2N20esp_modem_dte_config11uart_configE"></span><span id="esp_modem_dte_config::uart_config__esp_modem_uart_term_config"></span><span class="target" id="structesp__modem__dte__config_1aeed11791481adf6b9bab07e5cc7840bb"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv426esp_modem_uart_term_config" title="esp_modem_uart_term_config"><span class="n"><span class="pre">esp_modem_uart_term_config</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">uart_config</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dte_config11uart_configE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Configuration for UART Terminal </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dte_config10vfs_configE">
<span id="_CPPv3N20esp_modem_dte_config10vfs_configE"></span><span id="_CPPv2N20esp_modem_dte_config10vfs_configE"></span><span id="esp_modem_dte_config::vfs_config__esp_modem_vfs_term_config"></span><span class="target" id="structesp__modem__dte__config_1a31fc825319920ca2763050b826ed6b6f"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv425esp_modem_vfs_term_config" title="esp_modem_vfs_term_config"><span class="n"><span class="pre">esp_modem_vfs_term_config</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">vfs_config</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dte_config10vfs_configE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Configuration for VFS Terminal </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dte_config16extension_configE">
<span id="_CPPv3N20esp_modem_dte_config16extension_configE"></span><span id="_CPPv2N20esp_modem_dte_config16extension_configE"></span><span id="esp_modem_dte_config::extension_config__voidP"></span><span class="target" id="structesp__modem__dte__config_1a925b3b56e29a2d0f1640d6c7bc7329b0"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">extension_config</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dte_config16extension_configE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Configuration for app specific Terminal </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420esp_modem_dce_config">
<span id="_CPPv320esp_modem_dce_config"></span><span id="_CPPv220esp_modem_dce_config"></span><span id="esp_modem_dce_config"></span><span class="target" id="structesp__modem__dce__config"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_dce_config</span></span></span><a class="headerlink" href="#_CPPv420esp_modem_dce_config" title="Permalink to this definition"></a><br /></dt>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_config.h&gt;</em></div>
<p>DCE configuration structure. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20esp_modem_dce_config3apnE">
<span id="_CPPv3N20esp_modem_dce_config3apnE"></span><span id="_CPPv2N20esp_modem_dce_config3apnE"></span><span id="esp_modem_dce_config::apn__cCP"></span><span class="target" id="structesp__modem__dce__config_1a2f15999abb92aec07d766ce2487507ba"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">apn</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dce_config3apnE" title="Permalink to this definition"></a><br /></dt>
<dd><p>APN: Logical name of the Access point </p>
</dd></dl>
</div>
</dd></dl>
</dd></dl>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">esp-modem</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README.html">Brief intro</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">C interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#lifecycle-api">Lifecycle API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#modem-commands">Modem commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configuration-structures">Configuration structures</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cxx_api_docs.html">C++ interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced_api.html">Advanced use cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="internal_design.html">Internal design</a></li>
<li class="toctree-l1"><a class="reference internal" href="internal_docs.html">Internal implementation</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="README.html" title="previous chapter">ESP MODEM</a></li>
<li>Next: <a href="cxx_api_docs.html" title="next chapter">C++ API Documentation</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/api_docs.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink