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

2025-08-07 14:44:28 +02:00 · 2022-06-23 16:02:50 +00:00
parent e430a3e081
commit 221bd62387
22 changed files with 59 additions and 18 deletions
--- a/esp_modem/.doctrees/api_docs.doctree
+++ b/esp_modem/.doctrees/api_docs.doctree
--- a/esp_modem/.doctrees/cxx_api_docs.doctree
+++ b/esp_modem/.doctrees/cxx_api_docs.doctree
--- a/esp_modem/.doctrees/cxx_api_links.doctree
+++ b/esp_modem/.doctrees/cxx_api_links.doctree
--- a/esp_modem/.doctrees/environment.pickle
+++ b/esp_modem/.doctrees/environment.pickle
--- a/esp_modem/.doctrees/internal_docs.doctree
+++ b/esp_modem/.doctrees/internal_docs.doctree
--- a/esp_modem/_sources/cxx_api_links.rst.txt
+++ b/esp_modem/_sources/cxx_api_links.rst.txt
@@ -3,6 +3,7 @@
 - :cpp:func:`esp_modem::DCE::get_operator_name` 
 - :cpp:func:`esp_modem::DCE::store_profile` 
 - :cpp:func:`esp_modem::DCE::set_pin` 
+- :cpp:func:`esp_modem::DCE::at` 
 - :cpp:func:`esp_modem::DCE::read_pin` 
 - :cpp:func:`esp_modem::DCE::set_echo` 
 - :cpp:func:`esp_modem::DCE::sms_txt_mode` 
--- a/esp_modem/api_docs.html
+++ b/esp_modem/api_docs.html
@@ -273,6 +273,23 @@ 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="_CPPv412esp_modem_atPKcPc">
+<span id="_CPPv312esp_modem_atPKcPc"></span><span id="_CPPv212esp_modem_atPKcPc"></span><span id="esp_modem_at__cCP.cP"></span><span class="target" id="esp__modem__api__commands_8h_1a256fbe280b71485f00699b2df9e59760"></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_at</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">cmd</span></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">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412esp_modem_atPKcPc" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Execute the supplied AT command. </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>at</strong> – <strong>[in]</strong> AT command </p></li>
+<li><p><strong>out</strong> – <strong>[out]</strong> Command output string </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="_CPPv418esp_modem_read_pinPb">
 <span id="_CPPv318esp_modem_read_pinPb"></span><span id="_CPPv218esp_modem_read_pinPb"></span><span id="esp_modem_read_pin__bP"></span><span class="target" id="esp__modem__api__commands_8h_1a5f4eee22b3b0e41850e535c3ef9a2d97"></span><a class="reference internal" href="internal_docs.html#_CPPv414command_result" title="command_result"><span class="n"><span class="pre">command_result</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_read_pin</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pin_ok</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418esp_modem_read_pinPb" title="Permalink to this definition">¶</a><br /></dt>
--- a/esp_modem/cxx_api_docs.html
+++ b/esp_modem/cxx_api_docs.html
@@ -180,6 +180,7 @@
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE17get_operator_nameERNSt6stringE" title="esp_modem::DCE::get_operator_name"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_operator_name()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE13store_profileEv" title="esp_modem::DCE::store_profile"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::store_profile()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE7set_pinERKNSt6stringE" title="esp_modem::DCE::set_pin"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_pin()</span></code></a></p></li>
+<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE2atERKNSt6stringERNSt6stringE" title="esp_modem::DCE::at"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::at()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE8read_pinERb" title="esp_modem::DCE::read_pin"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::read_pin()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE8set_echoEKb" title="esp_modem::DCE::set_echo"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_echo()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE12sms_txt_modeEKb" title="esp_modem::DCE::sms_txt_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::sms_txt_mode()</span></code></a></p></li>
--- a/esp_modem/cxx_api_links.html
+++ b/esp_modem/cxx_api_links.html
@@ -37,6 +37,7 @@
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE17get_operator_nameERNSt6stringE" title="esp_modem::DCE::get_operator_name"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_operator_name()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE13store_profileEv" title="esp_modem::DCE::store_profile"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::store_profile()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE7set_pinERKNSt6stringE" title="esp_modem::DCE::set_pin"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_pin()</span></code></a></p></li>
+<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE2atERKNSt6stringERNSt6stringE" title="esp_modem::DCE::at"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::at()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE8read_pinERb" title="esp_modem::DCE::read_pin"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::read_pin()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE8set_echoEKb" title="esp_modem::DCE::set_echo"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_echo()</span></code></a></p></li>
 <li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE12sms_txt_modeEKb" title="esp_modem::DCE::sms_txt_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::sms_txt_mode()</span></code></a></p></li>
--- a/esp_modem/genindex.html
+++ b/esp_modem/genindex.html
@@ -129,6 +129,8 @@
      <li><a href="internal_docs.html#_CPPv4N9esp_modem13CommandableIf7commandERKNSt6stringE11got_line_cb8uint32_tKc">esp_modem::CommandableIf::command (C++ function)</a>
 </li>
      <li><a href="internal_docs.html#_CPPv4N9esp_modem3DCEE">esp_modem::DCE (C++ class)</a>
+</li>
+      <li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE2atERKNSt6stringERNSt6stringE">esp_modem::DCE::at (C++ function)</a>
 </li>
      <li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE18get_battery_statusERiRiRi">esp_modem::DCE::get_battery_status (C++ function)</a>
 </li>
@@ -268,12 +270,14 @@
 </li>
      <li><a href="internal_docs.html#_CPPv4N9esp_modem8Terminal5writeEP7uint8_t6size_t">esp_modem::Terminal::write (C++ function)</a>
 </li>
-      <li><a href="api_docs.html#_CPPv420esp_modem_dce_config">esp_modem_dce_config (C++ struct)</a>
+      <li><a href="api_docs.html#_CPPv412esp_modem_atPKcPc">esp_modem_at (C++ function)</a>
 </li>
-      <li><a href="api_docs.html#_CPPv4N20esp_modem_dce_config3apnE">esp_modem_dce_config::apn (C++ member)</a>
+      <li><a href="api_docs.html#_CPPv420esp_modem_dce_config">esp_modem_dce_config (C++ struct)</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api_docs.html#_CPPv4N20esp_modem_dce_config3apnE">esp_modem_dce_config::apn (C++ member)</a>
+</li>
      <li><a href="api_docs.html#_CPPv422esp_modem_dce_config_t">esp_modem_dce_config_t (C++ type)</a>
 </li>
      <li><a href="api_docs.html#c.ESP_MODEM_DCE_DEFAULT_CONFIG">ESP_MODEM_DCE_DEFAULT_CONFIG (C macro)</a>
--- a/esp_modem/internal_docs.html
+++ b/esp_modem/internal_docs.html
@@ -136,6 +136,23 @@
 </dl>
 </dd></dl>

+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem3DCE2atERKNSt6stringERNSt6stringE">
+<span id="_CPPv3N9esp_modem3DCE2atERKNSt6stringERNSt6stringE"></span><span id="_CPPv2N9esp_modem3DCE2atERKNSt6stringERNSt6stringE"></span><span id="esp_modem::DCE::at__ssCR.ssR"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a8c7344c25308bc93304e29dfe94e1665"></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">at</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">cmd</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE2atERKNSt6stringERNSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Execute the supplied AT command. </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>at</strong> – <strong>[in]</strong> AT command </p></li>
+<li><p><strong>out</strong> – <strong>[out]</strong> Command output string </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_modem3DCE8read_pinERb">
 <span id="_CPPv3N9esp_modem3DCE8read_pinERb"></span><span id="_CPPv2N9esp_modem3DCE8read_pinERb"></span><span id="esp_modem::DCE::read_pin__bR"></span><span class="target" id="classesp__modem_1_1_d_c_e_1a9055f8d714ba23adba7be5acf58f8136"></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">read_pin</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">pin_ok</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE8read_pinERb" title="Permalink to this definition">¶</a><br /></dt>
--- a/esp_modem/objects.inv
+++ b/esp_modem/objects.inv
--- a/esp_modem/searchindex.js
+++ b/esp_modem/searchindex.js
--- a/esp_websocket_client/.buildinfo
+++ b/esp_websocket_client/.buildinfo
@@ -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: 85990621f5567041925d6557322cedce
+config: f26fba1a8c8b369574f135d51faef863
 tags: 549b3d6d0415232fb7e35403b330ff49
--- a/esp_websocket_client/genindex.html
+++ b/esp_websocket_client/genindex.html
@@ -89,7 +89,7 @@
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>Index</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-docs/blob/51a50db/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/8dc3e58/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
--- a/esp_websocket_client/index.html
+++ b/esp_websocket_client/index.html
@@ -117,7 +117,7 @@
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>ESP WebSocket Client</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-docs/blob/51a50db/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/8dc3e58/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
@@ -234,7 +234,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 heading"></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/51a50db/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/8dc3e58/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 heading"></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>
@@ -248,7 +248,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 heading"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/51a50db/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/8dc3e58/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
--- a/mdns/en/.buildinfo
+++ b/mdns/en/.buildinfo
@@ -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: febef63245b1cca1699d6d543fa913a9
+config: fc66895c265678159ba07b0f4dab2f2b
 tags: 549b3d6d0415232fb7e35403b330ff49
--- a/mdns/en/genindex.html
+++ b/mdns/en/genindex.html
@@ -89,7 +89,7 @@
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>Index</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/51a50db/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/8dc3e58/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
--- a/mdns/en/index.html
+++ b/mdns/en/index.html
@@ -114,7 +114,7 @@
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>mDNS Service</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/51a50db/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/8dc3e58/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
@@ -317,14 +317,14 @@
 </section>
 <section id="application-example">
 <h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this heading"></a></h2>
-<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/51a50db/examples/../examples"></a>.</p>
+<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/8dc3e58/examples/../examples"></a>.</p>
 </section>
 <section id="api-reference">
 <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading"></a></h2>
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this heading"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/51a50db/include/mdns.h">include/mdns.h</a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/8dc3e58/include/mdns.h">include/mdns.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
--- a/mdns/zh_CN/.buildinfo
+++ b/mdns/zh_CN/.buildinfo
@@ -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: 443d212534a7ac6d9fdc4a2e0a8df084
+config: 2f9facfe0404619abf742c27949f8429
 tags: 549b3d6d0415232fb7e35403b330ff49
--- a/mdns/zh_CN/genindex.html
+++ b/mdns/zh_CN/genindex.html
@@ -90,7 +90,7 @@
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>索引</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/51a50db/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/8dc3e58/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
      </li>
  </ul>
  <hr/>
--- a/mdns/zh_CN/index.html
+++ b/mdns/zh_CN/index.html
@@ -112,7 +112,7 @@
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
      <li>mDNS 服务</li>
      <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/51a50db/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/8dc3e58/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
      </li>
  </ul>
  <hr/>
@@ -296,14 +296,14 @@
 </section>
 <section id="id7">
 <h2>应用示例<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h2>
-<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/51a50db/examples/../examples"></a>。</p>
+<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/8dc3e58/examples/../examples"></a>。</p>
 </section>
 <section id="api">
 <h2>API 参考<a class="headerlink" href="#api" title="Permalink to this heading"></a></h2>
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this heading"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/51a50db/include/mdns.h">include/mdns.h</a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/8dc3e58/include/mdns.h">include/mdns.h</a></p></li>
 </ul>
 </section>
 <section id="functions">