forked from espressif/esp-protocols
Deploying to gh-pages from @ espressif/esp-protocols@0875008a46 🚀
This commit is contained in:
david-cermak
@@ -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">
|
||||
|
||||
Reference in New Issue
Block a user