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@1:fb4494783863, 2012-08-24 (annotated)

Committer:
samux
Date:
Fri Aug 24 13:48:36 2012 +0000
Revision:
1:fb4494783863
Child:
4:0bcec6272784
first commit

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
samux 1:fb4494783863 24 UDPSocket::UDPSocket()
samux 1:fb4494783863 25 {
samux 1:fb4494783863 26 endpoint_configured = false;
samux 1:fb4494783863 27 endpoint_read = false;
samux 1:fb4494783863 28 }
samux 1:fb4494783863 29
samux 1:fb4494783863 30 int UDPSocket::init(void)
samux 1:fb4494783863 31 {
samux 1:fb4494783863 32 wifi->setProtocol(UDP);
samux 1:fb4494783863 33 wifi->exit();
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 char cmd[17];
samux 1:fb4494783863 41
samux 1:fb4494783863 42 // set udp protocol
samux 1:fb4494783863 43 wifi->setProtocol(UDP);
samux 1:fb4494783863 44
samux 1:fb4494783863 45 // set local port
samux 1:fb4494783863 46 sprintf(cmd, "set i l %d\r", port);
samux 1:fb4494783863 47 if (!wifi->sendCommand(cmd, "AOK"))
samux 1:fb4494783863 48 return -1;
samux 1:fb4494783863 49 wifi->exit();
samux 1:fb4494783863 50 return 0;
samux 1:fb4494783863 51 }
samux 1:fb4494783863 52
samux 1:fb4494783863 53 // -1 if unsuccessful, else number of bytes written
samux 1:fb4494783863 54 int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
samux 1:fb4494783863 55 {
samux 1:fb4494783863 56 Timer tmr;
samux 1:fb4494783863 57 int idx = 0;
samux 1:fb4494783863 58
samux 1:fb4494783863 59 confEndpoint(remote);
samux 1:fb4494783863 60
samux 1:fb4494783863 61 tmr.start();
samux 1:fb4494783863 62
samux 1:fb4494783863 63 while ((tmr.read_ms() < _timeout) || _blocking) {
samux 1:fb4494783863 64
samux 1:fb4494783863 65 idx += wifi->send(packet, length);
samux 1:fb4494783863 66
samux 1:fb4494783863 67 if (idx == length)
samux 1:fb4494783863 68 return idx;
samux 1:fb4494783863 69 }
samux 1:fb4494783863 70 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 71 }
samux 1:fb4494783863 72
samux 1:fb4494783863 73 // -1 if unsuccessful, else number of bytes received
samux 1:fb4494783863 74 int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
samux 1:fb4494783863 75 {
samux 1:fb4494783863 76 Timer tmr;
samux 1:fb4494783863 77 int idx = 0;
samux 1:fb4494783863 78 int nb_available = 0;
samux 1:fb4494783863 79 int time = -1;
samux 1:fb4494783863 80
samux 1:fb4494783863 81 if (_blocking) {
samux 1:fb4494783863 82 while (1) {
samux 1:fb4494783863 83 nb_available = wifi->readable();
samux 1:fb4494783863 84 if (nb_available != 0) {
samux 1:fb4494783863 85 break;
samux 1:fb4494783863 86 }
samux 1:fb4494783863 87 }
samux 1:fb4494783863 88 }
samux 1:fb4494783863 89
samux 1:fb4494783863 90 tmr.start();
samux 1:fb4494783863 91
samux 1:fb4494783863 92 while (time < _timeout) {
samux 1:fb4494783863 93
samux 1:fb4494783863 94 nb_available = wifi->readable();
samux 1:fb4494783863 95 for (int i = 0; i < min(nb_available, length); i++) {
samux 1:fb4494783863 96 buffer[idx] = wifi->getc();
samux 1:fb4494783863 97 idx++;
samux 1:fb4494783863 98 }
samux 1:fb4494783863 99
samux 1:fb4494783863 100 if (idx == length) {
samux 1:fb4494783863 101 break;
samux 1:fb4494783863 102 }
samux 1:fb4494783863 103
samux 1:fb4494783863 104 time = tmr.read_ms();
samux 1:fb4494783863 105 }
samux 1:fb4494783863 106
samux 1:fb4494783863 107 readEndpoint(remote);
samux 1:fb4494783863 108 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 109 }
samux 1:fb4494783863 110
samux 1:fb4494783863 111 bool UDPSocket::confEndpoint(Endpoint & ep)
samux 1:fb4494783863 112 {
samux 1:fb4494783863 113 char * host;
samux 1:fb4494783863 114 char cmd[30];
samux 1:fb4494783863 115 if (!endpoint_configured) {
samux 1:fb4494783863 116 host = ep.get_address();
samux 1:fb4494783863 117 if (host[0] != '\0') {
samux 1:fb4494783863 118 // set host
samux 1:fb4494783863 119 sprintf(cmd, "set i h %s\r", host);
samux 1:fb4494783863 120 if (!wifi->sendCommand(cmd, "AOK"))
samux 1:fb4494783863 121 return false;
samux 1:fb4494783863 122
samux 1:fb4494783863 123 // set remote port
samux 1:fb4494783863 124 sprintf(cmd, "set i r %d\r", ep.get_port());
samux 1:fb4494783863 125 if (!wifi->sendCommand(cmd, "AOK"))
samux 1:fb4494783863 126 return false;
samux 1:fb4494783863 127
samux 1:fb4494783863 128 wifi->exit();
samux 1:fb4494783863 129 endpoint_configured = true;
samux 1:fb4494783863 130 return true;
samux 1:fb4494783863 131 }
samux 1:fb4494783863 132 }
samux 1:fb4494783863 133 return true;
samux 1:fb4494783863 134 }
samux 1:fb4494783863 135
samux 1:fb4494783863 136 bool UDPSocket::readEndpoint(Endpoint & ep)
samux 1:fb4494783863 137 {
samux 1:fb4494783863 138 char recv[256];
samux 1:fb4494783863 139 int begin = 0;
samux 1:fb4494783863 140 int end = 0;
samux 1:fb4494783863 141 string str;
samux 1:fb4494783863 142 string addr;
samux 1:fb4494783863 143 int port;
samux 1:fb4494783863 144 if (!endpoint_read) {
samux 1:fb4494783863 145 if (!wifi->sendCommand("get ip\r", NULL, recv))
samux 1:fb4494783863 146 return false;
samux 1:fb4494783863 147 wifi->exit();
samux 1:fb4494783863 148 str = recv;
samux 1:fb4494783863 149 begin = str.find("HOST=");
samux 1:fb4494783863 150 end = str.find("PROTO=");
samux 1:fb4494783863 151 if (begin != string::npos && end != string::npos) {
samux 1:fb4494783863 152 str = str.substr(begin + 5, end - begin - 5);
samux 1:fb4494783863 153 int pos = str.find(":");
samux 1:fb4494783863 154 if (pos != string::npos) {
samux 1:fb4494783863 155 addr = str.substr(0, pos);
samux 1:fb4494783863 156 port = atoi(str.substr(pos + 1).c_str());
samux 1:fb4494783863 157 ep.set_address(addr.c_str(), port);
samux 1:fb4494783863 158 endpoint_read = true;
samux 1:fb4494783863 159 wifi->flush();
samux 1:fb4494783863 160 return true;
samux 1:fb4494783863 161 }
samux 1:fb4494783863 162 }
samux 1:fb4494783863 163 wifi->flush();
samux 1:fb4494783863 164 }
samux 1:fb4494783863 165 return false;
samux 1:fb4494783863 166 }