2020-11-18 21:20:35 +01:00
|
|
|
# ESP MODEM
|
|
|
|
|
|
2021-05-26 16:41:19 +08:00
|
|
|
The `esp-modem` component is a managed component for `esp-idf` that is used for communication with GSM/LTE modems
|
2021-04-13 20:29:55 +02:00
|
|
|
that support AT commands and PPP protocol as a network interface.
|
2021-03-08 18:56:53 +01:00
|
|
|
|
2021-04-13 20:29:55 +02:00
|
|
|
## Examples
|
2020-11-18 21:20:35 +01:00
|
|
|
|
2021-04-13 20:29:55 +02:00
|
|
|
Get started with one of the examples:
|
|
|
|
|
* `examples/pppos_client` -- simple client implemented in C
|
|
|
|
|
* `examples/modem_console` -- C++ example implementing simple terminal console with DCE commands
|
2021-03-15 10:53:45 +01:00
|
|
|
* `examples/ap_to_pppos` -- this example focuses on the network connectivity of the esp-modem and provides a WiFi AP
|
|
|
|
|
that forwards packets (and uses NAT) to and from the PPPoS connection.
|
2021-05-18 19:10:32 +02:00
|
|
|
* `examples/simple_cmux_client` -- this example sets up the CMUX mode to talk to the modem using AT commands
|
|
|
|
|
with simultaneously maintaining active network connection.
|
2021-03-15 10:53:45 +01:00
|
|
|
|
2021-04-13 20:29:55 +02:00
|
|
|
## Documentation
|
2021-03-15 10:53:45 +01:00
|
|
|
|
2021-04-13 20:29:55 +02:00
|
|
|
* Continue with esp-modem [brief overview](docs/README.md)
|
|
|
|
|
* View the full [html documentation ](docs/html/index.html)
|
