ESP8266 / ESP8266Interface

ESP8266 Socket Library. AT Thinker firmware.

Dependents:   ESP8266_MQTT_HelloWorld ESP8266_IFTTT_Test ECE_4180_Lab_4 websocketmbed ... more

Fork of ESP8266Interface by ESP8266

This repository has been superceded

This project has moved to https://developer.mbed.org/teams/ESP8266/code/esp8266-driver/

This library works with the AT Thinker firmware.

Note

This library is currently in Beta. It is not feature complete and has some bugs, proceed with caution! Fixes and patches are welcome and appreciated!

Currently the ESP8266Interface Library has the following Abilities:

Working

  • TCP Client
  • UDP Client
  • Transparent mode (single connection of 1 type at a time)
  • Station Mode (connects to AP)

To be implemented

  • TCP Server
  • UDP Server
  • Multi Connection Mode (able to have up to 5 sockets at a time)
  • AP Mode (Make ESP Chip act like access point)
  • DNS Support (currently websites must be looked up by IP)
  • Error Recovery

Nice but not necessary

  • colorized text for ESP AT Commands in Command line (easier to differentiate from other text)

Socket/UDPSocket.cpp@12:c5f0eac67a8a, 2014-10-08 (annotated)

Committer:
michaeljkoster
Date:
Wed Oct 08 19:57:58 2014 +0000
Revision:
12:c5f0eac67a8a
Parent:
4:0bcec6272784
Child:
13:41098c907200
Debug

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 wifi->setProtocol(UDP);
samux 1:fb4494783863 35 wifi->exit();
samux 1:fb4494783863 36 return 0;
samux 1:fb4494783863 37 }
samux 1:fb4494783863 38
samux 1:fb4494783863 39 // Server initialization
samux 1:fb4494783863 40 int UDPSocket::bind(int port)
samux 1:fb4494783863 41 {
samux 1:fb4494783863 42 char cmd[17];
samux 1:fb4494783863 43
samux 1:fb4494783863 44 // set local port
michaeljkoster 12:c5f0eac67a8a 45 sprintf(cmd, "set i l %d\n\r", port);
michaeljkoster 12:c5f0eac67a8a 46 if (!wifi->sendCommand(cmd, "AOK")){
michaeljkoster 12:c5f0eac67a8a 47 pc.printf("bind to port failed\r\n");
michaeljkoster 12:c5f0eac67a8a 48 return -1;}
samux 4:0bcec6272784 49
samux 4:0bcec6272784 50 // save
michaeljkoster 12:c5f0eac67a8a 51 //if (!wifi->sendCommand("save\n\r", "Stor"))
michaeljkoster 12:c5f0eac67a8a 52 //return -1;
samux 4:0bcec6272784 53
samux 4:0bcec6272784 54 // reboot
michaeljkoster 12:c5f0eac67a8a 55 //wifi->reboot();
samux 4:0bcec6272784 56
samux 4:0bcec6272784 57 // set udp protocol
michaeljkoster 12:c5f0eac67a8a 58 //wifi->setProtocol(UDP);
michaeljkoster 12:c5f0eac67a8a 59 /*
samux 4:0bcec6272784 60 // connect the network
samux 4:0bcec6272784 61 if (wifi->isDHCP()) {
michaeljkoster 12:c5f0eac67a8a 62 if (!wifi->sendCommand("join\n\r", "DHCP=ON", NULL, 10000))
samux 4:0bcec6272784 63 return -1;
samux 4:0bcec6272784 64 } else {
michaeljkoster 12:c5f0eac67a8a 65 if (!wifi->sendCommand("join\n\r", "Associated", NULL, 10000))
samux 4:0bcec6272784 66 return -1;
samux 4:0bcec6272784 67 }
michaeljkoster 12:c5f0eac67a8a 68 */
samux 4:0bcec6272784 69 // exit
samux 1:fb4494783863 70 wifi->exit();
samux 4:0bcec6272784 71 wifi->flush();
samux 1:fb4494783863 72 return 0;
samux 1:fb4494783863 73 }
samux 1:fb4494783863 74
samux 1:fb4494783863 75 // -1 if unsuccessful, else number of bytes written
samux 1:fb4494783863 76 int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
samux 1:fb4494783863 77 {
samux 1:fb4494783863 78 Timer tmr;
samux 1:fb4494783863 79 int idx = 0;
samux 1:fb4494783863 80
samux 1:fb4494783863 81 confEndpoint(remote);
samux 1:fb4494783863 82
samux 1:fb4494783863 83 tmr.start();
samux 1:fb4494783863 84
samux 1:fb4494783863 85 while ((tmr.read_ms() < _timeout) || _blocking) {
samux 1:fb4494783863 86
samux 1:fb4494783863 87 idx += wifi->send(packet, length);
samux 1:fb4494783863 88
samux 1:fb4494783863 89 if (idx == length)
samux 1:fb4494783863 90 return idx;
samux 1:fb4494783863 91 }
samux 1:fb4494783863 92 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 93 }
samux 1:fb4494783863 94
samux 1:fb4494783863 95 // -1 if unsuccessful, else number of bytes received
samux 1:fb4494783863 96 int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
samux 1:fb4494783863 97 {
samux 1:fb4494783863 98 Timer tmr;
samux 1:fb4494783863 99 int idx = 0;
samux 1:fb4494783863 100 int nb_available = 0;
samux 1:fb4494783863 101 int time = -1;
samux 1:fb4494783863 102
samux 1:fb4494783863 103 if (_blocking) {
samux 1:fb4494783863 104 while (1) {
samux 1:fb4494783863 105 nb_available = wifi->readable();
samux 1:fb4494783863 106 if (nb_available != 0) {
samux 1:fb4494783863 107 break;
samux 1:fb4494783863 108 }
samux 1:fb4494783863 109 }
michaeljkoster 12:c5f0eac67a8a 110 pc.printf("UDPsocket::receiveFrom: %d bytes\r\n", nb_available);
michaeljkoster 12:c5f0eac67a8a 111 }
samux 1:fb4494783863 112
samux 1:fb4494783863 113 tmr.start();
samux 1:fb4494783863 114
samux 1:fb4494783863 115 while (time < _timeout) {
samux 1:fb4494783863 116
samux 1:fb4494783863 117 nb_available = wifi->readable();
samux 1:fb4494783863 118 for (int i = 0; i < min(nb_available, length); i++) {
samux 1:fb4494783863 119 buffer[idx] = wifi->getc();
samux 1:fb4494783863 120 idx++;
samux 1:fb4494783863 121 }
samux 1:fb4494783863 122
samux 1:fb4494783863 123 if (idx == length) {
samux 1:fb4494783863 124 break;
samux 1:fb4494783863 125 }
samux 1:fb4494783863 126
samux 1:fb4494783863 127 time = tmr.read_ms();
samux 1:fb4494783863 128 }
samux 1:fb4494783863 129
samux 1:fb4494783863 130 readEndpoint(remote);
samux 1:fb4494783863 131 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 132 }
samux 1:fb4494783863 133
samux 1:fb4494783863 134 bool UDPSocket::confEndpoint(Endpoint & ep)
samux 1:fb4494783863 135 {
samux 1:fb4494783863 136 char * host;
samux 1:fb4494783863 137 char cmd[30];
samux 1:fb4494783863 138 if (!endpoint_configured) {
samux 1:fb4494783863 139 host = ep.get_address();
samux 1:fb4494783863 140 if (host[0] != '\0') {
samux 1:fb4494783863 141 // set host
michaeljkoster 12:c5f0eac67a8a 142 sprintf(cmd, "set i h %s\r\n", host);
samux 1:fb4494783863 143 if (!wifi->sendCommand(cmd, "AOK"))
samux 1:fb4494783863 144 return false;
samux 1:fb4494783863 145
samux 1:fb4494783863 146 // set remote port
michaeljkoster 12:c5f0eac67a8a 147 sprintf(cmd, "set i r %d\r\n", ep.get_port());
samux 1:fb4494783863 148 if (!wifi->sendCommand(cmd, "AOK"))
samux 1:fb4494783863 149 return false;
samux 1:fb4494783863 150
samux 1:fb4494783863 151 wifi->exit();
samux 1:fb4494783863 152 endpoint_configured = true;
samux 1:fb4494783863 153 return true;
samux 1:fb4494783863 154 }
samux 1:fb4494783863 155 }
samux 1:fb4494783863 156 return true;
samux 1:fb4494783863 157 }
samux 1:fb4494783863 158
samux 1:fb4494783863 159 bool UDPSocket::readEndpoint(Endpoint & ep)
samux 1:fb4494783863 160 {
samux 1:fb4494783863 161 char recv[256];
samux 1:fb4494783863 162 int begin = 0;
samux 1:fb4494783863 163 int end = 0;
samux 1:fb4494783863 164 string str;
samux 1:fb4494783863 165 string addr;
samux 1:fb4494783863 166 int port;
samux 1:fb4494783863 167 if (!endpoint_read) {
michaeljkoster 12:c5f0eac67a8a 168 if (!wifi->sendCommand("get ip\r\n", NULL, recv))
samux 1:fb4494783863 169 return false;
samux 1:fb4494783863 170 wifi->exit();
samux 1:fb4494783863 171 str = recv;
samux 1:fb4494783863 172 begin = str.find("HOST=");
samux 1:fb4494783863 173 end = str.find("PROTO=");
samux 1:fb4494783863 174 if (begin != string::npos && end != string::npos) {
samux 1:fb4494783863 175 str = str.substr(begin + 5, end - begin - 5);
samux 1:fb4494783863 176 int pos = str.find(":");
samux 1:fb4494783863 177 if (pos != string::npos) {
samux 1:fb4494783863 178 addr = str.substr(0, pos);
samux 1:fb4494783863 179 port = atoi(str.substr(pos + 1).c_str());
samux 1:fb4494783863 180 ep.set_address(addr.c_str(), port);
samux 1:fb4494783863 181 endpoint_read = true;
samux 1:fb4494783863 182 wifi->flush();
samux 1:fb4494783863 183 return true;
samux 1:fb4494783863 184 }
samux 1:fb4494783863 185 }
samux 1:fb4494783863 186 wifi->flush();
samux 1:fb4494783863 187 }
samux 1:fb4494783863 188 return false;
samux 1:fb4494783863 189 }