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@457f8335bb 🚀

Browse Source
This commit is contained in:
david-cermak
2022-11-23 19:26:10 +00:00
parent 196242dd0a
commit db5771d260
20 changed files with 115 additions and 28 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: b8f72f40903ff4c38ebe6ab9bb5c24a7
config: 94a9bb18a54672d7bc5fb80d0e934a29
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>Index</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/42565ff/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/457f833/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>

12
asio/index.html
View File

@@ -101,7 +101,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/42565ff/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/457f833/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -142,12 +142,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 headline"></a></h2>
<p>ESP examples are based on standard asio <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/42565ff/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/457f833/examples/../examples">examples </a>:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/42565ff/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/42565ff/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/42565ff/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/42565ff/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/457f833/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/457f833/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/457f833/examples/../examples/asio_chat">asio_chat </a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/tree/457f833/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.

35
esp_modem/api_docs.html
View File

@@ -114,6 +114,36 @@
<dd><p>Multiplexed terminal mode </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18esp_modem_dce_mode26ESP_MODEM_MODE_CMUX_MANUALE">
<span id="_CPPv3N18esp_modem_dce_mode26ESP_MODEM_MODE_CMUX_MANUALE"></span><span id="_CPPv2N18esp_modem_dce_mode26ESP_MODEM_MODE_CMUX_MANUALE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ggaf760e55ec8ab7da6d0bf0b10642510c5abac53938bc117e41944339c35bcfd1d0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_MODE_CMUX_MANUAL</span></span></span><a class="headerlink" href="#_CPPv4N18esp_modem_dce_mode26ESP_MODEM_MODE_CMUX_MANUALE" title="Permalink to this definition"></a><br /></dt>
<dd><p>CMUX manual mode </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_EXITE">
<span id="_CPPv3N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_EXITE"></span><span id="_CPPv2N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_EXITE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ggaf760e55ec8ab7da6d0bf0b10642510c5ab6f63a665be9709f3da9c0e70e43c786"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_MODE_CMUX_MANUAL_EXIT</span></span></span><a class="headerlink" href="#_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_EXITE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Exit CMUX manual mode </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_SWAPE">
<span id="_CPPv3N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_SWAPE"></span><span id="_CPPv2N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_SWAPE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ggaf760e55ec8ab7da6d0bf0b10642510c5abcc8d8f623eee7d7cf5d324995b30afb"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_MODE_CMUX_MANUAL_SWAP</span></span></span><a class="headerlink" href="#_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_SWAPE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Swap terminals in CMUX manual mode </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_DATAE">
<span id="_CPPv3N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_DATAE"></span><span id="_CPPv2N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_DATAE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ggaf760e55ec8ab7da6d0bf0b10642510c5a83db3330bdf02ea3f7627fadde956116"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_MODE_CMUX_MANUAL_DATA</span></span></span><a class="headerlink" href="#_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_DATAE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Set DATA mode in CMUX manual mode </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18esp_modem_dce_mode34ESP_MODEM_MODE_CMUX_MANUAL_COMMANDE">
<span id="_CPPv3N18esp_modem_dce_mode34ESP_MODEM_MODE_CMUX_MANUAL_COMMANDE"></span><span id="_CPPv2N18esp_modem_dce_mode34ESP_MODEM_MODE_CMUX_MANUAL_COMMANDE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ggaf760e55ec8ab7da6d0bf0b10642510c5af8276e34d99cf1722f9ca8f3f13449c3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ESP_MODEM_MODE_CMUX_MANUAL_COMMAND</span></span></span><a class="headerlink" href="#_CPPv4N18esp_modem_dce_mode34ESP_MODEM_MODE_CMUX_MANUAL_COMMANDE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Set COMMAND mode in CMUX manual mode </p>
</dd></dl>
</dd></dl>
<dl class="cpp enum">
@@ -271,6 +301,11 @@
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417esp_modem_commandP15esp_modem_dce_tPKcPF9esp_err_tP7uint8_t6size_tE8uint32_t">
<span id="_CPPv317esp_modem_commandP15esp_modem_dce_tPKcPF9esp_err_tP7uint8_t6size_tE8uint32_t"></span><span id="_CPPv217esp_modem_commandP15esp_modem_dce_tPKcPF9esp_err_tP7uint8_t6size_tE8uint32_t"></span><span class="target" id="group___e_s_p___m_o_d_e_m___c___a_p_i_1ga5b2b7380b339e888b5535adcc2b7f64e"></span><span class="n"><span class="pre">esp_err_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">esp_modem_command</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">esp_modem_dce_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dce</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">command</span></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="n sig-param"><span class="pre">got_line_cb</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">len</span></span><span class="p"><span class="pre">)</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">timeout_ms</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417esp_modem_commandP15esp_modem_dce_tPKcPF9esp_err_tP7uint8_t6size_tE8uint32_t" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>

30
esp_modem/genindex.html
View File

@@ -276,6 +276,8 @@
<li><a href="internal_docs.html#_CPPv4N9esp_modem8Terminal5writeEP7uint8_t6size_t">esp_modem::Terminal::write (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv412esp_modem_atPKcPci">esp_modem_at (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv417esp_modem_commandP15esp_modem_dce_tPKcPF9esp_err_tP7uint8_t6size_tE8uint32_t">esp_modem_command (C++ function)</a>
</li>
<li><a href="api_docs.html#_CPPv420esp_modem_dce_config">esp_modem_dce_config (C++ struct)</a>
</li>
@@ -287,12 +289,12 @@
</li>
<li><a href="api_docs.html#_CPPv420esp_modem_dce_device">esp_modem_dce_device (C++ enum)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api_docs.html#_CPPv4N20esp_modem_dce_device18ESP_MODEM_DCE_BG96E">esp_modem_dce_device::ESP_MODEM_DCE_BG96 (C++ enumerator)</a>
</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>
</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>
<li><a href="api_docs.html#_CPPv4N20esp_modem_dce_device21ESP_MODEM_DCE_SIM7070E">esp_modem_dce_device::ESP_MODEM_DCE_SIM7070 (C++ enumerator)</a>
@@ -306,6 +308,16 @@
<li><a href="api_docs.html#_CPPv418esp_modem_dce_mode">esp_modem_dce_mode (C++ enum)</a>
</li>
<li><a href="api_docs.html#_CPPv4N18esp_modem_dce_mode19ESP_MODEM_MODE_CMUXE">esp_modem_dce_mode::ESP_MODEM_MODE_CMUX (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N18esp_modem_dce_mode26ESP_MODEM_MODE_CMUX_MANUALE">esp_modem_dce_mode::ESP_MODEM_MODE_CMUX_MANUAL (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N18esp_modem_dce_mode34ESP_MODEM_MODE_CMUX_MANUAL_COMMANDE">esp_modem_dce_mode::ESP_MODEM_MODE_CMUX_MANUAL_COMMAND (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_DATAE">esp_modem_dce_mode::ESP_MODEM_MODE_CMUX_MANUAL_DATA (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_EXITE">esp_modem_dce_mode::ESP_MODEM_MODE_CMUX_MANUAL_EXIT (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N18esp_modem_dce_mode31ESP_MODEM_MODE_CMUX_MANUAL_SWAPE">esp_modem_dce_mode::ESP_MODEM_MODE_CMUX_MANUAL_SWAP (C++ enumerator)</a>
</li>
<li><a href="api_docs.html#_CPPv4N18esp_modem_dce_mode22ESP_MODEM_MODE_COMMANDE">esp_modem_dce_mode::ESP_MODEM_MODE_COMMAND (C++ enumerator)</a>
</li>
@@ -494,19 +506,29 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv410modem_mode">modem_mode (C++ enum)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode19CMUX_MANUAL_COMMANDE">modem_mode::CMUX_MANUAL_COMMAND (C++ enumerator)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode16CMUX_MANUAL_DATAE">modem_mode::CMUX_MANUAL_DATA (C++ enumerator)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode16CMUX_MANUAL_EXITE">modem_mode::CMUX_MANUAL_EXIT (C++ enumerator)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode16CMUX_MANUAL_MODEE">modem_mode::CMUX_MANUAL_MODE (C++ enumerator)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode16CMUX_MANUAL_SWAPE">modem_mode::CMUX_MANUAL_SWAP (C++ enumerator)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode9CMUX_MODEE">modem_mode::CMUX_MODE (C++ enumerator)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode12COMMAND_MODEE">modem_mode::COMMAND_MODE (C++ enumerator)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="internal_docs.html#_CPPv4N10modem_mode9DATA_MODEE">modem_mode::DATA_MODE (C++ enumerator)</a>
</li>
<li><a href="internal_docs.html#_CPPv4N10modem_mode5UNDEFE">modem_mode::UNDEF (C++ enumerator)</a>
</li>
<li><a href="advanced_api.html#_CPPv49ModemType">ModemType (C++ enum)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="advanced_api.html#_CPPv4N9ModemType4BG96E">ModemType::BG96 (C++ enumerator)</a>
</li>
<li><a href="advanced_api.html#_CPPv4N9ModemType13GenericModuleE">ModemType::GenericModule (C++ enumerator)</a>

30
esp_modem/internal_docs.html
View File

@@ -1231,6 +1231,36 @@ Please refer to the <a class="reference internal" href="api_docs.html#c-api"><sp
<dd><p>CMUX (Multiplex mode) &amp;#8212; Simplified CMUX mode, which creates two virtual terminals, assigning one solely to command interface and the other to the data mode </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode16CMUX_MANUAL_MODEE">
<span id="_CPPv3N10modem_mode16CMUX_MANUAL_MODEE"></span><span id="_CPPv2N10modem_mode16CMUX_MANUAL_MODEE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fab743b2073eeb0e4c9e74eee12a85a7be"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CMUX_MANUAL_MODE</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode16CMUX_MANUAL_MODEE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Enter CMUX mode manually &amp;#8212; just creates two virtual terminals </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode16CMUX_MANUAL_EXITE">
<span id="_CPPv3N10modem_mode16CMUX_MANUAL_EXITE"></span><span id="_CPPv2N10modem_mode16CMUX_MANUAL_EXITE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fa18020383cbb089af86fcd6c03022e07e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CMUX_MANUAL_EXIT</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode16CMUX_MANUAL_EXITE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Exits CMUX mode manually &amp;#8212; just destroys two virtual terminals </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode16CMUX_MANUAL_DATAE">
<span id="_CPPv3N10modem_mode16CMUX_MANUAL_DATAE"></span><span id="_CPPv2N10modem_mode16CMUX_MANUAL_DATAE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fa6760eba19cb853baf86e8c4891900057"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CMUX_MANUAL_DATA</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode16CMUX_MANUAL_DATAE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets the primary terminal to DATA mode in manual CMUX </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode19CMUX_MANUAL_COMMANDE">
<span id="_CPPv3N10modem_mode19CMUX_MANUAL_COMMANDE"></span><span id="_CPPv2N10modem_mode19CMUX_MANUAL_COMMANDE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fad33394d6e30a6088b08952f1f2042be8"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CMUX_MANUAL_COMMAND</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode19CMUX_MANUAL_COMMANDE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Sets the primary terminal to COMMAND mode in manual CMUX </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N10modem_mode16CMUX_MANUAL_SWAPE">
<span id="_CPPv3N10modem_mode16CMUX_MANUAL_SWAPE"></span><span id="_CPPv2N10modem_mode16CMUX_MANUAL_SWAPE"></span><span class="target" id="group___e_s_p___m_o_d_e_m___t_y_p_e_s_1gga80fa0ae4f6b04bc4e753bd207e0f298fa9041c46657e9f5e67f3111dcc2297c31"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CMUX_MANUAL_SWAP</span></span></span><a class="headerlink" href="#_CPPv4N10modem_mode16CMUX_MANUAL_SWAPE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Swaps virtual terminals in manual CMUX mode (primary &lt;-&gt; secondary) </p>
</dd></dl>
</dd></dl>
<dl class="cpp enum-class">

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: c16d9f87e40ac76b27d25955482f9fa9
config: 6711db4af34eb67ba9e42e381ae160a2
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>Index</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-docs/blob/42565ff/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/457f833/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>

6
esp_websocket_client/index.html
View File

@@ -117,7 +117,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/42565ff/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/457f833/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -234,7 +234,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/42565ff/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/457f833/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>
@@ -248,7 +248,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/42565ff/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/457f833/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: b8f72f40903ff4c38ebe6ab9bb5c24a7
config: 94a9bb18a54672d7bc5fb80d0e934a29
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>Index</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/42565ff/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/457f833/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>

6
mdns/en/index.html
View File

@@ -114,7 +114,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/42565ff/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-protocols/blob/457f833/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -317,14 +317,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/42565ff/examples/../examples"></a>.</p>
<p>mDNS server/scanner example: <a class="reference external" href="https://github.com/espressif/esp-protocols/tree/457f833/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/42565ff/include/mdns.h">include/mdns.h</a></p></li>
<li><p><a class="reference external" href="https://github.com/espressif/esp-protocols/blob/457f833/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: f8195a6c56a7c32b8107d3a5a81e2f57
config: 6b7f6744dab45b583679a0c768f740f8
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>索引</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/espressif/esp-protocols/blob/42565ff/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
<a href="https://github.com/espressif/esp-protocols/blob/457f833/docs/zh_CN/genindex" class="fa fa-github"> 在 GitHub 上修改</a>
</li>
</ul>
<hr/>

6
mdns/zh_CN/index.html
View File

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