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/Endpoint.cpp@48:6031f70e3914, 2015-06-04 (annotated)

Committer:
geky
Date:
Thu Jun 04 20:45:00 2015 +0000
Revision:
48:6031f70e3914
Parent:
44:16da10e7b3f7 
Fix for not using full buffer in TCP recieve

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 #include "Socket/Socket.h"
samux 1:fb4494783863 19 #include "Socket/Endpoint.h"
samux 1:fb4494783863 20 #include <cstring>
samux 1:fb4494783863 21
michaeljkoster 17:d11fa4c3ac65 22 extern Serial pc;
michaeljkoster 17:d11fa4c3ac65 23
samux 1:fb4494783863 24 using std::memset;
samux 1:fb4494783863 25
mbedAustin 31:fd0eaf273b11 26 Endpoint::Endpoint()
mbedAustin 31:fd0eaf273b11 27 {
michaeljkoster 13:41098c907200 28 ESP8266 = ESP8266::getInstance();
michaeljkoster 13:41098c907200 29 if (ESP8266 == NULL)
michaeljkoster 13:41098c907200 30 error("Endpoint constructor error: no ESP8266 instance available!\r\n");
samux 1:fb4494783863 31 reset_address();
samux 1:fb4494783863 32 }
samux 1:fb4494783863 33 Endpoint::~Endpoint() {}
samux 1:fb4494783863 34
mbedAustin 31:fd0eaf273b11 35 void Endpoint::reset_address(void)
mbedAustin 31:fd0eaf273b11 36 {
samux 1:fb4494783863 37 _ipAddress[0] = '\0';
samux 1:fb4494783863 38 _port = 0;
mbedAustin 30:c035696b9397 39 _id = -1;
samux 1:fb4494783863 40 }
samux 1:fb4494783863 41
mbedAustin 31:fd0eaf273b11 42 int Endpoint::set_address(const char* host, const int port)
mbedAustin 31:fd0eaf273b11 43 {
samux 1:fb4494783863 44 //Resolve DNS address or populate hard-coded IP address
geky 44:16da10e7b3f7 45 if(ESP8266->getHostByName(host, _ipAddress)) {
mbedAustin 31:fd0eaf273b11 46 _port = port;
mbedAustin 31:fd0eaf273b11 47 return 0;
mbedAustin 31:fd0eaf273b11 48 } else {
mbedAustin 31:fd0eaf273b11 49 return -1;
mbedAustin 31:fd0eaf273b11 50 }
samux 1:fb4494783863 51 }
samux 1:fb4494783863 52
mbedAustin 31:fd0eaf273b11 53 char* Endpoint::get_address()
mbedAustin 31:fd0eaf273b11 54 {
samux 1:fb4494783863 55 return _ipAddress;
samux 1:fb4494783863 56 }
samux 1:fb4494783863 57
mbedAustin 31:fd0eaf273b11 58 int Endpoint::get_port()
mbedAustin 31:fd0eaf273b11 59 {
samux 1:fb4494783863 60 return _port;
samux 1:fb4494783863 61 }
mbedAustin 30:c035696b9397 62
mbedAustin 31:fd0eaf273b11 63 int Endpoint::get_id()
mbedAustin 31:fd0eaf273b11 64 {
mbedAustin 30:c035696b9397 65 return _id;
mbedAustin 30:c035696b9397 66 }