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

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

Browse Source
This commit is contained in:
david-cermak
2022-02-23 10:02:54 +00:00
parent 891c2a93c5
commit 6909de5825
25 changed files with 100 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
esp_modem/.doctrees/README.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/advanced_api.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/api_docs.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/cxx_api_docs.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/cxx_api_links.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/environment.pickle
View File

Binary file not shown.

BIN
esp_modem/.doctrees/index.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/internal_design.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/internal_docs.doctree
View File

Binary file not shown.

2
esp_modem/README.html
View File

@@ -200,7 +200,7 @@ as a class derived from <code class="docutils literal notranslate"><span class="
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

3
esp_modem/_static/basic.css
View File

@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -757,6 +757,7 @@ span.pre {
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}
div[class*="highlight-"] {

5
esp_modem/_static/doctools.js
View File

@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -264,6 +264,9 @@ var Documentation = {
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
var url = new URL(window.location);
url.searchParams.delete('highlight');
window.history.replaceState({}, '', url);
},
/**

2
esp_modem/_static/language_data.js
View File

@@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

2
esp_modem/_static/searchtools.js
View File

@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

23
esp_modem/advanced_api.html
View File

@@ -51,9 +51,9 @@
<dd><p><a class="reference internal" href="internal_docs.html#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a> modem factory. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv49ModemType">
<span id="_CPPv39ModemType"></span><span id="_CPPv29ModemType"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___f_a_c_t_o_r_y_1ga34f5bd407ce186b43f44b5c8cfbf2fd9"></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">ModemType</span></span></span><a class="headerlink" href="#_CPPv49ModemType" title="Permalink to this definition"></a><br /></dt>
<span id="_CPPv39ModemType"></span><span id="_CPPv29ModemType"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___f_a_c_t_o_r_y_1ga34f5bd407ce186b43f44b5c8cfbf2fd9"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ModemType</span></span></span><a class="headerlink" href="#_CPPv49ModemType" title="Permalink to this definition"></a><br /></dt>
<dd><p>Specific modem choice when creating by the <a class="reference internal" href="#classesp__modem_1_1dce__factory_1_1_factory"><span class="std std-ref">Factory</span></a>. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
@@ -86,24 +86,29 @@
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem11dce_factory13FactoryHelperE">
<span id="_CPPv3N9esp_modem11dce_factory13FactoryHelperE"></span><span id="_CPPv2N9esp_modem11dce_factory13FactoryHelperE"></span><span id="esp_modem::dce_factory::FactoryHelper"></span><span class="target" id="classesp__modem_1_1dce__factory_1_1_factory_helper"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FactoryHelper</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem11dce_factory13FactoryHelperE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce_factory.hpp&gt;</em><p>Helper class for creating a user define pointer in a specific way, either as a plain pointer, shared_ptr or unique_ptr. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_factory.hpp&gt;</em></div>
<p>Helper class for creating a user define pointer in a specific way, either as a plain pointer, shared_ptr or unique_ptr. </p>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4I0EN9esp_modem11dce_factory7CreatorE">
<span id="_CPPv3I0EN9esp_modem11dce_factory7CreatorE"></span><span id="_CPPv2I0EN9esp_modem11dce_factory7CreatorE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T_Module</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="classesp__modem_1_1dce__factory_1_1_creator"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Creator</span></span></span><a class="headerlink" href="#_CPPv4I0EN9esp_modem11dce_factory7CreatorE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce_factory.hpp&gt;</em><p><a class="reference internal" href="#classesp__modem_1_1dce__factory_1_1_creator"><span class="std std-ref">Creator</span></a> class for building a DCE_T&lt;Module&gt; in a specific way, either from a Module object or by default from the <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a> and netif. </p>
<p><dl class="field-list simple">
<dt class="field-odd">throws <span class="colon">:</span></dt>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_factory.hpp&gt;</em></div>
<p><a class="reference internal" href="#classesp__modem_1_1dce__factory_1_1_creator"><span class="std std-ref">Creator</span></a> class for building a DCE_T&lt;Module&gt; in a specific way, either from a Module object or by default from the <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a> and netif. </p>
<dl class="field-list simple">
<dt class="field-odd">Throws <span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</p>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem11dce_factory7FactoryE">
<span id="_CPPv3N9esp_modem11dce_factory7FactoryE"></span><span id="_CPPv2N9esp_modem11dce_factory7FactoryE"></span><span id="esp_modem::dce_factory::Factory"></span><span class="target" id="classesp__modem_1_1dce__factory_1_1_factory"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">dce_factory</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Factory</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem11dce_factory7FactoryE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce_factory.hpp&gt;</em><p><a class="reference internal" href="#classesp__modem_1_1dce__factory_1_1_factory"><span class="std std-ref">Factory</span></a> class for creating virtual <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a> objects based on the configuration of the supplied module. This could also be used to create a custom module or a DCE_T&lt;module&gt;, provided user app derives from this factory. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_factory.hpp&gt;</em></div>
<p><a class="reference internal" href="#classesp__modem_1_1dce__factory_1_1_factory"><span class="std std-ref">Factory</span></a> class for creating virtual <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a> objects based on the configuration of the supplied module. This could also be used to create a custom module or a DCE_T&lt;module&gt;, provided user app derives from this factory. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
@@ -270,7 +275,7 @@ a custom DTE object and supply it into <a class="reference internal" href="#dce-
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

18
esp_modem/api_docs.html
View File

@@ -589,7 +589,9 @@ pointer as the return value. The API expects the output data to point to user al
<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><em>#include &lt;esp_modem_config.h&gt;</em><p>UART configuration structure. </p>
<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">
@@ -676,7 +678,9 @@ pointer as the return value. The API expects the output data to point to user al
<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><em>#include &lt;esp_modem_config.h&gt;</em><p>VFS configuration structure. </p>
<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">
@@ -703,7 +707,9 @@ pointer as the return value. The API expects the output data to point to user al
<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><em>#include &lt;esp_modem_config.h&gt;</em><p>Complete DTE configuration structure. </p>
<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>
@@ -743,7 +749,9 @@ pointer as the return value. The API expects the output data to point to user al
<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><em>#include &lt;esp_modem_dce_config.h&gt;</em><p>DCE configuration structure. </p>
<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">
@@ -826,7 +834,7 @@ pointer as the return value. The API expects the output data to point to user al
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

2
esp_modem/cxx_api_docs.html
View File

@@ -263,7 +263,7 @@ It simply gets destroyed and cleaned-up automatically if the object goes out of
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

2
esp_modem/cxx_api_links.html
View File

@@ -117,7 +117,7 @@
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

2
esp_modem/genindex.html
View File

@@ -522,7 +522,7 @@
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>

2
esp_modem/index.html
View File

@@ -159,7 +159,7 @@
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

2
esp_modem/internal_design.html
View File

@@ -145,7 +145,7 @@ to multiplex the terminal.</p>
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

84
esp_modem/internal_docs.html
View File

@@ -55,13 +55,17 @@
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem8DCE_ModeE">
<span id="_CPPv3N9esp_modem8DCE_ModeE"></span><span id="_CPPv2N9esp_modem8DCE_ModeE"></span><span id="esp_modem::DCE_Mode"></span><span class="target" id="classesp__modem_1_1_d_c_e___mode"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DCE_Mode</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem8DCE_ModeE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce.hpp&gt;</em><p>Helper class responsible for switching modes of the <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a>’s. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce.hpp&gt;</em></div>
<p>Helper class responsible for switching modes of the <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a>’s. </p>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4I0EN9esp_modem5DCE_TE">
<span id="_CPPv3I0EN9esp_modem5DCE_TE"></span><span id="_CPPv2I0EN9esp_modem5DCE_TE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SpecificModule</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="classesp__modem_1_1_d_c_e___t"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">DCE_T</span></span></span><br /></dt>
<dd><em>#include &lt;esp_modem_dce.hpp&gt;</em><p>General <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a> class templated on a specific module. It is responsible for all the necessary transactions related to switching modes and consequent synergy with aggregated objects of <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a>, <a class="reference internal" href="#classesp__modem_1_1_netif"><span class="std std-ref">Netif</span></a> and a specific Module. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce.hpp&gt;</em></div>
<p>General <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a> class templated on a specific module. It is responsible for all the necessary transactions related to switching modes and consequent synergy with aggregated objects of <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a>, <a class="reference internal" href="#classesp__modem_1_1_netif"><span class="std std-ref">Netif</span></a> and a specific Module. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
@@ -76,7 +80,9 @@
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem3DCEE">
<span id="_CPPv3N9esp_modem3DCEE"></span><span id="_CPPv2N9esp_modem3DCEE"></span><span id="esp_modem::DCE"></span><span class="target" id="classesp__modem_1_1_d_c_e"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">DCE</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="cxx_api_docs.html#_CPPv4I0EN9esp_modem5DCE_TE" title="esp_modem::DCE_T"><span class="n"><span class="pre">DCE_T</span></span></a><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4N9esp_modem13GenericModuleE" title="esp_modem::GenericModule"><span class="n"><span class="pre">GenericModule</span></span></a><span class="p"><span class="pre">&gt;</span></span><a class="headerlink" href="#_CPPv4N9esp_modem3DCEE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce.hpp&gt;</em><p>Common abstraction of the modem <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a>, specialized by the <a class="reference internal" href="#classesp__modem_1_1_generic_module"><span class="std std-ref">GenericModule</span></a> which is a parent class for the supported devices and most common modems, as well. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce.hpp&gt;</em></div>
<p>Common abstraction of the modem <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a>, specialized by the <a class="reference internal" href="#classesp__modem_1_1_generic_module"><span class="std std-ref">GenericModule</span></a> which is a parent class for the supported devices and most common modems, as well. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
@@ -419,7 +425,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem3DTEE">
<span id="_CPPv3N9esp_modem3DTEE"></span><span id="_CPPv2N9esp_modem3DTEE"></span><span id="esp_modem::DTE"></span><span class="target" id="classesp__modem_1_1_d_t_e"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">DTE</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9esp_modem13CommandableIfE" title="esp_modem::CommandableIf"><span class="n"><span class="pre">CommandableIf</span></span></a><a class="headerlink" href="#_CPPv4N9esp_modem3DTEE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dte.hpp&gt;</em><p><a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a> (Data <a class="reference internal" href="#classesp__modem_1_1_terminal"><span class="std std-ref">Terminal</span></a> Equipment) class </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dte.hpp&gt;</em></div>
<p><a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a> (Data <a class="reference internal" href="#classesp__modem_1_1_terminal"><span class="std std-ref">Terminal</span></a> Equipment) class </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
@@ -532,9 +540,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dd><p>Definition of an abstract terminal to be attached to <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a> class. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv414terminal_error">
<span id="_CPPv314terminal_error"></span><span id="_CPPv214terminal_error"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_e_r_m_i_n_a_l_1ga9e2467aa5656f359e3dbcc33b28416ea"></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">terminal_error</span></span></span><a class="headerlink" href="#_CPPv414terminal_error" title="Permalink to this definition"></a><br /></dt>
<span id="_CPPv314terminal_error"></span><span id="_CPPv214terminal_error"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_e_r_m_i_n_a_l_1ga9e2467aa5656f359e3dbcc33b28416ea"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">terminal_error</span></span></span><a class="headerlink" href="#_CPPv414terminal_error" title="Permalink to this definition"></a><br /></dt>
<dd><p><a class="reference internal" href="#classesp__modem_1_1_terminal"><span class="std std-ref">Terminal</span></a> errors. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
@@ -558,7 +566,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem8TerminalE">
<span id="_CPPv3N9esp_modem8TerminalE"></span><span id="_CPPv2N9esp_modem8TerminalE"></span><span id="esp_modem::Terminal"></span><span class="target" id="classesp__modem_1_1_terminal"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Terminal</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem8TerminalE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_terminal.hpp&gt;</em><p><a class="reference internal" href="#classesp__modem_1_1_terminal"><span class="std std-ref">Terminal</span></a> interface. All communication interfaces must comply to this interface in order to be used as a <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a>. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_terminal.hpp&gt;</em></div>
<p><a class="reference internal" href="#classesp__modem_1_1_terminal"><span class="std std-ref">Terminal</span></a> interface. All communication interfaces must comply to this interface in order to be used as a <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a>. </p>
<p>Subclassed by <a class="reference internal" href="#classesp__modem_1_1_c_mux_instance"><span class="std std-ref">esp_modem::CMuxInstance</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
@@ -610,9 +620,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dd><p>Definition of CMUX terminal. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv410cmux_state">
<span id="_CPPv310cmux_state"></span><span id="_CPPv210cmux_state"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_m_u_x_1gaed095049f722d0a7b9bcc1e545279627"></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">cmux_state</span></span></span><a class="headerlink" href="#_CPPv410cmux_state" title="Permalink to this definition"></a><br /></dt>
<span id="_CPPv310cmux_state"></span><span id="_CPPv210cmux_state"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c_m_u_x_1gaed095049f722d0a7b9bcc1e545279627"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cmux_state</span></span></span><a class="headerlink" href="#_CPPv410cmux_state" title="Permalink to this definition"></a><br /></dt>
<dd><p>CMUX state machine. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
@@ -646,7 +656,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem4CMuxE">
<span id="_CPPv3N9esp_modem4CMuxE"></span><span id="_CPPv2N9esp_modem4CMuxE"></span><span id="esp_modem::CMux"></span><span class="target" id="classesp__modem_1_1_c_mux"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CMux</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem4CMuxE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_cmux.hpp&gt;</em><p><a class="reference internal" href="#classesp__modem_1_1_c_mux"><span class="std std-ref">CMux</span></a> class which consumes the original terminal and creates multiple virtual terminals from it. This class itself is not usable as a <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a> terminal, only via its instances defined in <code class="docutils literal notranslate"><a class="reference internal" href="#classesp__modem_1_1_c_mux_instance"><span class="std std-ref"><span class="pre">CMuxInstance</span></span></a></code> </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_cmux.hpp&gt;</em></div>
<p><a class="reference internal" href="#classesp__modem_1_1_c_mux"><span class="std std-ref">CMux</span></a> class which consumes the original terminal and creates multiple virtual terminals from it. This class itself is not usable as a <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a> terminal, only via its instances defined in <code class="docutils literal notranslate"><a class="reference internal" href="#classesp__modem_1_1_c_mux_instance"><span class="std std-ref"><span class="pre">CMuxInstance</span></span></a></code> </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
@@ -698,7 +710,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem12CMuxInstanceE">
<span id="_CPPv3N9esp_modem12CMuxInstanceE"></span><span id="_CPPv2N9esp_modem12CMuxInstanceE"></span><span id="esp_modem::CMuxInstance"></span><span class="target" id="classesp__modem_1_1_c_mux_instance"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CMuxInstance</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9esp_modem8TerminalE" title="esp_modem::Terminal"><span class="n"><span class="pre">Terminal</span></span></a><a class="headerlink" href="#_CPPv4N9esp_modem12CMuxInstanceE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_cmux.hpp&gt;</em><p>This represents a specific instance of a CMUX virtual terminal. This class also implements <a class="reference internal" href="#classesp__modem_1_1_terminal"><span class="std std-ref">Terminal</span></a> interface and as such could be used as a <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a>’s terminal. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_cmux.hpp&gt;</em></div>
<p>This represents a specific instance of a CMUX virtual terminal. This class also implements <a class="reference internal" href="#classesp__modem_1_1_terminal"><span class="std std-ref">Terminal</span></a> interface and as such could be used as a <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">DTE</span></a>’s terminal. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
@@ -751,7 +765,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem5NetifE">
<span id="_CPPv3N9esp_modem5NetifE"></span><span id="_CPPv2N9esp_modem5NetifE"></span><span id="esp_modem::Netif"></span><span class="target" id="classesp__modem_1_1_netif"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Netif</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem5NetifE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_netif.hpp&gt;</em><p>Network interface class responsible to glue the esp-netif to the modem’s <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a>. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_netif.hpp&gt;</em></div>
<p>Network interface class responsible to glue the esp-netif to the modem’s <a class="reference internal" href="#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a>. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
@@ -787,7 +803,9 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem13GenericModuleE">
<span id="_CPPv3N9esp_modem13GenericModuleE"></span><span id="_CPPv2N9esp_modem13GenericModuleE"></span><span id="esp_modem::GenericModule"></span><span class="target" id="classesp__modem_1_1_generic_module"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">GenericModule</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9esp_modem8ModuleIfE" title="esp_modem::ModuleIf"><span class="n"><span class="pre">ModuleIf</span></span></a><a class="headerlink" href="#_CPPv4N9esp_modem13GenericModuleE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce_module.hpp&gt;</em><p>This is a basic building block for custom modules as well as for the supported modules in the esp-modem component It derives from the <a class="reference internal" href="#classesp__modem_1_1_module_if"><span class="std std-ref">ModuleIf</span></a>. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_module.hpp&gt;</em></div>
<p>This is a basic building block for custom modules as well as for the supported modules in the esp-modem component It derives from the <a class="reference internal" href="#classesp__modem_1_1_module_if"><span class="std std-ref">ModuleIf</span></a>. </p>
<p>Subclassed by <a class="reference internal" href="#classesp__modem_1_1_b_g96"><span class="std std-ref">esp_modem::BG96</span></a>, <a class="reference internal" href="#classesp__modem_1_1_s_i_m7600"><span class="std std-ref">esp_modem::SIM7600</span></a>, <a class="reference internal" href="#classesp__modem_1_1_s_i_m800"><span class="std std-ref">esp_modem::SIM800</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
@@ -821,19 +839,25 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem7SIM7600E">
<span id="_CPPv3N9esp_modem7SIM7600E"></span><span id="_CPPv2N9esp_modem7SIM7600E"></span><span id="esp_modem::SIM7600"></span><span class="target" id="classesp__modem_1_1_s_i_m7600"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SIM7600</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9esp_modem13GenericModuleE" title="esp_modem::GenericModule"><span class="n"><span class="pre">GenericModule</span></span></a><a class="headerlink" href="#_CPPv4N9esp_modem7SIM7600E" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce_module.hpp&gt;</em><p>Specific definition of the <a class="reference internal" href="#classesp__modem_1_1_s_i_m7600"><span class="std std-ref">SIM7600</span></a> module. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_module.hpp&gt;</em></div>
<p>Specific definition of the <a class="reference internal" href="#classesp__modem_1_1_s_i_m7600"><span class="std std-ref">SIM7600</span></a> module. </p>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem6SIM800E">
<span id="_CPPv3N9esp_modem6SIM800E"></span><span id="_CPPv2N9esp_modem6SIM800E"></span><span id="esp_modem::SIM800"></span><span class="target" id="classesp__modem_1_1_s_i_m800"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SIM800</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9esp_modem13GenericModuleE" title="esp_modem::GenericModule"><span class="n"><span class="pre">GenericModule</span></span></a><a class="headerlink" href="#_CPPv4N9esp_modem6SIM800E" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce_module.hpp&gt;</em><p>Specific definition of the <a class="reference internal" href="#classesp__modem_1_1_s_i_m800"><span class="std std-ref">SIM800</span></a> module. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_module.hpp&gt;</em></div>
<p>Specific definition of the <a class="reference internal" href="#classesp__modem_1_1_s_i_m800"><span class="std std-ref">SIM800</span></a> module. </p>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem4BG96E">
<span id="_CPPv3N9esp_modem4BG96E"></span><span id="_CPPv2N9esp_modem4BG96E"></span><span id="esp_modem::BG96"></span><span class="target" id="classesp__modem_1_1_b_g96"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BG96</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N9esp_modem13GenericModuleE" title="esp_modem::GenericModule"><span class="n"><span class="pre">GenericModule</span></span></a><a class="headerlink" href="#_CPPv4N9esp_modem4BG96E" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_dce_module.hpp&gt;</em><p>Specific definition of the <a class="reference internal" href="#classesp__modem_1_1_b_g96"><span class="std std-ref">BG96</span></a> module. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_dce_module.hpp&gt;</em></div>
<p>Specific definition of the <a class="reference internal" href="#classesp__modem_1_1_b_g96"><span class="std std-ref">BG96</span></a> module. </p>
</dd></dl>
</dd></dl>
@@ -925,9 +949,9 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv410modem_mode">
<span id="_CPPv310modem_mode"></span><span id="_CPPv210modem_mode"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1ga80fa0ae4f6b04bc4e753bd207e0f298f"></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">modem_mode</span></span></span><a class="headerlink" href="#_CPPv410modem_mode" title="Permalink to this definition"></a><br /></dt>
<span id="_CPPv310modem_mode"></span><span id="_CPPv210modem_mode"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1ga80fa0ae4f6b04bc4e753bd207e0f298f"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">modem_mode</span></span></span><a class="headerlink" href="#_CPPv410modem_mode" title="Permalink to this definition"></a><br /></dt>
<dd><p>Modem working mode. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
@@ -938,26 +962,26 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode12COMMAND_MODEE">
<span id="_CPPv3N10modem_mode12COMMAND_MODEE"></span><span id="_CPPv2N10modem_mode12COMMAND_MODEE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fa023ec1c4bd62841e0c7d56d231e9c739"></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">COMMAND_MODE</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode12COMMAND_MODEE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Command mode the modem is supposed to send AT commands in this mode </p>
<dd><p>Command mode &amp;#8212; the modem is supposed to send AT commands in this mode </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode9DATA_MODEE">
<span id="_CPPv3N10modem_mode9DATA_MODEE"></span><span id="_CPPv2N10modem_mode9DATA_MODEE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fa58e19a67d77f6b9de4aeb7f7ca337ee2"></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">DATA_MODE</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode9DATA_MODEE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Data mode the modem communicates with network interface on PPP protocol </p>
<dd><p>Data mode &amp;#8212; the modem communicates with network interface on PPP protocol </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode9CMUX_MODEE">
<span id="_CPPv3N10modem_mode9CMUX_MODEE"></span><span id="_CPPv2N10modem_mode9CMUX_MODEE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fa30495670a3b2cf47b0dea06ee25e148b"></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">CMUX_MODE</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode9CMUX_MODEE" title="Permalink to this definition"></a><br /></dt>
<dd><p>CMUX (Multiplex mode) Simplified CMUX mode, which creates two virtual terminals, assigning one solely to command interface and the other to the data mode </p>
<dd><p>CMUX (Multiplex mode) &amp;#8212; Simplified CMUX mode, which creates two virtual terminals, assigning one solely to command interface and the other to the data mode </p>
</dd></dl>
</dd></dl>
<dl class="cpp enum">
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv414command_result">
<span id="_CPPv314command_result"></span><span id="_CPPv214command_result"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gac47d24e750cc329387e893697d1f132f"></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">command_result</span></span></span><a class="headerlink" href="#_CPPv414command_result" title="Permalink to this definition"></a><br /></dt>
<span id="_CPPv314command_result"></span><span id="_CPPv214command_result"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gac47d24e750cc329387e893697d1f132f"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">command_result</span></span></span><a class="headerlink" href="#_CPPv414command_result" title="Permalink to this definition"></a><br /></dt>
<dd><p>Module command result. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
@@ -984,13 +1008,17 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem10PdpContextE">
<span id="_CPPv3N9esp_modem10PdpContextE"></span><span id="_CPPv2N9esp_modem10PdpContextE"></span><span id="esp_modem::PdpContext"></span><span class="target" id="structesp__modem_1_1_pdp_context"></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">PdpContext</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem10PdpContextE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_types.hpp&gt;</em><p>PDP context used for configuring and setting the data mode up. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_types.hpp&gt;</em></div>
<p>PDP context used for configuring and setting the data mode up. </p>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem13CommandableIfE">
<span id="_CPPv3N9esp_modem13CommandableIfE"></span><span id="_CPPv2N9esp_modem13CommandableIfE"></span><span id="esp_modem::CommandableIf"></span><span class="target" id="classesp__modem_1_1_commandable_if"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CommandableIf</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem13CommandableIfE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_types.hpp&gt;</em><p>Interface for classes eligible to send AT commands (Modules, DCEs, DTEs) </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_types.hpp&gt;</em></div>
<p>Interface for classes eligible to send AT commands (Modules, DCEs, DTEs) </p>
<p>Subclassed by <a class="reference internal" href="#classesp__modem_1_1_d_t_e"><span class="std std-ref">esp_modem::DTE</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
@@ -1018,7 +1046,9 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem8ModuleIfE">
<span id="_CPPv3N9esp_modem8ModuleIfE"></span><span id="_CPPv2N9esp_modem8ModuleIfE"></span><span id="esp_modem::ModuleIf"></span><span class="target" id="classesp__modem_1_1_module_if"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">esp_modem</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">ModuleIf</span></span></span><a class="headerlink" href="#_CPPv4N9esp_modem8ModuleIfE" title="Permalink to this definition"></a><br /></dt>
<dd><em>#include &lt;esp_modem_types.hpp&gt;</em><p>Interface for classes implementing a module for the modem. </p>
<dd><div class="docutils container">
<em>#include &lt;esp_modem_types.hpp&gt;</em></div>
<p>Interface for classes implementing a module for the modem. </p>
<p>Subclassed by <a class="reference internal" href="#classesp__modem_1_1_generic_module"><span class="std std-ref">esp_modem::GenericModule</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
@@ -1130,7 +1160,7 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

BIN
esp_modem/objects.inv
View File

Binary file not shown.

2
esp_modem/search.html
View File

@@ -115,7 +115,7 @@
&copy;2016 - 2021, Espressif Systems (Shanghai) Co., Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>

2
esp_modem/searchindex.js
View File

File diff suppressed because one or more lines are too long