ESP8266 / ESP8266NodeMCUInterface

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   BufferedSerial

Dependents:   esp8266_nodeMCU1 esp8266_2_thingspeak1 Solarator_0-0-2 IoTBurglar_and_Fire_AlarmSystem ... more

Fork of ESP8266Interface by ESP8266

Embed: (wiki syntax)

« Back to documentation index

ESP8266Interface Class Reference
Public Member Functions | Static Public Member Functions

ESP8266Interface Class Reference

Interface using ESP8266 to connect to an IP-based network. More...

#include <ESP8266Interface.h>

Inherits ESP8266.

Public Member Functions

 ESP8266Interface (PinName tx, PinName rx, PinName reset, int baud=9600, int timeout=3000)
 Constructor.
bool init ()
 Initialize the wifi hardware.
bool connect (const char *ssid, const char *phrase)
 Connect the wifi module to the specified ssid.
int disconnect ()
 Disconnect the ESP8266 module from the access point.
const char * getIPAddress ()
 Get IP address.
bool is_connected ()
 Check connection to the access point.
bool close ()
 Close a connection.
int getc ()
 Read a character or block.
int putc (char c)
 Write a character.
bool send (const char *buffer, int len)
 Write a string.
bool recv (char *buffer, int *len)
 Read a string without blocking.
int writeable ()
 Check if wifi is writable.
int readable ()
 Check if wifi is readable.
bool getHostByName (const char *host, char *ip)
 Return the IP address from host name.
bool reset ()
 Reset the wifi module.

Static Public Member Functions

static ESP8266 * getInstance ()
 Obtains the current instance of the ESP8266.

Detailed Description

Interface using ESP8266 to connect to an IP-based network.

Definition at line 29 of file ESP8266Interface.h.

Constructor & Destructor Documentation

ESP8266Interface ( PinName  tx,
PinName  rx,
PinName  reset,
int  baud = 9600,
int  timeout = 3000 
)

Constructor.

Parameters:
txmbed pin to use for tx line of Serial interface
rxmbed pin to use for rx line of Serial interface
resetreset pin of the wifi module ()
baudthe baudrate of the serial connection
timeoutthe timeout of the serial connection

Definition at line 3 of file ESP8266Interface.cpp.

Member Function Documentation

bool close (  ) [inherited]

Close a connection.

Returns:
true if successful

Definition at line 187 of file ESP8266.cpp.

bool connect ( const char *  ssid,
const char *  phrase 
)

Connect the wifi module to the specified ssid.

Parameters:
ssidssid of the network
phraseWEP, WPA or WPA2 key
Returns:
true if successful

Reimplemented from ESP8266.

Definition at line 12 of file ESP8266Interface.cpp.

int disconnect (  )

Disconnect the ESP8266 module from the access point.

Returns:
true if successful

Reimplemented from ESP8266.

Definition at line 16 of file ESP8266Interface.cpp.

int getc (  ) [inherited]

Read a character or block.

Returns:
the character read or -1 on error

Definition at line 258 of file ESP8266.cpp.

bool getHostByName ( const char *  host,
char *  ip 
) [inherited]

Return the IP address from host name.

Returns:
true on success, false on failure

Definition at line 297 of file ESP8266.cpp.

static ESP8266* getInstance (  ) [static, inherited]

Obtains the current instance of the ESP8266.

Definition at line 170 of file ESP8266.h.

const char * getIPAddress (  )

Get IP address.

Returns:
Either a pointer to the internally stored IP address or null if not connected

Reimplemented from ESP8266.

Definition at line 20 of file ESP8266Interface.cpp.

bool init (  )

Initialize the wifi hardware.

Returns:
true if successful

Reimplemented from ESP8266.

Definition at line 8 of file ESP8266Interface.cpp.

bool is_connected (  ) [inherited]

Check connection to the access point.

Returns:
true if successful

Definition at line 118 of file ESP8266.cpp.

int putc ( char  c ) [inherited]

Write a character.

Parameters:
thecharacter which will be written
Returns:
-1 on error

Definition at line 252 of file ESP8266.cpp.

int readable (  ) [inherited]

Check if wifi is readable.

Returns:
number of characters available

Definition at line 279 of file ESP8266.cpp.

bool recv ( char *  buffer,
int *  len 
) [inherited]

Read a string without blocking.

Parameters:
bufferthe buffer that will be written
lenthe length of the buffer, is replaced by read length
Returns:
true on success

Definition at line 215 of file ESP8266.cpp.

bool reset (  ) [inherited]

Reset the wifi module.

Definition at line 56 of file ESP8266.cpp.

bool send ( const char *  buffer,
int  len 
) [inherited]

Write a string.

Parameters:
bufferthe buffer that will be written
lenthe length of the buffer
Returns:
true on success

Definition at line 191 of file ESP8266.cpp.

int writeable (  ) [inherited]

Check if wifi is writable.

Returns:
1 if wifi is writable

Definition at line 274 of file ESP8266.cpp.

Generated on Tue Jul 12 2022 18:54:25 by  doxygen 1.7.2