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
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: ESP8266Interface.h
- Revision:
- 44:16da10e7b3f7
- Parent:
- 28:91e65e22e63a
diff -r 22d30e936e4c -r 16da10e7b3f7 ESP8266Interface.h --- a/ESP8266Interface.h Fri May 01 18:29:38 2015 +0000 +++ b/ESP8266Interface.h Wed Jun 03 21:44:20 2015 +0000 @@ -32,40 +32,42 @@ /** * Constructor * - * \param tx mbed pin to use for tx line of Serial interface - * \param rx mbed pin to use for rx line of Serial interface - * \param reset reset pin of the wifi module () - * \param ssid ssid of the network - * \param phrase WEP or WPA key - * \param baud the baudrate of the serial connection (defaults to 115200, diff revs of the firmware use diff baud rates + * @param tx mbed pin to use for tx line of Serial interface + * @param rx mbed pin to use for rx line of Serial interface + * @param reset reset pin of the wifi module () + * @param baud the baudrate of the serial connection + * @param timeout the timeout of the serial connection */ - ESP8266Interface(PinName tx, PinName rx, PinName reset, const char * ssid, const char * phrase, uint32_t baud = 115200 ); - - /** Initialize the interface with DHCP. - * Initialize the interface and configure it to use DHCP (no connection at this point). - * \return 0 on success, a negative number on failure - */ - int init(); //With DHCP + ESP8266Interface(PinName tx, PinName rx, PinName reset, int baud = 9600, int timeout = 3000); + + /** + * Initialize the wifi hardware + * + * @return true if successful + */ + bool init(); - /** Connect - * Bring the interface up, start DHCP if needed. - * \return 0 on success, a negative number on failure - */ - bool connect(); + /** + * Connect the wifi module to the specified ssid. + * + * @param ssid ssid of the network + * @param phrase WEP, WPA or WPA2 key + * @return true if successful + */ + bool connect(const char *ssid, const char *phrase); - /** Disconnect - * Bring the interface down - * \return 0 on success, a negative number on failure - */ - int disconnect(); + /** + * Disconnect the ESP8266 module from the access point + * + * @return true if successful + */ + int disconnect(); - /** Get IP address - * - * \return ip address - */ - char* getIPAddress(); - -private: + /** Get IP address + * + * @return Either a pointer to the internally stored IP address or null if not connected + */ + const char *getIPAddress(); }; #include "UDPSocket.h"