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@44:3a7b6083210b, 2015-06-03 (annotated)

Committer:
sarahmarshy
Date:
Wed Jun 03 18:21:19 2015 +0000
Revision:
44:3a7b6083210b
Parent:
35:22d30e936e4c
Child:
45:c180905b5b79
-UDP Client working ; -Interfaces with WebSocketClient; -General improvements

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
mbedAustin 35:22d30e936e4c 50
samux 1:fb4494783863 51 confEndpoint(remote);
samux 1:fb4494783863 52
mbedAustin 35:22d30e936e4c 53 // initialize transparent mode if not already done
mbedAustin 35:22d30e936e4c 54 if(!endpoint_configured) {
mbedAustin 35:22d30e936e4c 55 // initialize UDP (default id of -1 means transparent mode)
sarahmarshy 44:3a7b6083210b 56 //!wifi->start(ESP_UDP_TYPE, remote._ipAddress, remote._port, remote._id
sarahmarshy 44:3a7b6083210b 57 if(!wifi->startUDP(remote._ipAddress, remote._port, 0,length)) {
mbedAustin 35:22d30e936e4c 58 return(-1);
mbedAustin 35:22d30e936e4c 59 }
mbedAustin 35:22d30e936e4c 60 endpoint_configured = true;
mbedAustin 35:22d30e936e4c 61 }
mbedAustin 35:22d30e936e4c 62
samux 1:fb4494783863 63 tmr.start();
samux 1:fb4494783863 64
samux 1:fb4494783863 65 while ((tmr.read_ms() < _timeout) || _blocking) {
samux 1:fb4494783863 66
mbedAustin 31:fd0eaf273b11 67 idx += wifi->send(packet, length);
samux 1:fb4494783863 68
samux 1:fb4494783863 69 if (idx == length)
samux 1:fb4494783863 70 return idx;
samux 1:fb4494783863 71 }
samux 1:fb4494783863 72 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 73 }
samux 1:fb4494783863 74
samux 1:fb4494783863 75 // -1 if unsuccessful, else number of bytes received
samux 1:fb4494783863 76 int UDPSocket::receiveFrom(Endpoint &remote, char *buffer, int length)
samux 1:fb4494783863 77 {
samux 1:fb4494783863 78 Timer tmr;
samux 1:fb4494783863 79 int idx = 0;
samux 1:fb4494783863 80 int nb_available = 0;
samux 1:fb4494783863 81 int time = -1;
mbedAustin 35:22d30e936e4c 82
michaeljkoster 27:9c6cefc12f0c 83 //make this the non-blocking case and return if <= 0
michaeljkoster 27:9c6cefc12f0c 84 // remember to change the config to blocking
michaeljkoster 27:9c6cefc12f0c 85 // if ( ! _blocking) {
mbedAustin 35:22d30e936e4c 86 // if ( wifi.readable <= 0 ) {
mbedAustin 35:22d30e936e4c 87 // return (wifi.readable);
mbedAustin 35:22d30e936e4c 88 // }
michaeljkoster 27:9c6cefc12f0c 89 // }
michaeljkoster 27:9c6cefc12f0c 90 //---
michaeljkoster 22:c4360e61486a 91 tmr.start();
samux 1:fb4494783863 92 if (_blocking) {
samux 1:fb4494783863 93 while (1) {
samux 1:fb4494783863 94 nb_available = wifi->readable();
samux 1:fb4494783863 95 if (nb_available != 0) {
samux 1:fb4494783863 96 break;
samux 1:fb4494783863 97 }
samux 1:fb4494783863 98 }
michaeljkoster 21:690526f05fe6 99 }
michaeljkoster 27:9c6cefc12f0c 100 //---
michaeljkoster 27:9c6cefc12f0c 101 // blocking case
michaeljkoster 21:690526f05fe6 102 else {
michaeljkoster 22:c4360e61486a 103 tmr.reset();
mbedAustin 35:22d30e936e4c 104
mbedAustin 35:22d30e936e4c 105 while (time < _timeout) {
michaeljkoster 21:690526f05fe6 106 nb_available = wifi->readable();
michaeljkoster 21:690526f05fe6 107 if (nb_available < 0) return nb_available;
michaeljkoster 21:690526f05fe6 108 if (nb_available > 0) break ;
michaeljkoster 21:690526f05fe6 109 time = tmr.read_ms();
michaeljkoster 21:690526f05fe6 110 }
mbedAustin 35:22d30e936e4c 111
mbedAustin 35:22d30e936e4c 112 if (nb_available == 0) return nb_available;
mbedAustin 35:22d30e936e4c 113 }
mbedAustin 35:22d30e936e4c 114
michaeljkoster 27:9c6cefc12f0c 115 // change this to < 20 mS timeout per byte to detect end of packet gap
michaeljkoster 27:9c6cefc12f0c 116 // this may not work due to buffering at the UART interface
michaeljkoster 22:c4360e61486a 117 tmr.reset();
michaeljkoster 27:9c6cefc12f0c 118 // while ( tmr.read_ms() < 20 ) {
mbedAustin 35:22d30e936e4c 119 // if ( wifi.readable() && (idx < length) ) {
mbedAustin 35:22d30e936e4c 120 // buffer[idx++] = wifi->getc();
mbedAustin 35:22d30e936e4c 121 // tmr.reset();
mbedAustin 35:22d30e936e4c 122 // }
mbedAustin 35:22d30e936e4c 123 // if ( idx == length ) {
mbedAustin 35:22d30e936e4c 124 // break;
mbedAustin 35:22d30e936e4c 125 // }
michaeljkoster 27:9c6cefc12f0c 126 // }
michaeljkoster 27:9c6cefc12f0c 127 //---
samux 1:fb4494783863 128 while (time < _timeout) {
samux 1:fb4494783863 129
samux 1:fb4494783863 130 nb_available = wifi->readable();
michaeljkoster 23:de9221771e96 131 //for (int i = 0; i < min(nb_available, length); i++) {
michaeljkoster 23:de9221771e96 132 for (int i = 0; i < min(nb_available, (length-idx)); i++) {
samux 1:fb4494783863 133 buffer[idx] = wifi->getc();
samux 1:fb4494783863 134 idx++;
samux 1:fb4494783863 135 }
samux 1:fb4494783863 136 if (idx == length) {
samux 1:fb4494783863 137 break;
samux 1:fb4494783863 138 }
samux 1:fb4494783863 139 time = tmr.read_ms();
samux 1:fb4494783863 140 }
michaeljkoster 27:9c6cefc12f0c 141 //---
samux 1:fb4494783863 142 readEndpoint(remote);
samux 1:fb4494783863 143 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 144 }
samux 1:fb4494783863 145
samux 1:fb4494783863 146 bool UDPSocket::confEndpoint(Endpoint & ep)
samux 1:fb4494783863 147 {
michaeljkoster 19:fb8d5bff2076 148 currentEndpoint = ep;
samux 1:fb4494783863 149 return true;
samux 1:fb4494783863 150 }
samux 1:fb4494783863 151
samux 1:fb4494783863 152 bool UDPSocket::readEndpoint(Endpoint & ep)
samux 1:fb4494783863 153 {
michaeljkoster 19:fb8d5bff2076 154 ep = currentEndpoint;
michaeljkoster 16:3f0efaa57a12 155 return true;
samux 1:fb4494783863 156 }