readme

# ESP MODEM

The `esp-modem` component is a managed component for `esp-idf` that is used for communication with GSM/LTE modems
that support AT commands and PPP protocol as a network interface.

## Examples

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
* `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.
* `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.

## Documentation

* Continue with esp-modem [brief overview](docs/README.md)
* View the full [html documentation](https://espressif.github.io/esp-protocols/esp_modem/index.html)

Links

Supports all targets

License: Apache-2.0

To add this component to your project, run:

idf.py add-dependency "espressif/esp_modem^0.1.19"

or download archive

Dependencies

  • ESP-IDF >=4.1
  • Examples:

    ap_to_pppos

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp_modem^0.1.19:ap_to_pppos"

    or download archive

    linux_modem

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp_modem^0.1.19:linux_modem"

    or download archive

    modem_console

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp_modem^0.1.19:modem_console"

    or download archive

    pppos_client

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp_modem^0.1.19:pppos_client"

    or download archive

    simple_cmux_client

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp_modem^0.1.19:simple_cmux_client"

    or download archive

    Stats

    • Downloaded in total
      Downloaded in total 91.0k times
    • Downloaded this version
      This version: 559 times

    Badge

    espressif/esp_modem version: 0.1.19
    |