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

Comitter:
mbedAustin
Date:
Sat May 02 03:30:52 2015 +0000
Parent:
33:727aac1996b8
Child:
37:6887e61cf674
Commit message:
updated debug command prints

Changed in this revision

ESP8266/ESP8266.cpp Show annotated file Show diff for this revision Revisions of this file
ESP8266/ESP8266.h Show annotated file Show diff for this revision Revisions of this file
Socket/Socket.cpp Show annotated file Show diff for this revision Revisions of this file
--- a/ESP8266/ESP8266.cpp	Thu Apr 30 21:09:14 2015 +0000
+++ b/ESP8266/ESP8266.cpp	Sat May 02 03:30:52 2015 +0000
@@ -23,18 +23,18 @@
 #include <algorithm>
 
 //Debug is disabled by default
-#ifdef DEBUG
-#define DBG(x, ...)  printf("[ESP8266 : DBG]"x"\r\n", ##__VA_ARGS__);
-#define WARN(x, ...) printf("[ESP8266 : WARN]"x"\r\n", ##__VA_ARGS__);
-#define ERR(x, ...)  printf("[ESP8266 : ERR]"x"\r\n", ##__VA_ARGS__);
+#if 1
+#define DBG(x, ...)  printf("[ESP8266 : DBG]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); 
+#define WARN(x, ...) printf("[ESP8266 : WARN]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); 
+#define ERR(x, ...)  printf("[ESP8266 : ERR]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); 
 #else
 #define DBG(x, ...)
 #define WARN(x, ...)
 #define ERR(x, ...)
 #endif
 
-#ifdef DEBUG
-#define INFO(x, ...) printf("[ESP8266 : INFO]"x"\r\n", ##__VA_ARGS__);
+#if 1
+#define INFO(x, ...) printf("[ESP8266 : INFO]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); 
 #else
 #define INFO(x, ...)
 #endif
@@ -48,8 +48,9 @@
 char* ip = NULL;
 
 ESP8266::ESP8266(   PinName tx, PinName rx, PinName _reset, const char * ssid, const char * phrase, uint32_t baud):
-    wifi(tx, rx), reset_pin(_reset), buf_ESP8266(256)
+    wifi(tx, rx), reset_pin(_reset), buf_ESP8266(ESP_MBUFFE_MAX)
 {
+    INFO("Initializing ESP8266 object");
     memset(&state, 0, sizeof(state));
 
     // change all ' ' in '$' in the ssid and the passphrase
@@ -81,7 +82,7 @@
     if( sendCommand( cmd.c_str(), "OK", NULL, 10000) ) {
         // successfully joined the network
         state.associated = true;
-        INFO("\r\nssid: %s\r\nphrase: %s\r\nsecurity: %s\r\n\r\n", this->ssid, this->phrase);
+        INFO("ssid: %s, phrase: %s, security: %s", this->ssid, this->phrase);
         return true;
     }
     return false;
@@ -128,11 +129,10 @@
         check[2] = sendCommand("AT+CIPSEND", ">", NULL, 1000);// go into transparent mode
         // check that all commands were sucessful
         if(check[0] and check[1] and check[2]) {
-            DBG("Data Mode\r\n");
             state.cmdMode = false;
             return true;
         } else {
-            DBG("\r\nstartUDPTransparent Failed for ip:%s, port:%d\r\n",ip,port);
+            ERR("startUDPTransparent Failed for ip:%s, port:%d",ip,port);
             return false;
         }
     }
@@ -221,12 +221,12 @@
         //pos4 = resultString.find('"',pos3+1);
         strncpy(ipString,resultString.substr(pos1,pos2).c_str(),sizeof(ipString));
         ipString[pos2 - pos1 +1] = 0; // null terminate string correctly.
-        DBG("IP: %s\r\n",ipString);
+        DBG("IP: %s",ipString);
         ip = ipString;
 
     } else {
         // Failure
-        DBG("getIPAddress() failed\r\n");
+        DBG("getIPAddress() failed");
         ip = NULL;
     }
     return ip;
@@ -401,7 +401,7 @@
                 }
             }
         }
-        DBG("check: %s\r\n", checking.c_str());
+        DBG("check: %s", checking.c_str());
 
         attach_rx(true);
         return result;
@@ -420,13 +420,13 @@
                     break;
                 }
                 res[i] = '\0';
-                DBG("user str 1: %s\r\n", res);
+                DBG("user str 1: %s", res);
 
                 break;
             } else {
                 if (tmr.read_ms() > 300) {
                     res[i] = '\0';
-                    DBG("user str: %s\r\n", res);
+                    DBG("user str: %s", res);
 
                     break;
                 }
@@ -441,7 +441,7 @@
                 }
             }
         }
-        DBG("user str: %s\r\n", res);
+        DBG("user str: %s", res);
     }
 
     //We flush the buffer
@@ -449,6 +449,6 @@
         getc();
 
     attach_rx(true);
-    DBG("result: %d\r\n", result)
+    DBG("result: %d", result)
     return result;
 }
--- a/ESP8266/ESP8266.h	Thu Apr 30 21:09:14 2015 +0000
+++ b/ESP8266/ESP8266.h	Sat May 02 03:30:52 2015 +0000
@@ -33,6 +33,7 @@
 #define DEFAULT_WAIT_RESP_TIMEOUT 500
 #define ESP_TCP_TYPE 1
 #define ESP_UDP_TYPE 0 
+#define ESP_MBUFFE_MAX 256
 
 /**
  * The ESP8266 class
--- a/Socket/Socket.cpp	Thu Apr 30 21:09:14 2015 +0000
+++ b/Socket/Socket.cpp	Sat May 02 03:30:52 2015 +0000
@@ -19,16 +19,32 @@
 #include "Socket.h"
 #include <cstring>
 
+//Debug is disabled by default
+#if 1
+//Enable debug
+#include <cstdio>
+#define DBG(x, ...) std::printf("[Socket : DBG]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); 
+#define WARN(x, ...) std::printf("[Socket : WARN]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); 
+#define ERR(x, ...) std::printf("[Socket : ERR]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__); 
+
+#else
+//Disable debug
+#define DBG(x, ...) 
+#define WARN(x, ...)
+#define ERR(x, ...) 
+
+#endif
+
 extern Serial pc;
 
 Socket::Socket() : _blocking(true), _timeout(1500) {
     wifi = ESP8266::getInstance();
     if (wifi == NULL)
-        error("Socket constructor error: no ESP8266 instance available!\r\n");
+        ERR("Socket constructor error: no ESP8266 instance available!");
 }
 
 void Socket::set_blocking(bool blocking, unsigned int timeout) {
-    printf("set blocking: %d %d\r\n", blocking, timeout);
+    DBG("set blocking: %d %d", blocking, timeout);
     _blocking = blocking;
     _timeout = timeout;
 }