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

API: Document create APIs for DTE and DCE

Browse Source
This commit is contained in:
David Cermak
2021-04-19 11:55:42 +02:00
parent 3a10330a9f
commit 314d3462bc
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
esp_modem/include/cxx_include/esp_modem_api.hpp
View File

@ -43,7 +43,9 @@ using dte_config = ::esp_modem_dte_config;
/**
* @brief Create UART DTE
* @param config DTE configuration
* @return shared ptr to DTE
* @return shared ptr to DTE on success
* nullptr on failure (either due to insufficient memory or wrong dte configuration)
* if exceptions are disabled the API abort()'s on error
*/
std::shared_ptr<DTE> create_uart_dte(const dte_config *config);
/**
@ -66,6 +68,7 @@ std::shared_ptr<DTE> create_uart_dte(const dte_config *config);
*
* @return unique ptr to the created DCE on success
* nullptr on failure
* if exceptions are disabled the API abort()'s on error
*/
std::unique_ptr<DCE> create_SIM7600_dce(const dce_config *config, std::shared_ptr<DTE> dte, esp_netif_t *netif);