You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/esp_modem/en/README.rst
+56-4Lines changed: 56 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -84,16 +84,68 @@ Common use cases of the esp-modem are also listed as the examples:
84
84
connectivity of the esp-modem and provides a WiFi AP that forwards
85
85
packets (and uses NAT) to and from the PPPoS connection.
86
86
87
+
Working modes
88
+
~~~~~~~~~~~~~
89
+
90
+
Modem devices could work in multiple different modes, esp-modem library
91
+
uses these states to describe them:
92
+
- Standard modes:
93
+
- Command mode -- This mode is used for sending AT commands
94
+
- Data or PPP mode -- This mode is used for data communication (to create PPPoS tunnel between the device and the library)
95
+
- Multiplexing modes:
96
+
- CMUX mode -- This mode creates two virtual channels and uses one for sending AT commands and the other one for data communication.
97
+
- DUAL mode -- This mode uses two physical channels the same way as CMUX. This mode is supported only by certain devices, usually with USB interface.
98
+
- Manual CMUX modes -- These modes are designed for applications to have better control over CMUX mode transitions. It allows setting up the virtual channels,
99
+
switching between channels, transitioning between data and command modes for each channel separately, and exiting the CMUX.
100
+
101
+
Switching between common modes
102
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103
+
104
+
The diagram below depicts allowed transitions between the most common modes
105
+
106
+
::
107
+
108
+
+---------+ +---------+
109
+
| COMMAND |<-->| DATA |
110
+
+---------+ +---------+
111
+
^
112
+
|
113
+
v
114
+
+-------+
115
+
| CMUX |
116
+
+-------+
117
+
118
+
Note that it is possible to switch from any mode to the "UNDEF" mode and vice-versa.
119
+
120
+
Switching between manual modes
121
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122
+
123
+
The diagram below depicts allowed transitions between manual CMUX modes
Note that transitioning between "MANUAL_DATA" and "MANUAL_CMD" switches the secondary terminal (dedicated to PPP session) and could be used for recovering data communication if PPP session gets dropped.
139
+
87
140
Extensibility
88
141
-------------
89
142
90
143
CMUX
91
144
~~~~
92
145
93
-
Implementation of virtual terminals is an experimental feature, which
94
-
allows users to also issue commands in the data mode, after creating
95
-
multiple virtual terminals, designating some of them solely to data
96
-
mode, others solely to command mode.
146
+
Implements virtual terminals which allow users to also issue commands in the data mode;
147
+
after creating two virtual terminals, designating one of them solely to data mode, and
0 commit comments