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@7310a7a0bc 🚀

Browse Source
This commit is contained in:
david-cermak
2022-09-20 05:39:55 +00:00
parent 410b03bcff
commit 4b9ce98431
18 changed files with 26 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
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 79253de9b0531416d903739d4b7252df
config: bdb9c4058bb57ea76ea7b85c00a2c40f
tags: 549b3d6d0415232fb7e35403b330ff49

2
asio/genindex.html
View File

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

12
asio/index.html
View File

@@ -102,7 +102,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/b8d1e58/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/7310a7a/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -143,12 +143,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/b8d1e58/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/7310a7a/examples/../examples">examples </a>:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/b8d1e58/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/b8d1e58/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/b8d1e58/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/b8d1e58/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/7310a7a/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/7310a7a/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/7310a7a/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/7310a7a/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>

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.

BIN
esp_modem/.doctrees/internal_docs.doctree
View File

Binary file not shown.

2
esp_modem/api_docs.html
View File

@@ -367,7 +367,7 @@ pointer as the return value. The API expects the output data to point to user al
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv426esp_modem_resume_data_modev">
<span id="_CPPv326esp_modem_resume_data_modev"></span><span id="_CPPv226esp_modem_resume_data_modev"></span><span id="esp_modem_resume_data_mode"></span><span class="target" id="esp__modem__api__commands_8h_1a92e73f6ace9a8516701f85548f6f26be"></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_resume_data_mode</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426esp_modem_resume_data_modev" title="Permalink to this definition"></a><br /></dt>
<dd><p>Resumes data mode (Switches back to th data mode, which was temporarily suspended) </p>
<dd><p>Resumes data mode (Switches back to the data mode, which was temporarily suspended) </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>

2
esp_modem/internal_docs.html
View File

@@ -230,7 +230,7 @@
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem3DCE16resume_data_modeEv">
<span id="_CPPv3N9esp_modem3DCE16resume_data_modeEv"></span><span id="_CPPv2N9esp_modem3DCE16resume_data_modeEv"></span><span id="esp_modem::DCE::resume_data_mode"></span><span class="target" id="classesp__modem_1_1_d_c_e_1aa136b9f3d9ada787535f6df8ed81be0f"></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">resume_data_mode</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE16resume_data_modeEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Resumes data mode (Switches back to th data mode, which was temporarily suspended) </p>
<dd><p>Resumes data mode (Switches back to the data mode, which was temporarily suspended) </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>OK, FAIL or TIMEOUT </p>

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
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 5b46381e1a1ef183ac3269f7a4cee20c
config: 498cce684b6373a44bc74358e7d65b40
tags: 549b3d6d0415232fb7e35403b330ff49

2
esp_websocket_client/genindex.html
View File

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

6
esp_websocket_client/index.html
View File

@@ -118,7 +118,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/b8d1e58/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/7310a7a/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -235,7 +235,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/b8d1e58/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/7310a7a/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>
@@ -249,7 +249,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/b8d1e58/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/7310a7a/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul>
</section>
<section id="functions">

2
mdns/en/.buildinfo
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: 79253de9b0531416d903739d4b7252df
config: bdb9c4058bb57ea76ea7b85c00a2c40f
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/en/genindex.html
View File

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

6
mdns/en/index.html
View File

@@ -115,7 +115,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/b8d1e58/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/7310a7a/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -318,14 +318,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/b8d1e58/examples/../examples"></a>.</p>
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/7310a7a/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/b8d1e58/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/7310a7a/include/mdns.h">include/mdns.h</a></p></li>
</ul>
</section>
<section id="functions">

2
mdns/zh_CN/.buildinfo
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: dc1478ed2dd3686790a03f20922b28e1
config: aae3f67767183490dfce579bf34d72be
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/zh_CN/genindex.html
View File

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

6
mdns/zh_CN/index.html
View File

@@ -113,7 +113,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/b8d1e58/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
<a href="https://github.com/espressif/esp-protocols/blob/7310a7a/docs/zh_CN/index.rst" class="fa fa-github"> 在 GitHub 上修改</a>
</li>
</ul>
<hr/>
@@ -297,14 +297,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/b8d1e58/examples/../examples"></a>。</p>
<p>有关 mDNS 服务器和查询器的应用示例请参考 <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/7310a7a/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/b8d1e58/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/7310a7a/include/mdns.h">include/mdns.h</a></p></li>
</ul>
</section>
<section id="functions">