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/UDPSocket.cpp@16:3f0efaa57a12, 2014-12-01 (annotated)

Committer:
michaeljkoster
Date:
Mon Dec 01 06:22:00 2014 +0000
Revision:
16:3f0efaa57a12
Parent:
13:41098c907200
Child:
19:fb8d5bff2076
sync

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 "UDPSocket.h"
samux 1:fb4494783863 20
samux 1:fb4494783863 21 #include <string>
samux 1:fb4494783863 22 #include <algorithm>
samux 1:fb4494783863 23
michaeljkoster 12:c5f0eac67a8a 24 extern Serial pc;
michaeljkoster 12:c5f0eac67a8a 25
samux 1:fb4494783863 26 UDPSocket::UDPSocket()
samux 1:fb4494783863 27 {
samux 1:fb4494783863 28 endpoint_configured = false;
samux 1:fb4494783863 29 endpoint_read = false;
samux 1:fb4494783863 30 }
samux 1:fb4494783863 31
samux 1:fb4494783863 32 int UDPSocket::init(void)
samux 1:fb4494783863 33 {
samux 1:fb4494783863 34 return 0;
samux 1:fb4494783863 35 }
samux 1:fb4494783863 36
samux 1:fb4494783863 37 // Server initialization
samux 1:fb4494783863 38 int UDPSocket::bind(int port)
samux 1:fb4494783863 39 {
samux 1:fb4494783863 40 return 0;
samux 1:fb4494783863 41 }
samux 1:fb4494783863 42
samux 1:fb4494783863 43 // -1 if unsuccessful, else number of bytes written
samux 1:fb4494783863 44 int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
samux 1:fb4494783863 45 {
samux 1:fb4494783863 46 Timer tmr;
samux 1:fb4494783863 47 int idx = 0;
samux 1:fb4494783863 48
samux 1:fb4494783863 49 confEndpoint(remote);
samux 1:fb4494783863 50
samux 1:fb4494783863 51 tmr.start();
samux 1:fb4494783863 52
samux 1:fb4494783863 53 while ((tmr.read_ms() < _timeout) || _blocking) {
samux 1:fb4494783863 54
samux 1:fb4494783863 55 idx += wifi->send(packet, length);
samux 1:fb4494783863 56
samux 1:fb4494783863 57 if (idx == length)
samux 1:fb4494783863 58 return idx;
samux 1:fb4494783863 59 }
samux 1:fb4494783863 60 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 61 }
samux 1:fb4494783863 62
samux 1:fb4494783863 63 // -1 if unsuccessful, else number of bytes received
samux 1:fb4494783863 64 int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
samux 1:fb4494783863 65 {
samux 1:fb4494783863 66 Timer tmr;
samux 1:fb4494783863 67 int idx = 0;
samux 1:fb4494783863 68 int nb_available = 0;
samux 1:fb4494783863 69 int time = -1;
samux 1:fb4494783863 70
samux 1:fb4494783863 71 if (_blocking) {
samux 1:fb4494783863 72 while (1) {
samux 1:fb4494783863 73 nb_available = wifi->readable();
samux 1:fb4494783863 74 if (nb_available != 0) {
samux 1:fb4494783863 75 break;
samux 1:fb4494783863 76 }
samux 1:fb4494783863 77 }
michaeljkoster 12:c5f0eac67a8a 78 pc.printf("UDPsocket::receiveFrom: %d bytes\r\n", nb_available);
michaeljkoster 12:c5f0eac67a8a 79 }
samux 1:fb4494783863 80
samux 1:fb4494783863 81 tmr.start();
samux 1:fb4494783863 82
samux 1:fb4494783863 83 while (time < _timeout) {
samux 1:fb4494783863 84
samux 1:fb4494783863 85 nb_available = wifi->readable();
samux 1:fb4494783863 86 for (int i = 0; i < min(nb_available, length); i++) {
samux 1:fb4494783863 87 buffer[idx] = wifi->getc();
samux 1:fb4494783863 88 idx++;
samux 1:fb4494783863 89 }
samux 1:fb4494783863 90
samux 1:fb4494783863 91 if (idx == length) {
samux 1:fb4494783863 92 break;
samux 1:fb4494783863 93 }
samux 1:fb4494783863 94
samux 1:fb4494783863 95 time = tmr.read_ms();
samux 1:fb4494783863 96 }
samux 1:fb4494783863 97
samux 1:fb4494783863 98 readEndpoint(remote);
samux 1:fb4494783863 99 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 100 }
samux 1:fb4494783863 101
samux 1:fb4494783863 102 bool UDPSocket::confEndpoint(Endpoint & ep)
samux 1:fb4494783863 103 {
samux 1:fb4494783863 104 return true;
samux 1:fb4494783863 105 }
samux 1:fb4494783863 106
samux 1:fb4494783863 107 bool UDPSocket::readEndpoint(Endpoint & ep)
samux 1:fb4494783863 108 {
michaeljkoster 16:3f0efaa57a12 109 return true;
samux 1:fb4494783863 110 }