Deploying to gh-pages from @ espressif/esp-protocols@5097065a22 🚀

asio/.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: a8f2e9c3b1ecba005871fa2214c93ab3
+config: bb133bb9610a60b4684691cb75c9f447
 tags: 549b3d6d0415232fb7e35403b330ff49

asio/genindex.html

@@ -91,7 +91,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/96fcbc0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/5097065/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>

asio/index.html

@@ -103,7 +103,7 @@
       <li><a href="#" class="icon icon-home"></a> &raquo;</li>
       <li>ASIO port</li>
       <li class="wy-breadcrumbs-aside">
-              <a href="https://github.com/espressif/esp-protocols/blob/96fcbc0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/5097065/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -144,12 +144,12 @@ SSL/TLS support is disabled by default and could be enabled in component configu
 </section>
 <section id="application-example">
 <h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this heading"></a></h2>
-<p>ESP examples are based on standard asio <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/96fcbc0/examples/../examples">examples </a>:</p>
+<p>ESP examples are based on standard asio <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/5097065/examples/../examples">examples </a>:</p>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/96fcbc0/examples/../examples/udp_echo_server">udp_echo_server </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/5097065/examples/../examples/udp_echo_server">udp_echo_server </a></p></li>
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/96fcbc0/examples/../examples/tcp_echo_server">tcp_echo_server </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/5097065/examples/../examples/tcp_echo_server">tcp_echo_server </a></p></li>
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/96fcbc0/examples/../examples/asio_chat">asio_chat </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/5097065/examples/../examples/asio_chat">asio_chat </a></p></li>
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/96fcbc0/examples/../examples/ssl_client_server">ssl_client_server </a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/5097065/examples/../examples/ssl_client_server">ssl_client_server </a></p></li>
 </ul>
 <p>Please refer to the specific example README.md for details</p>
 </section>
@@ -200,7 +200,7 @@ window.onload =(function() {
     mySpan.value = 'latest';
     mySpan.setAttribute('disabled', true);
     myAnchor.parentNode.replaceChild(mySpan, myAnchor);
- 
+
     var myAnchor = document.getElementById('target-select');
     var mySpan = document.createElement('input');
     mySpan.setAttribute('type', 'text');

esp_modem/README.html

@@ -45,7 +45,7 @@ The modem device is modeled with a DCE (Data Communication Equipment) object, wh
 <li><p>PPP Netif representing a network interface communicating with the DTE using PPP protocol.</p></li>
 <li><p>Module abstracting the specific device model and its commands.</p></li>
 </ul>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>   <span class="o">+-----+</span>   
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>   <span class="o">+-----+</span>
    <span class="o">|</span> <span class="n">DTE</span> <span class="o">|--+</span>
    <span class="o">+-----+</span>  <span class="o">|</span>   <span class="o">+-------+</span>
             <span class="o">+--&gt;|</span>   <span class="n">DCE</span> <span class="o">|</span>
@@ -53,10 +53,10 @@ The modem device is modeled with a DCE (Data Communication Equipment) object, wh
    <span class="o">|</span> <span class="n">Module</span><span class="o">|---&gt;|</span>       <span class="o">|</span>
    <span class="o">+-------+</span>    <span class="o">|</span>       <span class="o">|</span><span class="n">o</span><span class="o">---</span> <span class="n">send_commands</span>
              <span class="o">+-&gt;|</span>       <span class="o">|</span>
-   <span class="o">+------+</span>  <span class="o">|</span>  <span class="o">+-------+</span> 
+   <span class="o">+------+</span>  <span class="o">|</span>  <span class="o">+-------+</span>
-   <span class="o">|</span> <span class="n">PPP</span>  <span class="o">|--+</span> 
+   <span class="o">|</span> <span class="n">PPP</span>  <span class="o">|--+</span>
    <span class="o">|</span> <span class="n">netif</span><span class="o">|------------------&gt;</span> <span class="n">network</span> <span class="n">events</span>
-   <span class="o">+------+</span> 
+   <span class="o">+------+</span>
 </pre></div>
 </div>
 <section id="modem-components">

esp_modem/_sources/README.md.txt

@@ -1,14 +1,14 @@
 # ESP MODEM
 
 This component is used to communicate with modems in the command mode (using AT commands), as well as the data mode
-(over PPPoS protocol). 
+(over PPPoS protocol).
 The modem device is modeled with a DCE (Data Communication Equipment) object, which is composed of:
 * DTE (Data Terminal Equipment), which abstracts the terminal (currently only UART implemented).
 * PPP Netif representing a network interface communicating with the DTE using PPP protocol.
 * Module abstracting the specific device model and its commands.
 
 ```
-   +-----+   
+   +-----+
    | DTE |--+
    +-----+  |   +-------+
             +-->|   DCE |
@@ -16,17 +16,17 @@ The modem device is modeled with a DCE (Data Communication Equipment) object, wh
    | Module|--->|       |
    +-------+    |       |o--- send_commands
              +->|       |
-   +------+  |  +-------+ 
+   +------+  |  +-------+
-   | PPP  |--+ 
+   | PPP  |--+
    | netif|------------------> network events
-   +------+ 
+   +------+
 ```
 
 ## Modem components
 ### DCE
 
 This is the basic operational unit of the esp_modem component, abstracting a specific module in software,
-which is basically configured by 
+which is basically configured by
 * the I/O communication media (UART), defined by the DTE configuration
 * the specific command library supported by the device model, defined with the module type
 * network interface configuration (PPPoS config in lwip)
@@ -52,7 +52,7 @@ Users interact with the esp-modem using the DCE's interface, to basically
 * Switch between command and data mode to connect to the internet via cellular network.
 * Send various commands to the device (e.g. send SMS)
 
-The applications typically register handlers for network events to receive notification on the network availability and 
+The applications typically register handlers for network events to receive notification on the network availability and
 IP address changes.
 
 Common use cases of the esp-modem are also listed as the examples:

esp_modem/_sources/advanced_api.rst.txt

@@ -46,4 +46,3 @@ a custom DTE object and supply it into :ref:`the DCE factory<dce_factory>`. The
 - Create the DTE which uses the custom Terminal
 
 Please refer to the implementation of the existing UART DTE.
-

esp_modem/_sources/api_docs.rst.txt

@@ -6,7 +6,7 @@ C API Documentation
 
 The C API is very simple and consist of these two basic parts:
 
-- :ref:`lifecycle_api` 
+- :ref:`lifecycle_api`
 - :ref:`modem_commands`
 
 The Typical application workflow is to:
@@ -54,4 +54,4 @@ Configuration structures
 
 
 .. doxygengroup:: ESP_MODEM_CONFIG
-   :members:
+   :members:

esp_modem/_sources/cxx_api_docs.rst.txt

@@ -41,4 +41,4 @@ Destroy the DCE
 ---------------
 
 The DCE object is created as ``std::unique_ptr`` by default and as such doesn't have to be explicitly destroyed.
-It simply gets destroyed and cleaned-up automatically if the object goes out of the block scope.
+It simply gets destroyed and cleaned-up automatically if the object goes out of the block scope.

esp_modem/_sources/cxx_api_links.rst.txt

@@ -1,4 +1,4 @@
-
+    
 - :cpp:func:`esp_modem::DCE::sync` 
 - :cpp:func:`esp_modem::DCE::get_operator_name` 
 - :cpp:func:`esp_modem::DCE::store_profile` 

esp_modem/_sources/internal_design.md.txt

@@ -5,16 +5,16 @@
 * Use C++ with additional C API
 
 * Use exceptions
-  - Use macro wrapper over `try-catch` blocks when exceptions off (use `abort()` if `THROW()`) 
+  - Use macro wrapper over `try-catch` blocks when exceptions off (use `abort()` if `THROW()`)
 
 * Initializes and allocates in the constructor (might throw)
   - easier code with exceptions ON, with exceptions OFF alloc/init failures are not treated as runtime error (program aborts)
   - break down long initialization in constructor into more private methods
 
 * Implements different devices using inheritance from `GenericModule`, which is the most general implementation of a common modem
-  - Internally uses templates with device specialization (modeled as `DCE<SpecificModule>`) which could be used as well for some special cases, 
+  - Internally uses templates with device specialization (modeled as `DCE<SpecificModule>`) which could be used as well for some special cases,
   such as implantation of a minimal device (ModuleIf), add new AT commands (oOnly in compile time), or using the Module with DTE only (no DCE, no Netif) for sending AT commands without network
-  
+
 ## DCE collaboration model
 
 The diagram describes how the DCE class collaborates with DTE, PPP and the device abstraction

esp_modem/_sources/internal_docs.rst.txt

@@ -115,8 +115,3 @@ Modem types
 
 .. doxygengroup:: ESP_MODEM_TYPES
    :members:
-
-
-
-
-

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: 26b0445ee9d9773a608dbd46684f0909
+config: f4ea0f6bf15d14c3e98c54e6793146d7
 tags: 549b3d6d0415232fb7e35403b330ff49

esp_websocket_client/_sources/index.rst.txt

@@ -124,4 +124,3 @@ API Reference
 -------------
 
 .. include-build-file:: inc/esp_websocket_client.inc
-

esp_websocket_client/genindex.html

@@ -91,7 +91,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/96fcbc0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/5097065/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>

esp_websocket_client/index.html

@@ -119,7 +119,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/96fcbc0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-docs/blob/5097065/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -236,7 +236,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/96fcbc0/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/5097065/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>
@@ -250,7 +250,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/96fcbc0/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/5097065/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
@@ -913,7 +913,7 @@ window.onload =(function() {
     mySpan.value = 'latest';
     mySpan.setAttribute('disabled', true);
     myAnchor.parentNode.replaceChild(mySpan, myAnchor);
- 
+
     var myAnchor = document.getElementById('target-select');
     var mySpan = document.createElement('input');
     mySpan.setAttribute('type', 'text');

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: a8f2e9c3b1ecba005871fa2214c93ab3
+config: bb133bb9610a60b4684691cb75c9f447
 tags: 549b3d6d0415232fb7e35403b330ff49

mdns/en/_sources/index.rst.txt

@@ -201,5 +201,3 @@ API Reference
 -------------
 
 .. include-build-file:: inc/mdns.inc
-
-

mdns/en/genindex.html

@@ -91,7 +91,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/96fcbc0/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/5097065/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>

mdns/en/index.html

@@ -116,7 +116,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/96fcbc0/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/5097065/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
       </li>
   </ul>
   <hr/>
@@ -319,14 +319,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/96fcbc0/examples/../examples"></a>.</p>
+<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/5097065/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/96fcbc0/include/mdns.h">include/mdns.h</a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/5097065/include/mdns.h">include/mdns.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
@@ -1599,7 +1599,7 @@ window.onload =(function() {
     mySpan.value = 'latest';
     mySpan.setAttribute('disabled', true);
     myAnchor.parentNode.replaceChild(mySpan, myAnchor);
- 
+
     var myAnchor = document.getElementById('target-select');
     var mySpan = document.createElement('input');
     mySpan.setAttribute('type', 'text');

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: e170bb4c0a856a1a783969a171bb74a5
+config: c5253ec6e6816733d2058071ed71c2e8
 tags: 549b3d6d0415232fb7e35403b330ff49

mdns/zh_CN/_sources/index.rst.txt

@@ -185,5 +185,3 @@ API 参考
 --------
 
 .. include-build-file:: inc/mdns.inc
-
-

mdns/zh_CN/genindex.html

@@ -92,7 +92,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/96fcbc0/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/5097065/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
       </li>
   </ul>
   <hr/>

mdns/zh_CN/index.html

@@ -114,7 +114,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/96fcbc0/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
+              <a href="https://github.com/espressif/esp-protocols/blob/5097065/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
       </li>
   </ul>
   <hr/>
@@ -298,14 +298,14 @@
 </section>
 <section id="id7">
 <h2>应用示例<a class="headerlink" href="#id7" title="此标题的永久链接"></a></h2>
-<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/96fcbc0/examples/../examples"></a>。</p>
+<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/5097065/examples/../examples"></a>。</p>
 </section>
 <section id="api">
 <h2>API 参考<a class="headerlink" href="#api" title="此标题的永久链接"></a></h2>
 <section id="header-file">
 <h3>Header File<a class="headerlink" href="#header-file" title="此标题的永久链接"></a></h3>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/96fcbc0/include/mdns.h">include/mdns.h</a></p></li>
+<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/5097065/include/mdns.h">include/mdns.h</a></p></li>
 </ul>
 </section>
 <section id="functions">
@@ -1578,7 +1578,7 @@ window.onload =(function() {
     mySpan.value = 'latest';
     mySpan.setAttribute('disabled', true);
     myAnchor.parentNode.replaceChild(mySpan, myAnchor);
- 
+
     var myAnchor = document.getElementById('target-select');
     var mySpan = document.createElement('input');
     mySpan.setAttribute('type', 'text');