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

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

Browse Source
This commit is contained in:
david-cermak
2022-07-11 17:04:29 +00:00
parent 7b46ee987b
commit cfef897a0d
29 changed files with 51 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esp_websocket_client/.buildinfo
+1 -1
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: e471086dc9c6f25014a54fd82f252a40
config: 047a7ec1c9799124f9efa65fd09cf593
tags: 549b3d6d0415232fb7e35403b330ff49
esp_websocket_client/_static/js/theme.js
+1 -1
View File
File diff suppressed because one or more lines are too long
esp_websocket_client/genindex.html
+2 -1
View File
@@ -27,6 +27,7 @@
<script type="text/javascript">
DOCUMENTATION_OPTIONS.PAGENAME = 'genindex';
DOCUMENTATION_OPTIONS.PROJECT_SLUG = 'esp-idf';
DOCUMENTATION_OPTIONS.LATEST_BRANCH_NAME = 'master';
DOCUMENTATION_OPTIONS.VERSIONS_URL = 'https://github.com/espressif/esp-protocols/docs/docs_versions.js';
DOCUMENTATION_OPTIONS.LANGUAGES = ["en"];
DOCUMENTATION_OPTIONS.IDF_TARGET = 'esp32';
@@ -89,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/ef1bae5/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/b4d85d6/docs/en/genindex" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
esp_websocket_client/index.html
+5 -4
View File
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ESP WebSocket Client - ESP32 - &mdash; ESP-Protocols latest documentation</title>
@@ -28,6 +28,7 @@
<script type="text/javascript">
DOCUMENTATION_OPTIONS.PAGENAME = 'index';
DOCUMENTATION_OPTIONS.PROJECT_SLUG = 'esp-idf';
DOCUMENTATION_OPTIONS.LATEST_BRANCH_NAME = 'master';
DOCUMENTATION_OPTIONS.VERSIONS_URL = 'https://github.com/espressif/esp-protocols/docs/docs_versions.js';
DOCUMENTATION_OPTIONS.LANGUAGES = ["en"];
DOCUMENTATION_OPTIONS.IDF_TARGET = 'esp32';
@@ -117,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/ef1bae5/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/espressif/esp-docs/blob/b4d85d6/docs/en/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -234,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/ef1bae5/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/b4d85d6/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>
@@ -248,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/ef1bae5/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/b4d85d6/include/esp_websocket_client.h">include/esp_websocket_client.h</a></p></li>
</ul>
</section>
<section id="functions">
esp_websocket_client/search.html
+1
View File
@@ -28,6 +28,7 @@
<script type="text/javascript">
DOCUMENTATION_OPTIONS.PAGENAME = 'search';
DOCUMENTATION_OPTIONS.PROJECT_SLUG = 'esp-idf';
DOCUMENTATION_OPTIONS.LATEST_BRANCH_NAME = 'master';
DOCUMENTATION_OPTIONS.VERSIONS_URL = 'https://github.com/espressif/esp-protocols/docs/docs_versions.js';
DOCUMENTATION_OPTIONS.LANGUAGES = ["en"];
DOCUMENTATION_OPTIONS.IDF_TARGET = 'esp32';