[ESP8266] Added Doxygen comments
This commit is contained in:
parent
da9c41d89f
commit
0e1640b9fc
1 changed files with 35 additions and 4 deletions
|
@ -5,14 +5,45 @@
|
||||||
|
|
||||||
#include "../protocols/TransportLayer.h"
|
#include "../protocols/TransportLayer.h"
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\class ESP8266
|
||||||
|
|
||||||
|
\brief Control class for %ESP8266 module. Implements TransportLayer methods.
|
||||||
|
*/
|
||||||
class ESP8266: public TransportLayer {
|
class ESP8266: public TransportLayer {
|
||||||
public:
|
public:
|
||||||
// constructor
|
/*!
|
||||||
|
\brief Default constructor.
|
||||||
|
|
||||||
|
\param mod Instance of Module that will be used to communicate with the radio.
|
||||||
|
*/
|
||||||
ESP8266(Module* module);
|
ESP8266(Module* module);
|
||||||
|
|
||||||
// basic methods
|
// basic methods
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\brief Initialization method.
|
||||||
|
|
||||||
|
\param speed Baud rate to use for UART interface.
|
||||||
|
|
||||||
|
\returns \ref status_codes
|
||||||
|
*/
|
||||||
int16_t begin(long speed);
|
int16_t begin(long speed);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\brief Resets module using AT command.
|
||||||
|
|
||||||
|
\returns \ref status_codes
|
||||||
|
*/
|
||||||
int16_t reset();
|
int16_t reset();
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\brief Joins access point.
|
||||||
|
|
||||||
|
\param ssid Access point SSID.
|
||||||
|
|
||||||
|
\param password Access point password.
|
||||||
|
*/
|
||||||
int16_t join(const char* ssid, const char* password);
|
int16_t join(const char* ssid, const char* password);
|
||||||
|
|
||||||
// transport layer methods (implementations of purely virtual methods in TransportMethod class)
|
// transport layer methods (implementations of purely virtual methods in TransportMethod class)
|
||||||
|
|
Loading…
Add table
Reference in a new issue