Skip to content

Commit 6a74971

Browse files
authored
Merge pull request #395 from david-cermak/fix/modem_at_client_docs
fix(modem): Extend docs on AT client example
2 parents 11e58dc + 1f2ceed commit 6a74971

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

components/esp_modem/examples/modem_tcp_client/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ This example could be used in two different configurations:
99
1) Custom TCP transport: Implements a TCP transport in form of AT commands and uses it as custom transport for mqtt client.
1010
2) Localhost listener: Uses standard transports to connect and forwards socket layer data from the client to the modem using AT commands.
1111

12+
### Custom TCP transport
13+
14+
This configuration expects that the network library, that is used to communicate with the endpoint uses `tcp_transport` component. In this example, we use `esp-mqtt` which supports custom transports so that we can implement a transport layer that communicate on TCP layer using AT commands. If we want to use TLS, we could add an SSL layer on top of this TCP layer.
15+
16+
To enable this mode, please set `EXAMPLE_CUSTOM_TCP_TRANSPORT=y`
17+
18+
![with custom tcp transport](at_client_tcp_transport.png)
19+
20+
### Localhost listener
21+
22+
This configuration could be used with any network library, which is connecting to a localhost endpoint instead of remote one. This example creates a localhost listener which basically mimics the remote endpoint by forwarding the traffic between the library and the TCP/socket layer of the modem (which is already secure if the TLS is used in the network library)
23+
24+
![with localhost listener](at_client_localhost.png)
25+
1226
### Supported IDF versions
1327

1428
This example is supported from IDF `v5.0`.
137 KB
Loading
123 KB
Loading

0 commit comments

Comments
 (0)