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)

Diff: ESP8266/ESP8266.h

Revision:
15:37a7a56a424f
Parent:
14:4d1128f72e00
Child:
16:3f0efaa57a12
--- a/ESP8266/ESP8266.h	Sun Nov 30 21:37:16 2014 +0000
+++ b/ESP8266/ESP8266.h	Sun Nov 30 21:56:03 2014 +0000
@@ -58,14 +58,7 @@
     bool join();
 
     /**
-    * Disconnect the ESP8266 module from the access point
-    *
-    * @return true if successful
-    */
-    bool disconnect();
-
-    /**
-    * Join to the access point and get DHCP settings
+    * Same as Join: connect to the ssid and get DHCP settings
     * @return true if successful
     */
     bool connect();
@@ -77,10 +70,30 @@
     bool is_connected();
 
     /**
+    * Disconnect the ESP8266 module from the access point
+    *
+    * @return true if successful
+    */
+    bool disconnect();
+
+    /**
+    * Close a tcp connection
+    *
+    * @return true if successful
+    */
+    bool close();
+    
+    /**
     * Return the IP address 
     * @return IP address as a string
     */
     char* getIPAddress();
+
+    /**
+    * Return the IP address from host name
+    * @return IP address as a string
+    */    bool gethostbyname(const char * host, char * ip);
+
     /**
     * Reset the wifi module
     */
@@ -113,11 +126,6 @@
     char getc();
 
     /**
-    * Flush the buffer
-    */
-    void flush();
-
-    /**
     * Write a character
     *
     * @param the character which will be written
@@ -125,12 +133,21 @@
     int putc(char c);
 
     /**
-    * Close a tcp connection
+    * Flush the buffer
+    */
+    void flush();
+
+    /**
+    * Send a command to the wify module. Check if the module is in command mode. If not enter in command mode
+    *
+    * @param str string to be sent
+    * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
+    * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
     *
     * @return true if successful
     */
-    bool close();
-    
+    bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
+
     /**
     * Send a string to the wifi module by serial port. This function desactivates the user interrupt handler when a character is received to analyze the response from the wifi module.
     * Useful to send a command to the module and wait a response.
@@ -145,19 +162,6 @@
     */
     int send(const char * str, int len, const char * ACK = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
 
-    /**
-    * Send a command to the wify module. Check if the module is in command mode. If not enter in command mode
-    *
-    * @param str string to be sent
-    * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
-    * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
-    *
-    * @return true if successful
-    */
-    bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
-
-    bool gethostbyname(const char * host, char * ip);
-
     static ESP8266 * getInstance() {
         return inst;
     };