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: Socket/UDPSocket.cpp
- Revision:
- 1:fb4494783863
- Child:
- 4:0bcec6272784
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Socket/UDPSocket.cpp Fri Aug 24 13:48:36 2012 +0000
@@ -0,0 +1,166 @@
+/* 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 "UDPSocket.h"
+
+#include <string>
+#include <algorithm>
+
+UDPSocket::UDPSocket()
+{
+ endpoint_configured = false;
+ endpoint_read = false;
+}
+
+int UDPSocket::init(void)
+{
+ wifi->setProtocol(UDP);
+ wifi->exit();
+ return 0;
+}
+
+// Server initialization
+int UDPSocket::bind(int port)
+{
+ char cmd[17];
+
+ // set udp protocol
+ wifi->setProtocol(UDP);
+
+ // set local port
+ sprintf(cmd, "set i l %d\r", port);
+ if (!wifi->sendCommand(cmd, "AOK"))
+ return -1;
+ wifi->exit();
+ return 0;
+}
+
+// -1 if unsuccessful, else number of bytes written
+int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
+{
+ Timer tmr;
+ int idx = 0;
+
+ confEndpoint(remote);
+
+ tmr.start();
+
+ while ((tmr.read_ms() < _timeout) || _blocking) {
+
+ idx += wifi->send(packet, length);
+
+ if (idx == length)
+ return idx;
+ }
+ return (idx == 0) ? -1 : idx;
+}
+
+// -1 if unsuccessful, else number of bytes received
+int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
+{
+ Timer tmr;
+ int idx = 0;
+ int nb_available = 0;
+ int time = -1;
+
+ if (_blocking) {
+ while (1) {
+ nb_available = wifi->readable();
+ if (nb_available != 0) {
+ break;
+ }
+ }
+ }
+
+ tmr.start();
+
+ while (time < _timeout) {
+
+ nb_available = wifi->readable();
+ for (int i = 0; i < min(nb_available, length); i++) {
+ buffer[idx] = wifi->getc();
+ idx++;
+ }
+
+ if (idx == length) {
+ break;
+ }
+
+ time = tmr.read_ms();
+ }
+
+ readEndpoint(remote);
+ return (idx == 0) ? -1 : idx;
+}
+
+bool UDPSocket::confEndpoint(Endpoint & ep)
+{
+ char * host;
+ char cmd[30];
+ if (!endpoint_configured) {
+ host = ep.get_address();
+ if (host[0] != '\0') {
+ // set host
+ sprintf(cmd, "set i h %s\r", host);
+ if (!wifi->sendCommand(cmd, "AOK"))
+ return false;
+
+ // set remote port
+ sprintf(cmd, "set i r %d\r", ep.get_port());
+ if (!wifi->sendCommand(cmd, "AOK"))
+ return false;
+
+ wifi->exit();
+ endpoint_configured = true;
+ return true;
+ }
+ }
+ return true;
+}
+
+bool UDPSocket::readEndpoint(Endpoint & ep)
+{
+ char recv[256];
+ int begin = 0;
+ int end = 0;
+ string str;
+ string addr;
+ int port;
+ if (!endpoint_read) {
+ if (!wifi->sendCommand("get ip\r", NULL, recv))
+ return false;
+ wifi->exit();
+ str = recv;
+ begin = str.find("HOST=");
+ end = str.find("PROTO=");
+ if (begin != string::npos && end != string::npos) {
+ str = str.substr(begin + 5, end - begin - 5);
+ int pos = str.find(":");
+ if (pos != string::npos) {
+ addr = str.substr(0, pos);
+ port = atoi(str.substr(pos + 1).c_str());
+ ep.set_address(addr.c_str(), port);
+ endpoint_read = true;
+ wifi->flush();
+ return true;
+ }
+ }
+ wifi->flush();
+ }
+ return false;
+}
ESP8266

Adafruit Huzzah