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@fe536e476c 🚀

Browse Source
This commit is contained in:
david-cermak
2022-10-05 06:57:14 +00:00
parent 3183b41eef
commit 8e5b2b1deb
25 changed files with 60 additions and 25 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: 848766879bd28b29aac9b358128377c2
config: d5604b1d1de10173e91148cffb78c259
tags: 549b3d6d0415232fb7e35403b330ff49

2
asio/genindex.html
View File

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

12
asio/index.html
View File

@@ -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/afafcb7/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/fe536e4/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/afafcb7/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/fe536e4/examples/../examples">examples </a>:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/afafcb7/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/afafcb7/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/afafcb7/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/afafcb7/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/fe536e4/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/fe536e4/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/fe536e4/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/fe536e4/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/cxx_api_docs.doctree
View File

Binary file not shown.

BIN
esp_modem/.doctrees/cxx_api_links.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.

3
esp_modem/_sources/cxx_api_links.rst.txt
View File

@@ -33,4 +33,5 @@
- :cpp:func:`esp_modem::DCE::set_preferred_mode`
- :cpp:func:`esp_modem::DCE::set_network_bands`
- :cpp:func:`esp_modem::DCE::get_network_system_mode`
- :cpp:func:`esp_modem::DCE::set_gnss_power_mode`
- :cpp:func:`esp_modem::DCE::set_gnss_power_mode`
- :cpp:func:`esp_modem::DCE::get_gnss_power_mode`

14
esp_modem/api_docs.html
View File

@@ -769,6 +769,20 @@ 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="_CPPv429esp_modem_get_gnss_power_modePi">
<span id="_CPPv329esp_modem_get_gnss_power_modePi"></span><span id="_CPPv229esp_modem_get_gnss_power_modePi"></span><span id="esp_modem_get_gnss_power_mode__iP"></span><span class="target" id="esp__modem__api__commands_8h_1a012e51ed707a82e4e0cd0d1bd0b7b9ae"></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_get_gnss_power_mode</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv429esp_modem_get_gnss_power_modePi" title="Permalink to this definition"></a><br /></dt>
<dd><p>GNSS power control. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[out]</strong> power mode (0 - off, 1 - on) </p>
</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>
</div>
</section>
<section id="configuration-structures">

1
esp_modem/cxx_api_docs.html
View File

@@ -212,6 +212,7 @@
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii" title="esp_modem::DCE::set_network_bands"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_bands()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE23get_network_system_modeERi" title="esp_modem::DCE::get_network_system_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_network_system_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE19set_gnss_power_modeEi" title="esp_modem::DCE::set_gnss_power_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_gnss_power_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE19get_gnss_power_modeERi" title="esp_modem::DCE::get_gnss_power_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_gnss_power_mode()</span></code></a></p></li>
</ul>
</section>
<section id="destroy-the-dce">

1
esp_modem/cxx_api_links.html
View File

@@ -69,6 +69,7 @@
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE17set_network_bandsERKNSt6stringEPKii" title="esp_modem::DCE::set_network_bands"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_network_bands()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE23get_network_system_modeERi" title="esp_modem::DCE::get_network_system_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_network_system_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE19set_gnss_power_modeEi" title="esp_modem::DCE::set_gnss_power_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::set_gnss_power_mode()</span></code></a></p></li>
<li><p><a class="reference internal" href="internal_docs.html#_CPPv4N9esp_modem3DCE19get_gnss_power_modeERi" title="esp_modem::DCE::get_gnss_power_mode"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">esp_modem::DCE::get_gnss_power_mode()</span></code></a></p></li>
</ul>

4
esp_modem/genindex.html
View File

@@ -134,6 +134,8 @@
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE2atERKNSt6stringERNSt6stringEi">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>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE19get_gnss_power_modeERi">esp_modem::DCE::get_gnss_power_mode (C++ function)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N9esp_modem3DCE8get_imeiERNSt6stringE">esp_modem::DCE::get_imei (C++ function)</a>
</li>
@@ -344,6 +346,8 @@
<li><a href="api_docs.html#_CPPv4N21esp_modem_flow_ctrl_t25ESP_MODEM_FLOW_CONTROL_SWE">esp_modem_flow_ctrl_t::ESP_MODEM_FLOW_CONTROL_SW (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv428esp_modem_get_battery_statusPiPiPi">esp_modem_get_battery_status (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv429esp_modem_get_gnss_power_modePi">esp_modem_get_gnss_power_mode (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv418esp_modem_get_imeiPc">esp_modem_get_imei (C++ function)</a>
</li>

14
esp_modem/internal_docs.html
View File

@@ -571,6 +571,20 @@
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N9esp_modem3DCE19get_gnss_power_modeERi">
<span id="_CPPv3N9esp_modem3DCE19get_gnss_power_modeERi"></span><span id="_CPPv2N9esp_modem3DCE19get_gnss_power_modeERi"></span><span id="esp_modem::DCE::get_gnss_power_mode__iR"></span><span class="target" id="classesp__modem_1_1_d_c_e_1afe14e227b79d08779e852857183739a0"></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">get_gnss_power_mode</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N9esp_modem3DCE19get_gnss_power_modeERi" title="Permalink to this definition"></a><br /></dt>
<dd><p>GNSS power control. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mode</strong> – <strong>[out]</strong> power mode (0 - off, 1 - on) </p>
</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>
</div>
</dd></dl>

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

2
esp_websocket_client/genindex.html
View File

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

6
esp_websocket_client/index.html
View File

@@ -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/afafcb7/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/fe536e4/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/afafcb7/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/fe536e4/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/afafcb7/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/fe536e4/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: 848766879bd28b29aac9b358128377c2
config: d5604b1d1de10173e91148cffb78c259
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/en/genindex.html
View File

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

6
mdns/en/index.html
View File

@@ -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/afafcb7/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/fe536e4/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/afafcb7/examples/../examples"></a>.</p>
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/fe536e4/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/afafcb7/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/fe536e4/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: c40870ee222b1921e5219abe81c0909c
config: 00f01ccb67abf0ca406aa1c7c220ab1f
tags: 549b3d6d0415232fb7e35403b330ff49

2
mdns/zh_CN/genindex.html
View File

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

6
mdns/zh_CN/index.html
View File

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