ESP examples are based on standard asio examples :
+ESP examples are based on standard asio examples :
Please refer to the specific example README.md for details
PPP Netif representing a network interface communicating with the DTE using PPP protocol.
Module abstracting the specific device model and its commands.
+-----+
+ +-----+
| DTE |--+
+-----+ | +-------+
+-->| DCE |
@@ -53,10 +53,10 @@ The modem device is modeled with a DCE (Data Communication Equipment) object, wh
| Module|--->| |
+-------+ | |o--- send_commands
+->| |
- +------+ | +-------+
- | PPP |--+
+ +------+ | +-------+
+ | PPP |--+
| netif|------------------> network events
- +------+
+ +------+
diff --git a/esp_modem/_sources/README.md.txt b/esp_modem/_sources/README.md.txt
index dc1e0639c..6e50d9bcd 100644
--- a/esp_modem/_sources/README.md.txt
+++ b/esp_modem/_sources/README.md.txt
@@ -1,14 +1,14 @@
# ESP MODEM
This component is used to communicate with modems in the command mode (using AT commands), as well as the data mode
-(over PPPoS protocol).
+(over PPPoS protocol).
The modem device is modeled with a DCE (Data Communication Equipment) object, which is composed of:
* DTE (Data Terminal Equipment), which abstracts the terminal (currently only UART implemented).
* PPP Netif representing a network interface communicating with the DTE using PPP protocol.
* Module abstracting the specific device model and its commands.
```
- +-----+
+ +-----+
| DTE |--+
+-----+ | +-------+
+-->| DCE |
@@ -16,17 +16,17 @@ The modem device is modeled with a DCE (Data Communication Equipment) object, wh
| Module|--->| |
+-------+ | |o--- send_commands
+->| |
- +------+ | +-------+
- | PPP |--+
+ +------+ | +-------+
+ | PPP |--+
| netif|------------------> network events
- +------+
+ +------+
```
## Modem components
### DCE
This is the basic operational unit of the esp_modem component, abstracting a specific module in software,
-which is basically configured by
+which is basically configured by
* the I/O communication media (UART), defined by the DTE configuration
* the specific command library supported by the device model, defined with the module type
* network interface configuration (PPPoS config in lwip)
@@ -52,7 +52,7 @@ Users interact with the esp-modem using the DCE's interface, to basically
* Switch between command and data mode to connect to the internet via cellular network.
* Send various commands to the device (e.g. send SMS)
-The applications typically register handlers for network events to receive notification on the network availability and
+The applications typically register handlers for network events to receive notification on the network availability and
IP address changes.
Common use cases of the esp-modem are also listed as the examples:
diff --git a/esp_modem/_sources/advanced_api.rst.txt b/esp_modem/_sources/advanced_api.rst.txt
index 8fc939b15..a487398b3 100644
--- a/esp_modem/_sources/advanced_api.rst.txt
+++ b/esp_modem/_sources/advanced_api.rst.txt
@@ -46,4 +46,3 @@ a custom DTE object and supply it into :ref:`the DCE factory`. The
- Create the DTE which uses the custom Terminal
Please refer to the implementation of the existing UART DTE.
-
diff --git a/esp_modem/_sources/api_docs.rst.txt b/esp_modem/_sources/api_docs.rst.txt
index 6727de13e..4ace0e1ac 100644
--- a/esp_modem/_sources/api_docs.rst.txt
+++ b/esp_modem/_sources/api_docs.rst.txt
@@ -6,7 +6,7 @@ C API Documentation
The C API is very simple and consist of these two basic parts:
-- :ref:`lifecycle_api`
+- :ref:`lifecycle_api`
- :ref:`modem_commands`
The Typical application workflow is to:
@@ -54,4 +54,4 @@ Configuration structures
.. doxygengroup:: ESP_MODEM_CONFIG
- :members:
\ No newline at end of file
+ :members:
diff --git a/esp_modem/_sources/cxx_api_docs.rst.txt b/esp_modem/_sources/cxx_api_docs.rst.txt
index 5544c368a..94fdb94e1 100644
--- a/esp_modem/_sources/cxx_api_docs.rst.txt
+++ b/esp_modem/_sources/cxx_api_docs.rst.txt
@@ -41,4 +41,4 @@ Destroy the DCE
---------------
The DCE object is created as ``std::unique_ptr`` by default and as such doesn't have to be explicitly destroyed.
-It simply gets destroyed and cleaned-up automatically if the object goes out of the block scope.
\ No newline at end of file
+It simply gets destroyed and cleaned-up automatically if the object goes out of the block scope.
diff --git a/esp_modem/_sources/cxx_api_links.rst.txt b/esp_modem/_sources/cxx_api_links.rst.txt
index 5fbdecb9c..86da3d8d5 100644
--- a/esp_modem/_sources/cxx_api_links.rst.txt
+++ b/esp_modem/_sources/cxx_api_links.rst.txt
@@ -1,4 +1,4 @@
-
+
- :cpp:func:`esp_modem::DCE::sync`
- :cpp:func:`esp_modem::DCE::get_operator_name`
- :cpp:func:`esp_modem::DCE::store_profile`
diff --git a/esp_modem/_sources/internal_design.md.txt b/esp_modem/_sources/internal_design.md.txt
index 379855de6..c132bede0 100644
--- a/esp_modem/_sources/internal_design.md.txt
+++ b/esp_modem/_sources/internal_design.md.txt
@@ -5,16 +5,16 @@
* Use C++ with additional C API
* Use exceptions
- - Use macro wrapper over `try-catch` blocks when exceptions off (use `abort()` if `THROW()`)
+ - Use macro wrapper over `try-catch` blocks when exceptions off (use `abort()` if `THROW()`)
* Initializes and allocates in the constructor (might throw)
- easier code with exceptions ON, with exceptions OFF alloc/init failures are not treated as runtime error (program aborts)
- break down long initialization in constructor into more private methods
* Implements different devices using inheritance from `GenericModule`, which is the most general implementation of a common modem
- - Internally uses templates with device specialization (modeled as `DCE`) which could be used as well for some special cases,
+ - Internally uses templates with device specialization (modeled as `DCE`) which could be used as well for some special cases,
such as implantation of a minimal device (ModuleIf), add new AT commands (oOnly in compile time), or using the Module with DTE only (no DCE, no Netif) for sending AT commands without network
-
+
## DCE collaboration model
The diagram describes how the DCE class collaborates with DTE, PPP and the device abstraction
diff --git a/esp_modem/_sources/internal_docs.rst.txt b/esp_modem/_sources/internal_docs.rst.txt
index 1416edcc3..bd2d269de 100644
--- a/esp_modem/_sources/internal_docs.rst.txt
+++ b/esp_modem/_sources/internal_docs.rst.txt
@@ -115,8 +115,3 @@ Modem types
.. doxygengroup:: ESP_MODEM_TYPES
:members:
-
-
-
-
-
diff --git a/esp_websocket_client/.buildinfo b/esp_websocket_client/.buildinfo
index 105646f74..2f7496363 100644
--- a/esp_websocket_client/.buildinfo
+++ b/esp_websocket_client/.buildinfo
@@ -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: 26b0445ee9d9773a608dbd46684f0909
+config: f4ea0f6bf15d14c3e98c54e6793146d7
tags: 549b3d6d0415232fb7e35403b330ff49
diff --git a/esp_websocket_client/_sources/index.rst.txt b/esp_websocket_client/_sources/index.rst.txt
index 7c3abd970..2469e1473 100644
--- a/esp_websocket_client/_sources/index.rst.txt
+++ b/esp_websocket_client/_sources/index.rst.txt
@@ -124,4 +124,3 @@ API Reference
-------------
.. include-build-file:: inc/esp_websocket_client.inc
-
diff --git a/esp_websocket_client/genindex.html b/esp_websocket_client/genindex.html
index ceaf1b909..c0cef1baf 100644
--- a/esp_websocket_client/genindex.html
+++ b/esp_websocket_client/genindex.html
@@ -91,7 +91,7 @@
»
Index
- Edit on GitHub
+ Edit on GitHub
diff --git a/esp_websocket_client/index.html b/esp_websocket_client/index.html
index 60e8ccc0d..f3133b414 100644
--- a/esp_websocket_client/index.html
+++ b/esp_websocket_client/index.html
@@ -119,7 +119,7 @@
»
ESP WebSocket Client
- Edit on GitHub
+ Edit on GitHub
@@ -236,7 +236,7 @@ In case a host operating system has openssl and sed pa
Application Example
-A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the websocket.org server can be found here: example .
+A simple WebSocket example that uses esp_websocket_client to establish a websocket connection and send/receive data with the websocket.org server can be found here: example .
Sending Text Data
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:
@@ -250,7 +250,7 @@ In case a host operating system has openssl and sed pa
Header File
@@ -913,7 +913,7 @@ window.onload =(function() {
mySpan.value = 'latest';
mySpan.setAttribute('disabled', true);
myAnchor.parentNode.replaceChild(mySpan, myAnchor);
-
+
var myAnchor = document.getElementById('target-select');
var mySpan = document.createElement('input');
mySpan.setAttribute('type', 'text');
diff --git a/mdns/en/.buildinfo b/mdns/en/.buildinfo
index 53a93cf72..95d270234 100644
--- a/mdns/en/.buildinfo
+++ b/mdns/en/.buildinfo
@@ -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: a8f2e9c3b1ecba005871fa2214c93ab3
+config: bb133bb9610a60b4684691cb75c9f447
tags: 549b3d6d0415232fb7e35403b330ff49
diff --git a/mdns/en/_sources/index.rst.txt b/mdns/en/_sources/index.rst.txt
index 007d1bd9d..b9b3a549c 100644
--- a/mdns/en/_sources/index.rst.txt
+++ b/mdns/en/_sources/index.rst.txt
@@ -201,5 +201,3 @@ API Reference
-------------
.. include-build-file:: inc/mdns.inc
-
-
diff --git a/mdns/en/genindex.html b/mdns/en/genindex.html
index 9b327e468..71d515295 100644
--- a/mdns/en/genindex.html
+++ b/mdns/en/genindex.html
@@ -91,7 +91,7 @@
»
Index
- Edit on GitHub
+ Edit on GitHub
diff --git a/mdns/en/index.html b/mdns/en/index.html
index a8a0b2e11..0607ab1c2 100644
--- a/mdns/en/index.html
+++ b/mdns/en/index.html
@@ -116,7 +116,7 @@
»
mDNS Service
- Edit on GitHub
+ Edit on GitHub
@@ -319,14 +319,14 @@
Application Example
-
+
API Reference
Header File
@@ -1599,7 +1599,7 @@ window.onload =(function() {
mySpan.value = 'latest';
mySpan.setAttribute('disabled', true);
myAnchor.parentNode.replaceChild(mySpan, myAnchor);
-
+
var myAnchor = document.getElementById('target-select');
var mySpan = document.createElement('input');
mySpan.setAttribute('type', 'text');
diff --git a/mdns/zh_CN/.buildinfo b/mdns/zh_CN/.buildinfo
index f142a0b0c..2cbbdfdfb 100644
--- a/mdns/zh_CN/.buildinfo
+++ b/mdns/zh_CN/.buildinfo
@@ -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: e170bb4c0a856a1a783969a171bb74a5
+config: c5253ec6e6816733d2058071ed71c2e8
tags: 549b3d6d0415232fb7e35403b330ff49
diff --git a/mdns/zh_CN/_sources/index.rst.txt b/mdns/zh_CN/_sources/index.rst.txt
index 68befb637..8b8cc9ac7 100644
--- a/mdns/zh_CN/_sources/index.rst.txt
+++ b/mdns/zh_CN/_sources/index.rst.txt
@@ -185,5 +185,3 @@ API 参考
--------
.. include-build-file:: inc/mdns.inc
-
-
diff --git a/mdns/zh_CN/genindex.html b/mdns/zh_CN/genindex.html
index 6a53d62b8..99f417b66 100644
--- a/mdns/zh_CN/genindex.html
+++ b/mdns/zh_CN/genindex.html
@@ -92,7 +92,7 @@
»
索引
- 在 GitHub 上修改
+ 在 GitHub 上修改
diff --git a/mdns/zh_CN/index.html b/mdns/zh_CN/index.html
index a0236833c..eb1b235a9 100644
--- a/mdns/zh_CN/index.html
+++ b/mdns/zh_CN/index.html
@@ -114,7 +114,7 @@
»
mDNS 服务
- 在 GitHub 上修改
+ 在 GitHub 上修改
@@ -298,14 +298,14 @@
应用示例
-
+
API 参考
Header File
@@ -1578,7 +1578,7 @@ window.onload =(function() {
mySpan.value = 'latest';
mySpan.setAttribute('disabled', true);
myAnchor.parentNode.replaceChild(mySpan, myAnchor);
-
+
var myAnchor = document.getElementById('target-select');
var mySpan = document.createElement('input');
mySpan.setAttribute('type', 'text');