kopia lustrzana https://github.com/jgromes/RadioLib
[ESP8266] Added Doxygen comments
rodzic
da9c41d89f
commit
0e1640b9fc
|
@ -5,16 +5,47 @@
|
||||||
|
|
||||||
#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)
|
||||||
int16_t openTransportConnection(const char* host, const char* protocol, uint16_t port, uint16_t tcpKeepAlive = 0);
|
int16_t openTransportConnection(const char* host, const char* protocol, uint16_t port, uint16_t tcpKeepAlive = 0);
|
||||||
int16_t closeTransportConnection();
|
int16_t closeTransportConnection();
|
||||||
|
@ -22,7 +53,7 @@ class ESP8266: public TransportLayer {
|
||||||
int16_t send(uint8_t* data, uint32_t len);
|
int16_t send(uint8_t* data, uint32_t len);
|
||||||
size_t receive(uint8_t* data, size_t len, uint32_t timeout = 10000);
|
size_t receive(uint8_t* data, size_t len, uint32_t timeout = 10000);
|
||||||
size_t getNumBytes(uint32_t timeout = 10000, size_t minBytes = 10);
|
size_t getNumBytes(uint32_t timeout = 10000, size_t minBytes = 10);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
Module* _mod;
|
Module* _mod;
|
||||||
};
|
};
|
||||||
|
|
Ładowanie…
Reference in New Issue