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 20:d764237405c2, committed 2014-12-01

Comitter:
michaeljkoster
Date:
Mon Dec 01 09:28:02 2014 +0000
Parent:
19:fb8d5bff2076
Child:
21:690526f05fe6
Commit message:
cleanup

Changed in this revision

ESP8266/ESP8266.cpp Show annotated file Show diff for this revision Revisions of this file 
--- a/ESP8266/ESP8266.cpp	Mon Dec 01 08:56:54 2014 +0000
+++ b/ESP8266/ESP8266.cpp	Mon Dec 01 09:28:02 2014 +0000
@@ -66,7 +66,6 @@
     attach_rx(false);
     
     wifi.baud(9600); // initial baud rate of the ESP8266 
-    pc.printf("ESP8266 test\r\n");
 }
 
 bool ESP8266::join()
@@ -173,7 +172,7 @@
     while (wifi.readable()){
         c=wifi.getc();
         buf_ESP8266.queue(c);
-        pc.printf("%c",c);
+        pc.printf("%c",c); //debug echo
     }
 }
 
@@ -205,7 +204,7 @@
 
 int ESP8266::putc(char c)
 {
-    while (!wifi.writeable() || wifi.readable());
+    while (!wifi.writeable() || wifi.readable()); //wait for echoed command characters to be read first
     return wifi.putc(c);
 }
 
@@ -243,10 +242,10 @@
     if (!ACK || !strcmp(ACK, "NO")) {
         for (int i = 0; i < strlen(cmd); i++){
             result = (putc(cmd[i]) == cmd[i]) ? result + 1 : result;
-            wait(.005);
+            wait(.005); // prevents stuck recieve ready (?) need to let echoed character get read first
         }
         putc(13); //CR
-        wait(.005);
+        wait(.005); // wait for echo
         putc(10); //LF
 
     } else {
@@ -257,10 +256,10 @@
         tmr.start();
         for (int i = 0; i < strlen(cmd); i++){
             result = (putc(cmd[i]) == cmd[i]) ? result + 1 : result;
-            wait(.005);
+            wait(.005); // wait for echo
         }
         putc(13); //CR
-        wait(.005);
+        wait(.005); // wait for echo
         putc(10); //LF
 
         while (1) {