espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-08-06 14:14:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
david-cermak
2023-03-15 17:56:48 +00:00
parent 6e0b5adbc2
commit 6e44b9ccc3
18 changed files with 33 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
asio/.buildinfo
View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 935e09e96f8a0b183c53fcbfa8a00ce7 config: a36f327be6899c390e13a892a741f038
tags: 549b3d6d0415232fb7e35403b330ff49 tags: 549b3d6d0415232fb7e35403b330ff49

2
asio/genindex.html
View File

@@ -89,7 +89,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Index</li> <li>Index</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/c492d87/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a> <a href="https://github.com/espressif/esp-protocols/blob/ba45e9a/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>

12
asio/index.html
View File

@@ -101,7 +101,7 @@
<li><a href="#" class="icon icon-home"></a> &raquo;</li> <li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>ASIO port</li> <li>ASIO port</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/c492d87/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a> <a href="https://github.com/espressif/esp-protocols/blob/ba45e9a/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
@@ -142,12 +142,12 @@ SSL/TLS support is disabled by default and could be enabled in component configu
</section> </section>
<section id="application-example"> <section id="application-example">
<h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2> <h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2>
<p>ESP examples are based on standard asio <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/c492d87/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/ba45e9a/examples/../examples">examples </a>:</p>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/c492d87/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/ba45e9a/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/c492d87/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/ba45e9a/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/c492d87/examples/../examples/asio_chat">asio_chat </a></p></li> <li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/ba45e9a/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/c492d87/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/ba45e9a/examples/../examples/ssl_client_server">ssl_client_server </a></p></li>
</ul> </ul>
<p>Please refer to the specific example README.md for details</p> <p>Please refer to the specific example README.md for details</p>
</section> </section>

BIN
esp_modem/.doctrees/api_docs.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/environment.pickle
View File

Binary file not shown.

5
esp_modem/api_docs.html
View File

@@ -826,6 +826,11 @@ pointer as the return value. The API expects the output data to point to user al
<dd><p>Configuration structures for DTE and DCE. </p> <dd><p>Configuration structures for DTE and DCE. </p>
<div class="breathe-sectiondef docutils container"> <div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p> <p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.ESP_MODEM_DEFAULT_UART_CLK">
<span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1ga1a0fc75a7cfc8fe2ed409c4ea1ad06bb"></span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_DEFAULT_UART_CLK</span></span></span><a class="headerlink" href="#c.ESP_MODEM_DEFAULT_UART_CLK" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro"> <dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.ESP_MODEM_DTE_DEFAULT_CONFIG"> <dt class="sig sig-object cpp" id="c.ESP_MODEM_DTE_DEFAULT_CONFIG">
<span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1gadda1b12d9db18d3030a694107a4d33e2"></span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_DTE_DEFAULT_CONFIG</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ESP_MODEM_DTE_DEFAULT_CONFIG" title="Permalink to this definition"></a><br /></dt> <span class="target" id="group___e_s_p___m_o_d_e_m___c_o_n_f_i_g_1gadda1b12d9db18d3030a694107a4d33e2"></span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_DTE_DEFAULT_CONFIG</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#c.ESP_MODEM_DTE_DEFAULT_CONFIG" title="Permalink to this definition"></a><br /></dt>

6
esp_modem/genindex.html
View File

@@ -293,10 +293,10 @@
</li> </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><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>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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><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>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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><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>
<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><a href="api_docs.html#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7600E">esp_modem_dce_device::ESP_MODEM_DCE_SIM7600 (C++ enumerator)</a>
@@ -326,6 +326,8 @@
<li><a href="api_docs.html#_CPPv420esp_modem_dce_mode_t">esp_modem_dce_mode_t (C++ type)</a> <li><a href="api_docs.html#_CPPv420esp_modem_dce_mode_t">esp_modem_dce_mode_t (C++ type)</a>
</li> </li>
<li><a href="internal_docs.html#c.ESP_MODEM_DECLARE_DCE_COMMAND">ESP_MODEM_DECLARE_DCE_COMMAND (C macro)</a> <li><a href="internal_docs.html#c.ESP_MODEM_DECLARE_DCE_COMMAND">ESP_MODEM_DECLARE_DCE_COMMAND (C macro)</a>
</li>
<li><a href="api_docs.html#c.ESP_MODEM_DEFAULT_UART_CLK">ESP_MODEM_DEFAULT_UART_CLK (C macro)</a>
</li> </li>
<li><a href="api_docs.html#_CPPv417esp_modem_destroyP15esp_modem_dce_t">esp_modem_destroy (C++ function)</a> <li><a href="api_docs.html#_CPPv417esp_modem_destroyP15esp_modem_dce_t">esp_modem_destroy (C++ function)</a>
</li> </li>

BIN
esp_modem/objects.inv
View File

Binary file not shown.

2
esp_modem/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
esp_websocket_client/.buildinfo
View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0f94c5829bfec2e5393e268579b06a42 config: ed0afb9bde4597b84dafce73f645cee0
tags: 549b3d6d0415232fb7e35403b330ff49 tags: 549b3d6d0415232fb7e35403b330ff49

2
esp_websocket_client/genindex.html
View File

@@ -89,7 +89,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Index</li> <li>Index</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-docs/blob/c492d87/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a> <a href="https://github.com/espressif/esp-docs/blob/ba45e9a/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>

6
esp_websocket_client/index.html
View File

@@ -117,7 +117,7 @@
<li><a href="#" class="icon icon-home"></a> &raquo;</li> <li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>ESP WebSocket Client</li> <li>ESP WebSocket Client</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-docs/blob/c492d87/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a> <a href="https://github.com/espressif/esp-docs/blob/ba45e9a/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
@@ -234,7 +234,7 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
</section> </section>
<section id="application-example"> <section id="application-example">
<h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2> <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/c492d87/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/ba45e9a/examples/../examples">example </a>.</p>
<section id="sending-text-data"> <section id="sending-text-data">
<h3>Sending Text Data<a class="headerlink" href="#sending-text-data" title="Permalink to this headline"></a></h3> <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> <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"> <section id="header-file">
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3> <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/c492d87/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/ba45e9a/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul> </ul>
</section> </section>
<section id="functions"> <section id="functions">

2
mdns/en/.buildinfo
View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 935e09e96f8a0b183c53fcbfa8a00ce7 config: a36f327be6899c390e13a892a741f038
tags: 549b3d6d0415232fb7e35403b330ff49 tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/en/genindex.html
View File

@@ -89,7 +89,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Index</li> <li>Index</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/c492d87/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a> <a href="https://github.com/espressif/esp-protocols/blob/ba45e9a/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>

6
mdns/en/index.html
View File

@@ -114,7 +114,7 @@
<li><a href="#" class="icon icon-home"></a> &raquo;</li> <li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>mDNS Service</li> <li>mDNS Service</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/c492d87/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a> <a href="https://github.com/espressif/esp-protocols/blob/ba45e9a/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
@@ -317,14 +317,14 @@
</section> </section>
<section id="application-example"> <section id="application-example">
<h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2> <h2>Application Example<a class="headerlink" href="#application-example" title="Permalink to this headline"></a></h2>
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/c492d87/examples/../examples"></a>.</p> <p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/ba45e9a/examples/../examples"></a>.</p>
</section> </section>
<section id="api-reference"> <section id="api-reference">
<h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h2> <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h2>
<section id="header-file"> <section id="header-file">
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3> <h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/c492d87/include/mdns.h">include/mdns.h</a></p></li> <li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/ba45e9a/include/mdns.h">include/mdns.h</a></p></li>
</ul> </ul>
</section> </section>
<section id="functions"> <section id="functions">

2
mdns/zh_CN/.buildinfo
View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0980d47aa53ae642a113e432c5d1c667 config: 35fe1c854184df7dba189df6e85a12b9
tags: 549b3d6d0415232fb7e35403b330ff49 tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/zh_CN/genindex.html
View File

@@ -90,7 +90,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>索引</li> <li>索引</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/c492d87/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a> <a href="https://github.com/espressif/esp-protocols/blob/ba45e9a/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>

6
mdns/zh_CN/index.html
View File

@@ -112,7 +112,7 @@
<li><a href="#" class="icon icon-home"></a> &raquo;</li> <li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>mDNS 服务</li> <li>mDNS 服务</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/c492d87/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a> <a href="https://github.com/espressif/esp-protocols/blob/ba45e9a/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
@@ -296,14 +296,14 @@
</section> </section>
<section id="id7"> <section id="id7">
<h2>应用示例<a class="headerlink" href="#id7" title="永久链接至标题"></a></h2> <h2>应用示例<a class="headerlink" href="#id7" title="永久链接至标题"></a></h2>
<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/c492d87/examples/../examples"></a>。</p> <p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/ba45e9a/examples/../examples"></a>。</p>
</section> </section>
<section id="api"> <section id="api">
<h2>API 参考<a class="headerlink" href="#api" title="永久链接至标题"></a></h2> <h2>API 参考<a class="headerlink" href="#api" title="永久链接至标题"></a></h2>
<section id="header-file"> <section id="header-file">
<h3>Header File<a class="headerlink" href="#header-file" title="永久链接至标题"></a></h3> <h3>Header File<a class="headerlink" href="#header-file" title="永久链接至标题"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/c492d87/include/mdns.h">include/mdns.h</a></p></li> <li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/ba45e9a/include/mdns.h">include/mdns.h</a></p></li>
</ul> </ul>
</section> </section>
<section id="functions"> <section id="functions">