ESP8266 / ESP8266NodeMCUInterface

ESP8266 driver using the NodeMCU interface

Dependencies:   BufferedSerial

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

Fork of ESP8266Interface by ESP8266

This is an alternative implementation of the ESP8266 driver that uses the NodeMCU firmware. The NodeMCU firmware provides a slightly larger feature set than the default firmware through a Lua interpreter.

Note

This library is currently in Alpha. It is not feature complete and has some bugs, proceed with caution. Fixes and patches are welcome!

Interface changes

  • SSID and passphrase moved out of ESP8266Interface constructor and to ESP8266Interface::connect
  • ESP8266Interface constructor provides optional timeout parameter to specify how long to wait for network operations

Note

NodeMCU defaults to a baud rate of 9600 instead of 115200 used by the default firmware.

Firmware

To install the NodeMCU firmware, follow the instructions on the Firmware Update wiki page using the nodemcu_integer_0.9.6-dev_20150406.bin binary at address 0x00000 instead of boot_v1.1.bin and user1.bin.

Since the NodeMCU firmware defaults to a baud rate of 9600, the Serial Passthrough program can be used to get direct access to the Lua interpreter running on the ESP8266.

Status

Working features:

  • TCP Client
  • UDP Client Transmit (Currently only UDP Server can recieve messages)
  • Single Connection at a time
  • Station Mode (Connects to AP)
  • DNS Lookups

To be implemented:

  • TCP Server
  • UDP Server
  • UDP Client recieve
  • Multiple Connections tracked through Lua variables
  • AP Mode (Act as access point)
  • IPV6 support (Existing issue with NodeMCU)

Files at this revision

API Documentation at this revision

Revision 31:fd0eaf273b11, committed 2015-04-30

Comitter:
mbedAustin
Date:
Thu Apr 30 04:53:21 2015 +0000
Parent:
30:c035696b9397
Child:
32:cf071dc33972
Commit message:
safety commit

Changed in this revision

ESP8266/ESP8266.h Show annotated file Show diff for this revision Revisions of this file
Socket/Endpoint.cpp Show annotated file Show diff for this revision Revisions of this file
Socket/Endpoint.h Show annotated file Show diff for this revision Revisions of this file
Socket/TCSocketConnection.cpp Show annotated file Show diff for this revision Revisions of this file
Socket/UDPSocket.cpp Show annotated file Show diff for this revision Revisions of this file 
--- a/ESP8266/ESP8266.h	Wed Apr 29 22:43:03 2015 +0000
+++ b/ESP8266/ESP8266.h	Thu Apr 30 04:53:21 2015 +0000
@@ -94,7 +94,7 @@
     * @param ip A string that contains the IP, no quotes
     * @param port Numerical port number to connect to
     */
-    bool ESP8266::startUDP(char* ip, int port);
+    bool startUDP(char* ip, int port);
 
     /**
     * Close a connection
@@ -111,7 +111,7 @@
 
     /**
     * Return the IP address from host name
-    * @return IP address as a string
+    * @return true on success, false on failure
     */    bool gethostbyname(const char * host, char * ip);
 
     /**

--- a/Socket/Endpoint.cpp	Wed Apr 29 22:43:03 2015 +0000
+++ b/Socket/Endpoint.cpp	Thu Apr 30 04:53:21 2015 +0000
@@ -23,7 +23,8 @@
 
 using std::memset;
 
-Endpoint::Endpoint()  {
+Endpoint::Endpoint()
+{
     ESP8266 = ESP8266::getInstance();
     if (ESP8266 == NULL)
         error("Endpoint constructor error: no ESP8266 instance available!\r\n");
@@ -31,29 +32,35 @@
 }
 Endpoint::~Endpoint() {}
 
-void Endpoint::reset_address(void) {
+void Endpoint::reset_address(void)
+{
     _ipAddress[0] = '\0';
     _port = 0;
     _id = -1;
 }
 
-int Endpoint::set_address(const char* host, const int port) {
+int Endpoint::set_address(const char* host, const int port)
+{
     //Resolve DNS address or populate hard-coded IP address
-    ESP8266->gethostbyname(host, _ipAddress);
-    _port = port;
-    //Start the UDP Endpoint 
-    ESP8266->start(ESP_UDP_TYPE,_ipAddress,_port);
-    return 0;
+    if(ESP8266->gethostbyname(host, _ipAddress)) {
+        _port = port;
+        return 0;
+    } else {
+        return -1;
+    }
 }
 
-char* Endpoint::get_address() {
+char* Endpoint::get_address()
+{
     return _ipAddress;
 }
 
-int   Endpoint::get_port() {
+int   Endpoint::get_port()
+{
     return _port;
 }
 
-int Endpoint::get_id(){
+int Endpoint::get_id()
+{
     return _id;
 }

--- a/Socket/Endpoint.h	Wed Apr 29 22:43:03 2015 +0000
+++ b/Socket/Endpoint.h	Thu Apr 30 04:53:21 2015 +0000
@@ -64,7 +64,7 @@
 protected:
     char _ipAddress[16];
     int _port;
-    int _id = -1;
+    int _id;
     
     ESP8266 * ESP8266;
 };

--- a/Socket/TCSocketConnection.cpp	Wed Apr 29 22:43:03 2015 +0000
+++ b/Socket/TCSocketConnection.cpp	Thu Apr 30 04:53:21 2015 +0000
@@ -31,17 +31,17 @@
 //    if (init_socket(SOCK_STREAM) < 0)
 //        return -1;
 //
-//    if (set_address(host, port) != 0)
-//        return -1;
+    if (set_address(host, port) != 0)
+        return -1;
 //
 //    if (lwip_connect(_sock_fd, (const struct sockaddr *) &_remoteHost, sizeof(_remoteHost)) < 0) {
 //        close();
 //        return -1;
 //    }
 //    _is_connected = true;
-    _is_connected();
+    _is_connected = ESP8266->start(ESP_TCP_TYPE,_ipAddress,_port);
 
-    return 0;
+    return _is_connected;
 }
 
 bool TCPSocketConnection::is_connected(void)
@@ -64,6 +64,7 @@
 //    _is_connected = (n != 0);
 //
 //    return n;
+    
     return 0;
 }
 

--- a/Socket/UDPSocket.cpp	Wed Apr 29 22:43:03 2015 +0000
+++ b/Socket/UDPSocket.cpp	Thu Apr 30 04:53:21 2015 +0000
@@ -53,7 +53,7 @@
 
     while ((tmr.read_ms() < _timeout) || _blocking) {
 
-        idx += wifi->sendUDP(packet, length);
+        idx += wifi->send(packet, length);
 
         if (idx == length)
             return idx;