feedc0de/esp-protocols
1
0
Fork 0
forked from espressif/esp-protocols
Code Pull Requests Activity

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

Browse Source
This commit is contained in:
david-cermak
2022-06-06 13:14:03 +00:00
parent 3cd41a8b15
commit 58d4f2945a
12 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
esp_modem/.doctrees/environment.pickle
View File

Binary file not shown.

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: 54c760e9311113b9e88febdce5957012
config: f990fe7ddce8ab53c2278d279397e987
tags: 549b3d6d0415232fb7e35403b330ff49

4
esp_websocket_client/genindex.html
View File

@@ -88,7 +88,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/1f91d24/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/6dbfc69/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -125,6 +125,8 @@
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t10client_keyE">esp_websocket_client_config_t::client_key (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t14client_key_lenE">esp_websocket_client_config_t::client_key_len (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t17crt_bundle_attachE">esp_websocket_client_config_t::crt_bundle_attach (C++ member)</a>
</li>
<li><a href="index.html#_CPPv4N29esp_websocket_client_config_t22disable_auto_reconnectE">esp_websocket_client_config_t::disable_auto_reconnect (C++ member)</a>
</li>

12
esp_websocket_client/index.html
View File

@@ -116,7 +116,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/1f91d24/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/6dbfc69/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -233,7 +233,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 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/1f91d24/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/6dbfc69/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 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>
@@ -247,7 +247,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 headline"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/1f91d24/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/6dbfc69/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul>
</section>
<section id="functions">
@@ -715,6 +715,12 @@ In case a host operating system has <cite>openssl</cite> and <cite>sed</cite> pa
<dd><p>Use a global ca_store for all the connections in which this bool is set. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N29esp_websocket_client_config_t17crt_bundle_attachE">
<span id="_CPPv3N29esp_websocket_client_config_t17crt_bundle_attachE"></span><span id="_CPPv2N29esp_websocket_client_config_t17crt_bundle_attachE"></span><span class="target" id="structesp__websocket__client__config__t_1a736d9d4d9acdf75aca18e377d0b988bc"></span><span class="n"><span class="pre">esp_err_t</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">crt_bundle_attach</span></span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">conf</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#_CPPv4N29esp_websocket_client_config_t17crt_bundle_attachE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Function pointer to esp_crt_bundle_attach. Enables the use of certification bundle for server verification, MBEDTLS_CERTIFICATE_BUNDLE must be enabled in menuconfig. Include esp_crt_bundle.h, and use <code class="docutils literal notranslate"><span class="pre">esp_crt_bundle_attach</span></code> here to include bundled CA certificates. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N29esp_websocket_client_config_t27skip_cert_common_name_checkE">
<span id="_CPPv3N29esp_websocket_client_config_t27skip_cert_common_name_checkE"></span><span id="_CPPv2N29esp_websocket_client_config_t27skip_cert_common_name_checkE"></span><span id="esp_websocket_client_config_t::skip_cert_common_name_check__b"></span><span class="target" id="structesp__websocket__client__config__t_1a659d5ff42a91bffb52c6930b98d98084"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">skip_cert_common_name_check</span></span></span><a class="headerlink" href="#_CPPv4N29esp_websocket_client_config_t27skip_cert_common_name_checkE" title="Permalink to this definition"></a><br /></dt>

BIN
esp_websocket_client/objects.inv
View File

Binary file not shown.

2
esp_websocket_client/searchindex.js
View File

File diff suppressed because one or more lines are too long

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: 26548f593fa82289136a9ce794562162
config: cc5ae01563c11bebbc4436c2e8e0f968
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/en/genindex.html
View File

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

6
mdns/en/index.html
View File

@@ -113,7 +113,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/1f91d24/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/6dbfc69/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -316,14 +316,14 @@
</section>
<section id="application-example">
<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/1f91d24/examples/../examples"></a>.</p>
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/6dbfc69/examples/../examples"></a>.</p>
</section>
<section id="api-reference">
<h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h2>
<section id="header-file">
<h3>Header File<a class="headerlink" href="#header-file" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/1f91d24/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/6dbfc69/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: f1a703fe03fa3b6dcfa750366341f581
config: c5ab24beecbd50b19e38b53eceb84dc0
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/zh_CN/genindex.html
View File

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

6
mdns/zh_CN/index.html
View File

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