espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-17 20:42:21 +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

26
esp_modem/include/cxx_include/esp_modem_dce_module.hpp
View File

@ -24,10 +24,23 @@
namespace esp_modem {
/**
* @defgroup ESP_MODEM_MODULE
* @brief Definition of modules representing specific modem devices
*/
/** @addtogroup ESP_MODEM_MODULE
* @{
*/
enum class command_result;
class DTE;
struct PdpContext;
/**
* @brief This is a basic building block for custom modules as well as for the supported modules in the esp-modem component
* It derives from the ModuleIf.
*/
class GenericModule: public ModuleIf {
public:
explicit GenericModule(std::shared_ptr<DTE> dte, std::unique_ptr<PdpContext> pdp):
@ -72,24 +85,37 @@ protected:
};
// Definitions of other modules
/**
* @brief Specific definition of the SIM7600 module
*/
class SIM7600: public GenericModule {
using GenericModule::GenericModule;
public:
command_result get_module_name(std::string& name) override;
};
/**
* @brief Specific definition of the SIM800 module
*/
class SIM800: public GenericModule {
using GenericModule::GenericModule;
public:
command_result get_module_name(std::string& name) override;
};
/**
* @brief Specific definition of the BG96 module
*/
class BG96: public GenericModule {
using GenericModule::GenericModule;
public:
command_result get_module_name(std::string& name) override;
};
/**
* @}
*/
} // namespace esp_modem