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

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

Browse Source
This commit is contained in:
david-cermak
2022-05-25 11:23:16 +00:00
parent 24844b3dc9
commit 3d503d3719
19 changed files with 463 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esp_modem/.doctrees/advanced_api.doctree
BIN
View File
Binary file not shown.
esp_modem/.doctrees/api_docs.doctree
BIN
View File
Binary file not shown.
esp_modem/.doctrees/cxx_api_docs.doctree
BIN
View File
Binary file not shown.
esp_modem/.doctrees/cxx_api_links.doctree
BIN
View File
Binary file not shown.
esp_modem/.doctrees/environment.pickle
BIN
View File
Binary file not shown.
esp_modem/.doctrees/internal_docs.doctree
BIN
View File
Binary file not shown.
esp_modem/_sources/cxx_api_links.rst.txt
+11 -1
View File
@@ -22,4 +22,14 @@
- :cpp:func:`esp_modem::DCE::get_battery_status`
- :cpp:func:`esp_modem::DCE::power_down`
- :cpp:func:`esp_modem::DCE::reset`
- :cpp:func:`esp_modem::DCE::set_baud`
- :cpp:func:`esp_modem::DCE::set_baud`
- :cpp:func:`esp_modem::DCE::set_operator`
- :cpp:func:`esp_modem::DCE::set_network_attachment_state`
- :cpp:func:`esp_modem::DCE::get_network_attachment_state`
- :cpp:func:`esp_modem::DCE::set_radio_state`
- :cpp:func:`esp_modem::DCE::get_radio_state`
- :cpp:func:`esp_modem::DCE::set_network_mode`
- :cpp:func:`esp_modem::DCE::set_preferred_mode`
- :cpp:func:`esp_modem::DCE::set_network_bands`
- :cpp:func:`esp_modem::DCE::get_network_system_mode`
- :cpp:func:`esp_modem::DCE::set_gnss_power_mode`
esp_modem/advanced_api.html
+12
View File
@@ -68,6 +68,18 @@
<dd><p>Derived from the <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_generic_module"><span class="std std-ref">GenericModule</span></a>, specifics applied to <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_s_i_m7600"><span class="std std-ref">SIM7600</span></a> model </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N9ModemType7SIM7070E">
<span id="_CPPv3N9ModemType7SIM7070E"></span><span id="_CPPv2N9ModemType7SIM7070E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___f_a_c_t_o_r_y_1gga34f5bd407ce186b43f44b5c8cfbf2fd9a17612eb64619563fb0b5c35d046d419d"></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">SIM7070</span></span></span><a class="headerlink" href="#_CPPv4N9ModemType7SIM7070E" title="Permalink to this definition"></a><br /></dt>
<dd><p>Derived from the <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_generic_module"><span class="std std-ref">GenericModule</span></a>, specifics applied to <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_s_i_m7070"><span class="std std-ref">SIM7070</span></a> model </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N9ModemType7SIM7000E">
<span id="_CPPv3N9ModemType7SIM7000E"></span><span id="_CPPv2N9ModemType7SIM7000E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___f_a_c_t_o_r_y_1gga34f5bd407ce186b43f44b5c8cfbf2fd9a719215eb78ae5f264bb9af70af9aedaa"></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">SIM7000</span></span></span><a class="headerlink" href="#_CPPv4N9ModemType7SIM7000E" title="Permalink to this definition"></a><br /></dt>
<dd><p>Derived from the <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_generic_module"><span class="std std-ref">GenericModule</span></a>, specifics applied to <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_s_i_m7000"><span class="std std-ref">SIM7000</span></a> model </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N9ModemType4BG96E">
<span id="_CPPv3N9ModemType4BG96E"></span><span id="_CPPv2N9ModemType4BG96E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___f_a_c_t_o_r_y_1gga34f5bd407ce186b43f44b5c8cfbf2fd9a80e1af61101ed94123673230a16bdbe0"></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">BG96</span></span></span><a class="headerlink" href="#_CPPv4N9ModemType4BG96E" title="Permalink to this definition"></a><br /></dt>
esp_modem/api_docs.html
+154
View File
@@ -114,6 +114,16 @@
<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_device21ESP_MODEM_DCE_SIM7070E">
<span id="_CPPv3N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7070E"></span><span id="_CPPv2N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7070E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1f3ff76188839171bc16bb8eee550a89ac6c4880fc6c8b4ef1c2a51a97e204dca"></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_SIM7070</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7070E" 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_device21ESP_MODEM_DCE_SIM7000E">
<span id="_CPPv3N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7000E"></span><span id="_CPPv2N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7000E"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1gga1f3ff76188839171bc16bb8eee550a89ae1a065d07af853039322ed1105eb3ab7"></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_SIM7000</span></span></span><a class="headerlink" href="#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7000E" 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>
@@ -525,6 +535,150 @@ pointer as the return value. The API expects the output data to point to user al
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv422esp_modem_set_operatoriiPKc">
<span id="_CPPv322esp_modem_set_operatoriiPKc"></span><span id="_CPPv222esp_modem_set_operatoriiPKc"></span><span id="esp_modem_set_operator__i.i.cCP"></span><span class="target" id="esp__modem__api__commands_8h_1a0ecc34c5c641bd27f793abe631668cde"></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_operator</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">mode</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">format</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">oper</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422esp_modem_set_operatoriiPKc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Force an attempt to connect to a specific operator. </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>mode</strong> – <strong>[in]</strong> mode of attempt mode=0 - automatic mode=1 - manual mode=2 - deregister mode=3 - set format for read operation mode=4 - manual with fallback to automatic </p></li>
<li><p><strong>format</strong> – <strong>[in]</strong> what format the operator is given in format=0 - long format format=1 - short format format=2 - numeric </p></li>
<li><p><strong>oper</strong> – <strong>[in]</strong> the operator to connect to </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="_CPPv438esp_modem_set_network_attachment_statei">
<span id="_CPPv338esp_modem_set_network_attachment_statei"></span><span id="_CPPv238esp_modem_set_network_attachment_statei"></span><span id="esp_modem_set_network_attachment_state__i"></span><span class="target" id="esp__modem__api__commands_8h_1aa5740b04601815aad17194be83803636"></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_network_attachment_state</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">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv438esp_modem_set_network_attachment_statei" title="Permalink to this definition"></a><br /></dt>
<dd><p>Attach or detach from the GPRS service. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[in]</strong> 1-attach 0-detach </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="_CPPv438esp_modem_get_network_attachment_statePi">
<span id="_CPPv338esp_modem_get_network_attachment_statePi"></span><span id="_CPPv238esp_modem_get_network_attachment_statePi"></span><span id="esp_modem_get_network_attachment_state__iP"></span><span class="target" id="esp__modem__api__commands_8h_1a2e52cc922ab637cd609a351e3854b661"></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_network_attachment_state</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">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv438esp_modem_get_network_attachment_statePi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get network attachment state. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[out]</strong> 1-attached 0-detached </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_set_radio_statei">
<span id="_CPPv325esp_modem_set_radio_statei"></span><span id="_CPPv225esp_modem_set_radio_statei"></span><span id="esp_modem_set_radio_state__i"></span><span class="target" id="esp__modem__api__commands_8h_1a6fdc7fd018de06178c1e5d00e90ac34a"></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_radio_state</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">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425esp_modem_set_radio_statei" title="Permalink to this definition"></a><br /></dt>
<dd><p>What mode the radio should be set to. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[in]</strong> state 1-full 0-minimum … </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_radio_statePi">
<span id="_CPPv325esp_modem_get_radio_statePi"></span><span id="_CPPv225esp_modem_get_radio_statePi"></span><span id="esp_modem_get_radio_state__iP"></span><span class="target" id="esp__modem__api__commands_8h_1a3f789ee98e4f987409e20e6af5357374"></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_radio_state</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">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425esp_modem_get_radio_statePi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get current radio state. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[out]</strong> 1-full 0-minimum … </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_network_modei">
<span id="_CPPv326esp_modem_set_network_modei"></span><span id="_CPPv226esp_modem_set_network_modei"></span><span id="esp_modem_set_network_mode__i"></span><span class="target" id="esp__modem__api__commands_8h_1ab5115c28a1fd2072457764382d4f80b8"></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_network_mode</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">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426esp_modem_set_network_modei" title="Permalink to this definition"></a><br /></dt>
<dd><p>Set network mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[in]</strong> preferred 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="_CPPv428esp_modem_set_preferred_modei">
<span id="_CPPv328esp_modem_set_preferred_modei"></span><span id="_CPPv228esp_modem_set_preferred_modei"></span><span id="esp_modem_set_preferred_mode__i"></span><span class="target" id="esp__modem__api__commands_8h_1a087b1a65483fb08748f716aa12dae83c"></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_preferred_mode</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">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428esp_modem_set_preferred_modei" title="Permalink to this definition"></a><br /></dt>
<dd><p>Preferred network mode (CAT-M and/or NB-IoT) </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[in]</strong> preferred selection </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_set_network_bandsPKcPKii">
<span id="_CPPv327esp_modem_set_network_bandsPKcPKii"></span><span id="_CPPv227esp_modem_set_network_bandsPKcPKii"></span><span id="esp_modem_set_network_bands__cCP.iCP.i"></span><span class="target" id="esp__modem__api__commands_8h_1a98c17279c541200a882028819524329b"></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_network_bands</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">mode</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </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">bands</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427esp_modem_set_network_bandsPKcPKii" title="Permalink to this definition"></a><br /></dt>
<dd><p>Set network bands for CAT-M or NB-IoT. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[in]</strong> CAT-M or NB-IoT </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="_CPPv433esp_modem_get_network_system_modePi">
<span id="_CPPv333esp_modem_get_network_system_modePi"></span><span id="_CPPv233esp_modem_get_network_system_modePi"></span><span id="esp_modem_get_network_system_mode__iP"></span><span class="target" id="esp__modem__api__commands_8h_1ae484a55162d67056e2e958f2fbd61cfd"></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_network_system_mode</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">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv433esp_modem_get_network_system_modePi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Show network system mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[out]</strong> current network 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="_CPPv429esp_modem_set_gnss_power_modei">
<span id="_CPPv329esp_modem_set_gnss_power_modei"></span><span id="_CPPv229esp_modem_set_gnss_power_modei"></span><span id="esp_modem_set_gnss_power_mode__i"></span><span class="target" id="esp__modem__api__commands_8h_1a0b1e8b668c2ce03d0865290f3d978c46"></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_gnss_power_mode</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">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv429esp_modem_set_gnss_power_modei" title="Permalink to this definition"></a><br /></dt>
<dd><p>GNSS power control. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[out]</strong> power mode (0 - off, 1 - on) </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">
esp_modem/cxx_api_docs.html
+22
View File
@@ -120,6 +120,18 @@
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418create_SIM7070_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">
<span id="_CPPv318create_SIM7070_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t"></span><span id="_CPPv218create_SIM7070_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t"></span><span id="create_SIM7070_dce__dce_configCP.std::shared_ptr:DTE:.esp_netif_tP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___i_n_i_t___d_c_e_1gab043e285535f359c1b1024a9bcffea23"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">DCE</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">create_SIM7070_dce</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="#_CPPv410dce_config" title="dce_config"><span class="n"><span class="pre">dce_config</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">config</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">DTE</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">dte</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="#_CPPv418create_SIM7070_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Create <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a> based on <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_s_i_m7070"><span class="std std-ref">SIM7070</span></a> module. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418create_SIM7000_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">
<span id="_CPPv318create_SIM7000_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t"></span><span id="_CPPv218create_SIM7000_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t"></span><span id="create_SIM7000_dce__dce_configCP.std::shared_ptr:DTE:.esp_netif_tP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___i_n_i_t___d_c_e_1ga472839e7151b9ec7e89856225e0ae62a"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">DCE</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">create_SIM7000_dce</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="#_CPPv410dce_config" title="dce_config"><span class="n"><span class="pre">dce_config</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">config</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">DTE</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">dte</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="#_CPPv418create_SIM7000_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t" title="Permalink to this definition"></a><br /></dt>
<dd><p>Create <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_d_c_e"><span class="std std-ref">DCE</span></a> based on <a class="reference internal" href="internal_docs.html#classesp__modem_1_1_s_i_m7000"><span class="std std-ref">SIM7000</span></a> module. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">
<span id="_CPPv317create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t"></span><span id="_CPPv217create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t"></span><span id="create_SIM800_dce__dce_configCP.std::shared_ptr:DTE:.esp_netif_tP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___i_n_i_t___d_c_e_1gab349608fb7df969de3a107c9cd5caeb1"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">DCE</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">create_SIM800_dce</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="#_CPPv410dce_config" title="dce_config"><span class="n"><span class="pre">dce_config</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">config</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">DTE</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">dte</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="#_CPPv417create_SIM800_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t" title="Permalink to this definition"></a><br /></dt>
@@ -187,6 +199,16 @@
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE10power_downEv" title="esp_modem::DCE::power_down"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::power_down()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE5resetEv" title="esp_modem::DCE::reset"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::reset()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE8set_baudEi" title="esp_modem::DCE::set_baud"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_baud()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE12set_operatorEiiRKNSt6stringE" title="esp_modem::DCE::set_operator"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_operator()()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE28set_network_attachment_stateEi" title="esp_modem::DCE::set_network_attachment_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_attachment_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE28get_network_attachment_stateERi" title="esp_modem::DCE::get_network_attachment_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_network_attachment_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE15set_radio_stateEi" title="esp_modem::DCE::set_radio_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_radio_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE15get_radio_stateERi" title="esp_modem::DCE::get_radio_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_radio_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE16set_network_modeEi" title="esp_modem::DCE::set_network_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE18set_preferred_modeEi" title="esp_modem::DCE::set_preferred_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_preferred_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii" title="esp_modem::DCE::set_network_bands"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_bands()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE23get_network_system_modeERi" title="esp_modem::DCE::get_network_system_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_network_system_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE19set_gnss_power_modeEi" title="esp_modem::DCE::set_gnss_power_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_gnss_power_mode()</span></code></a></p></li>
</ul>
</section>
<section id="destroy-the-dce">
esp_modem/cxx_api_links.html
+10
View File
@@ -56,6 +56,16 @@
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE10power_downEv" title="esp_modem::DCE::power_down"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::power_down()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE5resetEv" title="esp_modem::DCE::reset"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::reset()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE8set_baudEi" title="esp_modem::DCE::set_baud"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_baud()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE12set_operatorEiiRKNSt6stringE" title="esp_modem::DCE::set_operator"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_operator()()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE28set_network_attachment_stateEi" title="esp_modem::DCE::set_network_attachment_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_attachment_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE28get_network_attachment_stateERi" title="esp_modem::DCE::get_network_attachment_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_network_attachment_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE15set_radio_stateEi" title="esp_modem::DCE::set_radio_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_radio_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE15get_radio_stateERi" title="esp_modem::DCE::get_radio_state"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_radio_state()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE16set_network_modeEi" title="esp_modem::DCE::set_network_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE18set_preferred_modeEi" title="esp_modem::DCE::set_preferred_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_preferred_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii" title="esp_modem::DCE::set_network_bands"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_bands()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE23get_network_system_modeERi" title="esp_modem::DCE::get_network_system_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_network_system_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE19set_gnss_power_modeEi" title="esp_modem::DCE::set_gnss_power_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_gnss_power_mode()</span></code></a></p></li>
</ul>
esp_modem/genindex.html
+69 -5
View File
@@ -63,15 +63,19 @@
</li>
<li><a href="internal_docs.html#_CPPv4N14command_result4FAILE">command_result::FAIL (C++ enumerator)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv4N14command_result2OKE">command_result::OK (C++ enumerator)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv4N14command_result7TIMEOUTE">command_result::TIMEOUT (C++ enumerator)</a>
</li>
<li><a href="cxx_api_docs.html#_CPPv415create_BG96_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">create_BG96_dce (C++ function)</a>
</li>
<li><a href="cxx_api_docs.html#_CPPv418create_generic_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">create_generic_dce (C++ function)</a>
</li>
<li><a href="cxx_api_docs.html#_CPPv418create_SIM7000_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">create_SIM7000_dce (C++ function)</a>
</li>
<li><a href="cxx_api_docs.html#_CPPv418create_SIM7070_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">create_SIM7070_dce (C++ function)</a>
</li>
<li><a href="cxx_api_docs.html#_CPPv418create_SIM7600_dcePK10dce_configNSt10shared_ptrI3DTEEEP11esp_netif_t">create_SIM7600_dce (C++ function)</a>
</li>
@@ -128,8 +132,14 @@
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE8get_imsiERNSt6stringE">esp_modem::DCE::get_imsi (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE15get_module_nameERNSt6stringE">esp_modem::DCE::get_module_name (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE28get_network_attachment_stateERi">esp_modem::DCE::get_network_attachment_state (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE23get_network_system_modeERi">esp_modem::DCE::get_network_system_mode (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE17get_operator_nameERNSt6stringE">esp_modem::DCE::get_operator_name (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE15get_radio_stateERi">esp_modem::DCE::get_radio_state (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE18get_signal_qualityERiRi">esp_modem::DCE::get_signal_quality (C++ function)</a>
</li>
@@ -156,10 +166,24 @@
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE8set_echoEKb">esp_modem::DCE::set_echo (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE16set_flow_controlEii">esp_modem::DCE::set_flow_control (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE19set_gnss_power_modeEi">esp_modem::DCE::set_gnss_power_mode (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE28set_network_attachment_stateEi">esp_modem::DCE::set_network_attachment_state (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii">esp_modem::DCE::set_network_bands (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE16set_network_modeEi">esp_modem::DCE::set_network_mode (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE12set_operatorEiiRKNSt6stringE">esp_modem::DCE::set_operator (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE15set_pdp_contextER10PdpContext">esp_modem::DCE::set_pdp_context (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE7set_pinERKNSt6stringE">esp_modem::DCE::set_pin (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE18set_preferred_modeEi">esp_modem::DCE::set_preferred_mode (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE15set_radio_stateEi">esp_modem::DCE::set_radio_state (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE17sms_character_setEv">esp_modem::DCE::sms_character_set (C++ function)</a>
</li>
@@ -224,6 +248,10 @@
<li><a href="internal_docs.html#_CPPv4N9esp_modem5Netif20wait_until_ppp_exitsEv">esp_modem::Netif::wait_until_ppp_exits (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem10PdpContextE">esp_modem::PdpContext (C++ struct)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem7SIM7000E">esp_modem::SIM7000 (C++ class)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem7SIM7070E">esp_modem::SIM7070 (C++ class)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem7SIM7600E">esp_modem::SIM7600 (C++ class)</a>
</li>
@@ -250,6 +278,10 @@
<li><a href="api_docs.html#_CPPv4N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E">esp_modem_dce_device::ESP_MODEM_DCE_BG96 (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_GENETICE">esp_modem_dce_device::ESP_MODEM_DCE_GENETIC (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7000E">esp_modem_dce_device::ESP_MODEM_DCE_SIM7000 (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7070E">esp_modem_dce_device::ESP_MODEM_DCE_SIM7070 (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E">esp_modem_dce_device::ESP_MODEM_DCE_SIM7600 (C++ enumerator)</a>
</li>
@@ -302,8 +334,14 @@
<li><a href="api_docs.html#_CPPv418esp_modem_get_imsiPc">esp_modem_get_imsi (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv425esp_modem_get_module_namePc">esp_modem_get_module_name (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv438esp_modem_get_network_attachment_statePi">esp_modem_get_network_attachment_state (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv433esp_modem_get_network_system_modePi">esp_modem_get_network_system_mode (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv427esp_modem_get_operator_namePc">esp_modem_get_operator_name (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv425esp_modem_get_radio_statePi">esp_modem_get_radio_state (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv428esp_modem_get_signal_qualityPiPi">esp_modem_get_signal_quality (C++ function)</a>
</li>
@@ -334,12 +372,26 @@
<li><a href="api_docs.html#_CPPv418esp_modem_set_echoKb">esp_modem_set_echo (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv426esp_modem_set_flow_controlii">esp_modem_set_flow_control (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv429esp_modem_set_gnss_power_modei">esp_modem_set_gnss_power_mode (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv418esp_modem_set_modeP15esp_modem_dce_t20esp_modem_dce_mode_t">esp_modem_set_mode (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv438esp_modem_set_network_attachment_statei">esp_modem_set_network_attachment_state (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv427esp_modem_set_network_bandsPKcPKii">esp_modem_set_network_bands (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv426esp_modem_set_network_modei">esp_modem_set_network_mode (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv422esp_modem_set_operatoriiPKc">esp_modem_set_operator (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv425esp_modem_set_pdp_contextP10PdpContext">esp_modem_set_pdp_context (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv417esp_modem_set_pinPKc">esp_modem_set_pin (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv428esp_modem_set_preferred_modei">esp_modem_set_preferred_mode (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv425esp_modem_set_radio_statei">esp_modem_set_radio_state (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv427esp_modem_sms_character_setv">esp_modem_sms_character_set (C++ function)</a>
</li>
@@ -413,13 +465,17 @@
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode5UNDEFE">modem_mode::UNDEF (C++ enumerator)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="advanced_api.html#_CPPv49ModemType">ModemType (C++ enum)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="advanced_api.html#_CPPv4N9ModemType4BG96E">ModemType::BG96 (C++ enumerator)</a>
</li>
<li><a href="advanced_api.html#_CPPv4N9ModemType13GenericModuleE">ModemType::GenericModule (C++ enumerator)</a>
</li>
<li><a href="advanced_api.html#_CPPv4N9ModemType7SIM7000E">ModemType::SIM7000 (C++ enumerator)</a>
</li>
<li><a href="advanced_api.html#_CPPv4N9ModemType7SIM7070E">ModemType::SIM7070 (C++ enumerator)</a>
</li>
<li><a href="advanced_api.html#_CPPv4N9ModemType7SIM7600E">ModemType::SIM7600 (C++ enumerator)</a>
</li>
@@ -431,10 +487,12 @@
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv418power_down_sim7xxxP13CommandableIf">power_down_sim7xxx (C++ function)</a>
<li><a href="internal_docs.html#_CPPv418power_down_sim70xxP13CommandableIf">power_down_sim70xx (C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv418power_down_sim76xxP13CommandableIf">power_down_sim76xx (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv417power_down_sim8xxP13CommandableIf">power_down_sim8xx (C++ function)</a>
</li>
</ul></td>
@@ -444,6 +502,12 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv420set_data_mode_sim8xxP13CommandableIf">set_data_mode_sim8xx (C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv427set_gnss_power_mode_sim76xxP13CommandableIfi">set_gnss_power_mode_sim76xx (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv425set_network_bands_sim76xxP13CommandableIfRKNSt6stringEPKii">set_network_bands_sim76xx (C++ function)</a>
</li>
</ul></td>
</tr></table>
esp_modem/internal_docs.html
+178 -3
View File
@@ -404,6 +404,150 @@
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem3DCE12set_operatorEiiRKNSt6stringE">
<span id="_CPPv3N9esp_modem3DCE12set_operatorEiiRKNSt6stringE"></span><span id="_CPPv2N9esp_modem3DCE12set_operatorEiiRKNSt6stringE"></span><span id="esp_modem::DCE::set_operator__i.i.ssCR"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a8de584fff3a10e799b3e9f653cddc9d0"></span><a class="reference internal" href="#_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">set_operator</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">mode</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">format</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">oper</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE12set_operatorEiiRKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Force an attempt to connect to a specific operator. </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>mode</strong> – <strong>[in]</strong> mode of attempt mode=0 - automatic mode=1 - manual mode=2 - deregister mode=3 - set format for read operation mode=4 - manual with fallback to automatic </p></li>
<li><p><strong>format</strong> – <strong>[in]</strong> what format the operator is given in format=0 - long format format=1 - short format format=2 - numeric </p></li>
<li><p><strong>oper</strong> – <strong>[in]</strong> the operator to connect to </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="_CPPv4N9esp_modem3DCE28set_network_attachment_stateEi">
<span id="_CPPv3N9esp_modem3DCE28set_network_attachment_stateEi"></span><span id="_CPPv2N9esp_modem3DCE28set_network_attachment_stateEi"></span><span id="esp_modem::DCE::set_network_attachment_state__i"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a4a9ddaabcf93c3059dc9ec9ee0ff4524"></span><a class="reference internal" href="#_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">set_network_attachment_state</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">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE28set_network_attachment_stateEi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Attach or detach from the GPRS service. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[in]</strong> 1-attach 0-detach </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="_CPPv4N9esp_modem3DCE28get_network_attachment_stateERi">
<span id="_CPPv3N9esp_modem3DCE28get_network_attachment_stateERi"></span><span id="_CPPv2N9esp_modem3DCE28get_network_attachment_stateERi"></span><span id="esp_modem::DCE::get_network_attachment_state__iR"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a78d3d8ecf90f068cef5975a5a4359afb"></span><a class="reference internal" href="#_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">get_network_attachment_state</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">&amp;</span></span><span class="n sig-param"><span class="pre">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE28get_network_attachment_stateERi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get network attachment state. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[out]</strong> 1-attached 0-detached </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="_CPPv4N9esp_modem3DCE15set_radio_stateEi">
<span id="_CPPv3N9esp_modem3DCE15set_radio_stateEi"></span><span id="_CPPv2N9esp_modem3DCE15set_radio_stateEi"></span><span id="esp_modem::DCE::set_radio_state__i"></span><span class="target" id="classesp__modem_1_1_d_c_e_1ad2a3b7db8dbe2942cf824b84e25e7a9c"></span><a class="reference internal" href="#_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">set_radio_state</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">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE15set_radio_stateEi" title="Permalink to this definition"></a><br /></dt>
<dd><p>What mode the radio should be set to. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[in]</strong> state 1-full 0-minimum … </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="_CPPv4N9esp_modem3DCE15get_radio_stateERi">
<span id="_CPPv3N9esp_modem3DCE15get_radio_stateERi"></span><span id="_CPPv2N9esp_modem3DCE15get_radio_stateERi"></span><span id="esp_modem::DCE::get_radio_state__iR"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a3f3a18928ab1ade320ece8c9167862f6"></span><a class="reference internal" href="#_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">get_radio_state</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">&amp;</span></span><span class="n sig-param"><span class="pre">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE15get_radio_stateERi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get current radio state. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>state</strong> – <strong>[out]</strong> 1-full 0-minimum … </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="_CPPv4N9esp_modem3DCE16set_network_modeEi">
<span id="_CPPv3N9esp_modem3DCE16set_network_modeEi"></span><span id="_CPPv2N9esp_modem3DCE16set_network_modeEi"></span><span id="esp_modem::DCE::set_network_mode__i"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a49103b6df52b4e35fe7e62cecae3a5d0"></span><a class="reference internal" href="#_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">set_network_mode</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">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE16set_network_modeEi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Set network mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[in]</strong> preferred 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="_CPPv4N9esp_modem3DCE18set_preferred_modeEi">
<span id="_CPPv3N9esp_modem3DCE18set_preferred_modeEi"></span><span id="_CPPv2N9esp_modem3DCE18set_preferred_modeEi"></span><span id="esp_modem::DCE::set_preferred_mode__i"></span><span class="target" id="classesp__modem_1_1_d_c_e_1ad79bdadc3b28aa641e77af56ae749a5b"></span><a class="reference internal" href="#_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">set_preferred_mode</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">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE18set_preferred_modeEi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Preferred network mode (CAT-M and/or NB-IoT) </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[in]</strong> preferred selection </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="_CPPv4N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii">
<span id="_CPPv3N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii"></span><span id="_CPPv2N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii"></span><span id="esp_modem::DCE::set_network_bands__ssCR.iCP.i"></span><span class="target" id="classesp__modem_1_1_d_c_e_1ae5b5440ff5dd8bd81c4636eef5c9f9cd"></span><a class="reference internal" href="#_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">set_network_bands</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">mode</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </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">bands</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii" title="Permalink to this definition"></a><br /></dt>
<dd><p>Set network bands for CAT-M or NB-IoT. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[in]</strong> CAT-M or NB-IoT </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="_CPPv4N9esp_modem3DCE23get_network_system_modeERi">
<span id="_CPPv3N9esp_modem3DCE23get_network_system_modeERi"></span><span id="_CPPv2N9esp_modem3DCE23get_network_system_modeERi"></span><span id="esp_modem::DCE::get_network_system_mode__iR"></span><span class="target" id="classesp__modem_1_1_d_c_e_1ace6a75b18d97b7e28f52435a9e00e7af"></span><a class="reference internal" href="#_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">get_network_system_mode</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">&amp;</span></span><span class="n sig-param"><span class="pre">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE23get_network_system_modeERi" title="Permalink to this definition"></a><br /></dt>
<dd><p>Show network system mode. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[out]</strong> current network 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="_CPPv4N9esp_modem3DCE19set_gnss_power_modeEi">
<span id="_CPPv3N9esp_modem3DCE19set_gnss_power_modeEi"></span><span id="_CPPv2N9esp_modem3DCE19set_gnss_power_modeEi"></span><span id="esp_modem::DCE::set_gnss_power_mode__i"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a51d148854c9d5310101e0d1ac67ac015"></span><a class="reference internal" href="#_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">set_gnss_power_mode</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">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE19set_gnss_power_modeEi" title="Permalink to this definition"></a><br /></dt>
<dd><p>GNSS power control. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[out]</strong> power mode (0 - off, 1 - on) </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>
</dd></dl>
@@ -806,7 +950,7 @@ terminals. Besides the DTE documentation, this section also refers to the</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>
<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_m7000"><span class="std std-ref">esp_modem::SIM7000</span></a>, <a class="reference internal" href="#classesp__modem_1_1_s_i_m7070"><span class="std std-ref">esp_modem::SIM7070</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>
<dl class="cpp function">
@@ -844,6 +988,22 @@ terminals. Besides the DTE documentation, this section also refers to the</p>
<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_modem7SIM7070E">
<span id="_CPPv3N9esp_modem7SIM7070E"></span><span id="_CPPv2N9esp_modem7SIM7070E"></span><span id="esp_modem::SIM7070"></span><span class="target" id="classesp__modem_1_1_s_i_m7070"></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">SIM7070</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_modem7SIM7070E" title="Permalink to this definition"></a><br /></dt>
<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_m7070"><span class="std std-ref">SIM7070</span></a> module. </p>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem7SIM7000E">
<span id="_CPPv3N9esp_modem7SIM7000E"></span><span id="_CPPv2N9esp_modem7SIM7000E"></span><span id="esp_modem::SIM7000"></span><span class="target" id="classesp__modem_1_1_s_i_m7000"></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">SIM7000</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_modem7SIM7000E" title="Permalink to this definition"></a><br /></dt>
<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_m7000"><span class="std std-ref">SIM7000</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>
@@ -914,8 +1074,23 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418power_down_sim7xxxP13CommandableIf">
<span id="_CPPv318power_down_sim7xxxP13CommandableIf"></span><span id="_CPPv218power_down_sim7xxxP13CommandableIf"></span><span id="power_down_sim7xxx__CommandableIfP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___c_o_m_m_a_n_d_1ga4a78776f1eb012f918b9ce86174f7cca"></span><a class="reference internal" href="#_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">power_down_sim7xxx</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">CommandableIf</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">t</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418power_down_sim7xxxP13CommandableIf" title="Permalink to this definition"></a><br /></dt>
<dt class="sig sig-object cpp" id="_CPPv427set_gnss_power_mode_sim76xxP13CommandableIfi">
<span id="_CPPv327set_gnss_power_mode_sim76xxP13CommandableIfi"></span><span id="_CPPv227set_gnss_power_mode_sim76xxP13CommandableIfi"></span><span id="set_gnss_power_mode_sim76xx__CommandableIfP.i"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___c_o_m_m_a_n_d_1ga059f01a3e02e2788cbd88e6dd9ee8f88"></span><a class="reference internal" href="#_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">set_gnss_power_mode_sim76xx</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">CommandableIf</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">t</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427set_gnss_power_mode_sim76xxP13CommandableIfi" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418power_down_sim76xxP13CommandableIf">
<span id="_CPPv318power_down_sim76xxP13CommandableIf"></span><span id="_CPPv218power_down_sim76xxP13CommandableIf"></span><span id="power_down_sim76xx__CommandableIfP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___c_o_m_m_a_n_d_1ga2c5425184e6412ed1fd26a131c2f12f0"></span><a class="reference internal" href="#_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">power_down_sim76xx</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">CommandableIf</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">t</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418power_down_sim76xxP13CommandableIf" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418power_down_sim70xxP13CommandableIf">
<span id="_CPPv318power_down_sim70xxP13CommandableIf"></span><span id="_CPPv218power_down_sim70xxP13CommandableIf"></span><span id="power_down_sim70xx__CommandableIfP"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___c_o_m_m_a_n_d_1ga5c77c76b111445d0994664a526f4cb3a"></span><a class="reference internal" href="#_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">power_down_sim70xx</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">CommandableIf</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">t</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418power_down_sim70xxP13CommandableIf" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv425set_network_bands_sim76xxP13CommandableIfRKNSt6stringEPKii">
<span id="_CPPv325set_network_bands_sim76xxP13CommandableIfRKNSt6stringEPKii"></span><span id="_CPPv225set_network_bands_sim76xxP13CommandableIfRKNSt6stringEPKii"></span><span id="set_network_bands_sim76xx__CommandableIfP.ssCR.iCP.i"></span><span class="target" id="group___e_s_p___m_o_d_e_m___d_c_e___c_o_m_m_a_n_d_1gaef65172c7740ab61f7cce6617064e823"></span><a class="reference internal" href="#_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">set_network_bands_sim76xx</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">CommandableIf</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">t</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">mode</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </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">bands</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425set_network_bands_sim76xxP13CommandableIfRKNSt6stringEPKii" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
esp_modem/objects.inv
BIN
View File
Binary file not shown.
esp_modem/searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long
esp_websocket_client/.buildinfo
+1 -1
View File
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7d448f47af6288760e5205413f60477c
config: ffefc02a15d790b1bd35c6f7eaf72d9f
tags: 549b3d6d0415232fb7e35403b330ff49
esp_websocket_client/genindex.html
+1 -1
View File
@@ -163,7 +163,7 @@
<a href="https://github.com/espressif/esp-docs/blob/a661e51/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/0875008/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
esp_websocket_client/index.html
+3 -3
View File
@@ -191,7 +191,7 @@
<a href="https://github.com/espressif/esp-docs/blob/a661e51/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/0875008/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
@@ -314,7 +314,7 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
</section>
<section id="application-example">
<h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2>
<p>A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the <a class="reference external" href="https://websocket.org">websocket.org</a> server can be found here: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/a661e51/examples/../examples">example </a>.</p>
<p>A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the <a class="reference external" href="https://websocket.org">websocket.org</a> server can be found here: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/0875008/examples/../examples">example </a>.</p>
<section id="sending-text-data">
<h3>Sending Text Data<a class="headerlink" href="#sending-text-data" title="Permalink to this headline"></a></h3>
<p>The WebSocket client supports sending data as a text data frame, which informs the application layer that the payload data is text data encoded as UTF-8. Example:</p>
@@ -328,7 +328,7 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
<section id="header-file">
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/a661e51/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/0875008/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul>
</section>
<section id="functions">
esp_websocket_client/search.html
+1 -1
View File
@@ -165,7 +165,7 @@
<a href="https://github.com/espressif/esp-docs/blob/a661e51/docs/en/search" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/0875008/docs/en/search" class="fa fa-github"> Edit on GitHub</a>