espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-25 00:07:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentaton generation completed

Browse Source
This commit is contained in:
David Cermak
2021-04-14 17:57:42 +02:00
parent d384cde725
commit 4bf8ab07ca
27 changed files with 509 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
esp_modem/docs/api_docs.rst
View File

@ -18,6 +18,7 @@ Typical application workflow is to:
- Optionally switch back to command mode (again :cpp:func:`esp_modem_set_mode`)
- Destroy the DCE handle (sing :cpp:func:`esp_modem_destroy`)
Note the configuration structures for DTE and DCE, needed for creating the DCE instance, is documented in :ref:`api_config`
.. _lifecycle_api:
@ -26,6 +27,10 @@ Lifecycle API
These functions are used to create, destroy and set modem working mode.
- :cpp:func:`esp_modem_new`
- :cpp:func:`esp_modem_destroy`
- :cpp:func:`esp_modem_set_mode`
.. doxygengroup:: ESP_MODEM_C_API
@ -37,4 +42,13 @@ Modem commands
These functions are the actual commands to communicate with the modem using AT command interface.
.. doxygenfile:: c_api.h
.. doxygenfile:: esp_modem_api_commands.h
.. _api_config:
Configuration structures
------------------------
.. doxygengroup:: ESP_MODEM_CONFIG
:members: