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)
Revision:
32:cf071dc33972
Parent:
31:fd0eaf273b11
Child:
33:727aac1996b8
--- a/Socket/TCSocketConnection.cpp	Thu Apr 30 04:53:21 2015 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,146 +0,0 @@
-/* Copyright (C) 2012 mbed.org, MIT License
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
- * and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute,
- * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or
- * substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
- * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
- * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-#include "TCPSocketConnection.h"
-#include <cstring>
-
-using std::memset;
-using std::memcpy;
-
-TCPSocketConnection::TCPSocketConnection() :
-    _is_connected(false)
-{
-}
-
-int TCPSocketConnection::connect(const char* host, const int port)
-{
-//    if (init_socket(SOCK_STREAM) < 0)
-//        return -1;
-//
-    if (set_address(host, port) != 0)
-        return -1;
-//
-//    if (lwip_connect(_sock_fd, (const struct sockaddr *) &_remoteHost, sizeof(_remoteHost)) < 0) {
-//        close();
-//        return -1;
-//    }
-//    _is_connected = true;
-    _is_connected = ESP8266->start(ESP_TCP_TYPE,_ipAddress,_port);
-
-    return _is_connected;
-}
-
-bool TCPSocketConnection::is_connected(void)
-{
-    return _is_connected;
-}
-
-int TCPSocketConnection::send(char* data, int length)
-{
-//    if ((_sock_fd < 0) || !_is_connected)
-//        return -1;
-//
-//    if (!_blocking) {
-//        TimeInterval timeout(_timeout);
-//        if (wait_writable(timeout) != 0)
-//            return -1;
-//    }
-//
-//    int n = lwip_send(_sock_fd, data, length, 0);
-//    _is_connected = (n != 0);
-//
-//    return n;
-    
-    return 0;
-}
-
-// -1 if unsuccessful, else number of bytes written
-int TCPSocketConnection::send_all(char* data, int length)
-{
-//   if ((_sock_fd < 0) || !_is_connected)
-//        return -1;
-//
-//    int writtenLen = 0;
-//    TimeInterval timeout(_timeout);
-//    while (writtenLen < length) {
-//        if (!_blocking) {
-//            // Wait for socket to be writeable
-//            if (wait_writable(timeout) != 0)
-//                return writtenLen;
-//        }
-//
-//        int ret = lwip_send(_sock_fd, data + writtenLen, length - writtenLen, 0);
-//        if (ret > 0) {
-//            writtenLen += ret;
-//            continue;
-//        } else if (ret == 0) {
-//            _is_connected = false;
-//            return writtenLen;
-//        } else {
-//            return -1; //Connnection error
-//        }
-//    }
-//    return writtenLen;
-    return 0;
-}
-
-int TCPSocketConnection::receive(char* data, int length)
-{
-//    if ((_sock_fd < 0) || !_is_connected)
-//        return -1;
-//
-//    if (!_blocking) {
-//        TimeInterval timeout(_timeout);
-//        if (wait_readable(timeout) != 0)
-//            return -1;
-//    }
-//
-//    int n = lwip_recv(_sock_fd, data, length, 0);
-//    _is_connected = (n != 0);
-//
-//    return n;
-    return 0;
-}
-
-// -1 if unsuccessful, else number of bytes received
-int TCPSocketConnection::receive_all(char* data, int length)
-{
-    //  if ((_sock_fd < 0) || !_is_connected)
-//        return -1;
-//
-//    int readLen = 0;
-//    TimeInterval timeout(_timeout);
-//    while (readLen < length) {
-//        if (!_blocking) {
-//            //Wait for socket to be readable
-//            if (wait_readable(timeout) != 0)
-//                return readLen;
-//        }
-//
-//        int ret = lwip_recv(_sock_fd, data + readLen, length - readLen, 0);
-//        if (ret > 0) {
-//            readLen += ret;
-//        } else if (ret == 0) {
-//            _is_connected = false;
-//            return readLen;
-//        } else {
-//            return -1; //Connnection error
-//        }
-//    }
-//    return readLen;
-    return 0;
-}