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)

Socket/Socket.cpp@40:0a83315aea0a, 2015-05-04 (annotated)

Committer:
sam_grove
Date:
Mon May 04 12:04:54 2015 +0000
Revision:
40:0a83315aea0a
Parent:
36:e1545c6c2cb3
Child:
42:3f62103a4f3c
Update so close exits transparent mode without depending on state from the application

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:fb4494783863 1 /* Copyright (C) 2012 mbed.org, MIT License
samux 1:fb4494783863 2 *
samux 1:fb4494783863 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:fb4494783863 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
samux 1:fb4494783863 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
samux 1:fb4494783863 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
samux 1:fb4494783863 7 * furnished to do so, subject to the following conditions:
samux 1:fb4494783863 8 *
samux 1:fb4494783863 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:fb4494783863 10 * substantial portions of the Software.
samux 1:fb4494783863 11 *
samux 1:fb4494783863 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:fb4494783863 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:fb4494783863 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:fb4494783863 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:fb4494783863 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:fb4494783863 17 */
samux 1:fb4494783863 18
samux 1:fb4494783863 19 #include "Socket.h"
samux 1:fb4494783863 20 #include <cstring>
samux 1:fb4494783863 21
mbedAustin 36:e1545c6c2cb3 22 //Debug is disabled by default
sam_grove 40:0a83315aea0a 23 #if 0
mbedAustin 36:e1545c6c2cb3 24 //Enable debug
mbedAustin 36:e1545c6c2cb3 25 #include <cstdio>
mbedAustin 36:e1545c6c2cb3 26 #define DBG(x, ...) std::printf("[Socket : DBG]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__);
mbedAustin 36:e1545c6c2cb3 27 #define WARN(x, ...) std::printf("[Socket : WARN]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__);
mbedAustin 36:e1545c6c2cb3 28 #define ERR(x, ...) std::printf("[Socket : ERR]"x" [%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__);
mbedAustin 36:e1545c6c2cb3 29
mbedAustin 36:e1545c6c2cb3 30 #else
mbedAustin 36:e1545c6c2cb3 31 //Disable debug
mbedAustin 36:e1545c6c2cb3 32 #define DBG(x, ...)
mbedAustin 36:e1545c6c2cb3 33 #define WARN(x, ...)
mbedAustin 36:e1545c6c2cb3 34 #define ERR(x, ...)
mbedAustin 36:e1545c6c2cb3 35
mbedAustin 36:e1545c6c2cb3 36 #endif
mbedAustin 36:e1545c6c2cb3 37
samux 1:fb4494783863 38 Socket::Socket() : _blocking(true), _timeout(1500) {
michaeljkoster 13:41098c907200 39 wifi = ESP8266::getInstance();
samux 1:fb4494783863 40 if (wifi == NULL)
mbedAustin 36:e1545c6c2cb3 41 ERR("Socket constructor error: no ESP8266 instance available!");
samux 1:fb4494783863 42 }
samux 1:fb4494783863 43
samux 1:fb4494783863 44 void Socket::set_blocking(bool blocking, unsigned int timeout) {
mbedAustin 36:e1545c6c2cb3 45 DBG("set blocking: %d %d", blocking, timeout);
samux 1:fb4494783863 46 _blocking = blocking;
samux 1:fb4494783863 47 _timeout = timeout;
samux 1:fb4494783863 48 }
samux 1:fb4494783863 49
samux 1:fb4494783863 50 int Socket::close() {
sam_grove 40:0a83315aea0a 51
samux 1:fb4494783863 52 return (wifi->close()) ? 0 : -1;
samux 1:fb4494783863 53 }
samux 1:fb4494783863 54
samux 1:fb4494783863 55 Socket::~Socket() {
samux 1:fb4494783863 56 close(); //Don't want to leak
samux 1:fb4494783863 57 }