diff --git a/components/esp_modem/examples/modem_tcp_client/README.md b/components/esp_modem/examples/modem_tcp_client/README.md index 22e555ea30..1d91892155 100644 --- a/components/esp_modem/examples/modem_tcp_client/README.md +++ b/components/esp_modem/examples/modem_tcp_client/README.md @@ -9,6 +9,20 @@ This example could be used in two different configurations: 1) Custom TCP transport: Implements a TCP transport in form of AT commands and uses it as custom transport for mqtt client. 2) Localhost listener: Uses standard transports to connect and forwards socket layer data from the client to the modem using AT commands. +### Custom TCP transport + +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. + +To enable this mode, please set `EXAMPLE_CUSTOM_TCP_TRANSPORT=y` + +![with custom tcp transport](at_client_tcp_transport.png) + +### Localhost listener + +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) + +![with localhost listener](at_client_localhost.png) + ### Supported IDF versions This example is supported from IDF `v5.0`. diff --git a/components/esp_modem/examples/modem_tcp_client/at_client_localhost.png b/components/esp_modem/examples/modem_tcp_client/at_client_localhost.png new file mode 100644 index 0000000000..7f035d6244 Binary files /dev/null and b/components/esp_modem/examples/modem_tcp_client/at_client_localhost.png differ diff --git a/components/esp_modem/examples/modem_tcp_client/at_client_tcp_transport.png b/components/esp_modem/examples/modem_tcp_client/at_client_tcp_transport.png new file mode 100644 index 0000000000..4678644012 Binary files /dev/null and b/components/esp_modem/examples/modem_tcp_client/at_client_tcp_transport.png differ