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@27:9c6cefc12f0c, 2015-04-20 (annotated)

Committer:
michaeljkoster
Date:
Mon Apr 20 20:27:11 2015 +0000
Revision:
27:9c6cefc12f0c
Parent:
23:de9221771e96
Child:
30:c035696b9397
Blocking

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;
michaeljkoster 19:fb8d5bff2076 30 Endpoint currentEndpoint;
samux 1:fb4494783863 31 }
samux 1:fb4494783863 32
samux 1:fb4494783863 33 int UDPSocket::init(void)
samux 1:fb4494783863 34 {
samux 1:fb4494783863 35 return 0;
samux 1:fb4494783863 36 }
samux 1:fb4494783863 37
samux 1:fb4494783863 38 // Server initialization
samux 1:fb4494783863 39 int UDPSocket::bind(int port)
samux 1:fb4494783863 40 {
samux 1:fb4494783863 41 return 0;
samux 1:fb4494783863 42 }
samux 1:fb4494783863 43
samux 1:fb4494783863 44 // -1 if unsuccessful, else number of bytes written
samux 1:fb4494783863 45 int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
samux 1:fb4494783863 46 {
samux 1:fb4494783863 47 Timer tmr;
samux 1:fb4494783863 48 int idx = 0;
samux 1:fb4494783863 49
samux 1:fb4494783863 50 confEndpoint(remote);
samux 1:fb4494783863 51
samux 1:fb4494783863 52 tmr.start();
samux 1:fb4494783863 53
samux 1:fb4494783863 54 while ((tmr.read_ms() < _timeout) || _blocking) {
samux 1:fb4494783863 55
samux 1:fb4494783863 56 idx += wifi->send(packet, length);
samux 1:fb4494783863 57
samux 1:fb4494783863 58 if (idx == length)
samux 1:fb4494783863 59 return idx;
samux 1:fb4494783863 60 }
samux 1:fb4494783863 61 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 62 }
samux 1:fb4494783863 63
samux 1:fb4494783863 64 // -1 if unsuccessful, else number of bytes received
samux 1:fb4494783863 65 int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
samux 1:fb4494783863 66 {
samux 1:fb4494783863 67 Timer tmr;
samux 1:fb4494783863 68 int idx = 0;
samux 1:fb4494783863 69 int nb_available = 0;
samux 1:fb4494783863 70 int time = -1;
michaeljkoster 27:9c6cefc12f0c 71
michaeljkoster 27:9c6cefc12f0c 72 //make this the non-blocking case and return if <= 0
michaeljkoster 27:9c6cefc12f0c 73 // remember to change the config to blocking
michaeljkoster 27:9c6cefc12f0c 74 // if ( ! _blocking) {
michaeljkoster 27:9c6cefc12f0c 75 // if ( wifi.readable <= 0 ) {
michaeljkoster 27:9c6cefc12f0c 76 // return (wifi.readable);
michaeljkoster 27:9c6cefc12f0c 77 // }
michaeljkoster 27:9c6cefc12f0c 78 // }
michaeljkoster 27:9c6cefc12f0c 79 //---
michaeljkoster 22:c4360e61486a 80 tmr.start();
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 }
michaeljkoster 21:690526f05fe6 88 }
michaeljkoster 27:9c6cefc12f0c 89 //---
michaeljkoster 27:9c6cefc12f0c 90 // blocking case
michaeljkoster 21:690526f05fe6 91 else {
michaeljkoster 22:c4360e61486a 92 tmr.reset();
michaeljkoster 21:690526f05fe6 93
michaeljkoster 21:690526f05fe6 94 while (time < _timeout){
michaeljkoster 21:690526f05fe6 95 nb_available = wifi->readable();
michaeljkoster 21:690526f05fe6 96 if (nb_available < 0) return nb_available;
michaeljkoster 21:690526f05fe6 97 if (nb_available > 0) break ;
michaeljkoster 21:690526f05fe6 98 time = tmr.read_ms();
michaeljkoster 21:690526f05fe6 99 }
michaeljkoster 21:690526f05fe6 100
michaeljkoster 21:690526f05fe6 101 if (nb_available == 0) return nb_available;
michaeljkoster 21:690526f05fe6 102 }
michaeljkoster 21:690526f05fe6 103
michaeljkoster 27:9c6cefc12f0c 104 // change this to < 20 mS timeout per byte to detect end of packet gap
michaeljkoster 27:9c6cefc12f0c 105 // this may not work due to buffering at the UART interface
michaeljkoster 22:c4360e61486a 106 tmr.reset();
michaeljkoster 27:9c6cefc12f0c 107 // while ( tmr.read_ms() < 20 ) {
michaeljkoster 27:9c6cefc12f0c 108 // if ( wifi.readable() && (idx < length) ) {
michaeljkoster 27:9c6cefc12f0c 109 // buffer[idx++] = wifi->getc();
michaeljkoster 27:9c6cefc12f0c 110 // tmr.reset();
michaeljkoster 27:9c6cefc12f0c 111 // }
michaeljkoster 27:9c6cefc12f0c 112 // if ( idx == length ) {
michaeljkoster 27:9c6cefc12f0c 113 // break;
michaeljkoster 27:9c6cefc12f0c 114 // }
michaeljkoster 27:9c6cefc12f0c 115 // }
michaeljkoster 27:9c6cefc12f0c 116 //---
samux 1:fb4494783863 117 while (time < _timeout) {
samux 1:fb4494783863 118
samux 1:fb4494783863 119 nb_available = wifi->readable();
michaeljkoster 23:de9221771e96 120 //for (int i = 0; i < min(nb_available, length); i++) {
michaeljkoster 23:de9221771e96 121 for (int i = 0; i < min(nb_available, (length-idx)); i++) {
samux 1:fb4494783863 122 buffer[idx] = wifi->getc();
samux 1:fb4494783863 123 idx++;
samux 1:fb4494783863 124 }
samux 1:fb4494783863 125 if (idx == length) {
samux 1:fb4494783863 126 break;
samux 1:fb4494783863 127 }
samux 1:fb4494783863 128 time = tmr.read_ms();
samux 1:fb4494783863 129 }
michaeljkoster 27:9c6cefc12f0c 130 //---
samux 1:fb4494783863 131 readEndpoint(remote);
samux 1:fb4494783863 132 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 133 }
samux 1:fb4494783863 134
samux 1:fb4494783863 135 bool UDPSocket::confEndpoint(Endpoint & ep)
samux 1:fb4494783863 136 {
michaeljkoster 19:fb8d5bff2076 137 currentEndpoint = ep;
samux 1:fb4494783863 138 return true;
samux 1:fb4494783863 139 }
samux 1:fb4494783863 140
samux 1:fb4494783863 141 bool UDPSocket::readEndpoint(Endpoint & ep)
samux 1:fb4494783863 142 {
michaeljkoster 19:fb8d5bff2076 143 ep = currentEndpoint;
michaeljkoster 16:3f0efaa57a12 144 return true;
samux 1:fb4494783863 145 }