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@48:03fd9333670d, 2015-06-10 (annotated)

Committer:
sarahmarshy
Date:
Wed Jun 10 15:47:33 2015 +0000
Revision:
48:03fd9333670d
Parent:
45:c180905b5b79 
ESP8266 was changing ssid spaces to "$". Unecessary. Removed this feature.

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;
michaeljkoster 19:fb8d5bff2076 28 Endpoint currentEndpoint;
samux 1:fb4494783863 29 }
samux 1:fb4494783863 30
samux 1:fb4494783863 31 int UDPSocket::init(void)
samux 1:fb4494783863 32 {
samux 1:fb4494783863 33 return 0;
samux 1:fb4494783863 34 }
samux 1:fb4494783863 35
samux 1:fb4494783863 36 // Server initialization
samux 1:fb4494783863 37 int UDPSocket::bind(int port)
samux 1:fb4494783863 38 {
samux 1:fb4494783863 39 return 0;
samux 1:fb4494783863 40 }
samux 1:fb4494783863 41
samux 1:fb4494783863 42 // -1 if unsuccessful, else number of bytes written
samux 1:fb4494783863 43 int UDPSocket::sendTo(Endpoint &remote, char *packet, int length)
samux 1:fb4494783863 44 {
samux 1:fb4494783863 45 Timer tmr;
samux 1:fb4494783863 46 int idx = 0;
samux 1:fb4494783863 47
mbedAustin 34:7ccda5d68a00 48
samux 1:fb4494783863 49 confEndpoint(remote);
mbedAustin 39:89e259295728 50
mbedAustin 34:7ccda5d68a00 51 // initialize transparent mode if not already done
mbedAustin 34:7ccda5d68a00 52 if(!endpoint_configured) {
mbedAustin 34:7ccda5d68a00 53 // initialize UDP (default id of -1 means transparent mode)
sarahmarshy 44:3a7b6083210b 54 //!wifi->start(ESP_UDP_TYPE, remote._ipAddress, remote._port, remote._id
sarahmarshy 44:3a7b6083210b 55 if(!wifi->startUDP(remote._ipAddress, remote._port, 0,length)) {
mbedAustin 34:7ccda5d68a00 56 return(-1);
mbedAustin 34:7ccda5d68a00 57 }
mbedAustin 34:7ccda5d68a00 58 endpoint_configured = true;
mbedAustin 34:7ccda5d68a00 59 }
mbedAustin 39:89e259295728 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
mbedAustin 31:fd0eaf273b11 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;
mbedAustin 34:7ccda5d68a00 80
michaeljkoster 27:9c6cefc12f0c 81 //make this the non-blocking case and return if <= 0
michaeljkoster 27:9c6cefc12f0c 82 // remember to change the config to blocking
michaeljkoster 27:9c6cefc12f0c 83 // if ( ! _blocking) {
mbedAustin 34:7ccda5d68a00 84 // if ( wifi.readable <= 0 ) {
mbedAustin 34:7ccda5d68a00 85 // return (wifi.readable);
mbedAustin 34:7ccda5d68a00 86 // }
michaeljkoster 27:9c6cefc12f0c 87 // }
michaeljkoster 27:9c6cefc12f0c 88 //---
michaeljkoster 22:c4360e61486a 89 tmr.start();
samux 1:fb4494783863 90 if (_blocking) {
samux 1:fb4494783863 91 while (1) {
samux 1:fb4494783863 92 nb_available = wifi->readable();
samux 1:fb4494783863 93 if (nb_available != 0) {
samux 1:fb4494783863 94 break;
samux 1:fb4494783863 95 }
samux 1:fb4494783863 96 }
michaeljkoster 21:690526f05fe6 97 }
michaeljkoster 27:9c6cefc12f0c 98 //---
michaeljkoster 27:9c6cefc12f0c 99 // blocking case
michaeljkoster 21:690526f05fe6 100 else {
michaeljkoster 22:c4360e61486a 101 tmr.reset();
mbedAustin 34:7ccda5d68a00 102
mbedAustin 34:7ccda5d68a00 103 while (time < _timeout) {
michaeljkoster 21:690526f05fe6 104 nb_available = wifi->readable();
michaeljkoster 21:690526f05fe6 105 if (nb_available < 0) return nb_available;
michaeljkoster 21:690526f05fe6 106 if (nb_available > 0) break ;
michaeljkoster 21:690526f05fe6 107 time = tmr.read_ms();
michaeljkoster 21:690526f05fe6 108 }
mbedAustin 34:7ccda5d68a00 109
mbedAustin 34:7ccda5d68a00 110 if (nb_available == 0) return nb_available;
mbedAustin 34:7ccda5d68a00 111 }
mbedAustin 34:7ccda5d68a00 112
michaeljkoster 27:9c6cefc12f0c 113 // change this to < 20 mS timeout per byte to detect end of packet gap
michaeljkoster 27:9c6cefc12f0c 114 // this may not work due to buffering at the UART interface
michaeljkoster 22:c4360e61486a 115 tmr.reset();
michaeljkoster 27:9c6cefc12f0c 116 // while ( tmr.read_ms() < 20 ) {
mbedAustin 34:7ccda5d68a00 117 // if ( wifi.readable() && (idx < length) ) {
mbedAustin 34:7ccda5d68a00 118 // buffer[idx++] = wifi->getc();
mbedAustin 34:7ccda5d68a00 119 // tmr.reset();
mbedAustin 34:7ccda5d68a00 120 // }
mbedAustin 34:7ccda5d68a00 121 // if ( idx == length ) {
mbedAustin 34:7ccda5d68a00 122 // break;
mbedAustin 34:7ccda5d68a00 123 // }
michaeljkoster 27:9c6cefc12f0c 124 // }
michaeljkoster 27:9c6cefc12f0c 125 //---
samux 1:fb4494783863 126 while (time < _timeout) {
samux 1:fb4494783863 127
samux 1:fb4494783863 128 nb_available = wifi->readable();
michaeljkoster 23:de9221771e96 129 //for (int i = 0; i < min(nb_available, length); i++) {
michaeljkoster 23:de9221771e96 130 for (int i = 0; i < min(nb_available, (length-idx)); i++) {
samux 1:fb4494783863 131 buffer[idx] = wifi->getc();
samux 1:fb4494783863 132 idx++;
samux 1:fb4494783863 133 }
samux 1:fb4494783863 134 if (idx == length) {
samux 1:fb4494783863 135 break;
samux 1:fb4494783863 136 }
samux 1:fb4494783863 137 time = tmr.read_ms();
samux 1:fb4494783863 138 }
michaeljkoster 27:9c6cefc12f0c 139 //---
samux 1:fb4494783863 140 readEndpoint(remote);
samux 1:fb4494783863 141 return (idx == 0) ? -1 : idx;
samux 1:fb4494783863 142 }
samux 1:fb4494783863 143
samux 1:fb4494783863 144 bool UDPSocket::confEndpoint(Endpoint & ep)
samux 1:fb4494783863 145 {
michaeljkoster 19:fb8d5bff2076 146 currentEndpoint = ep;
samux 1:fb4494783863 147 return true;
samux 1:fb4494783863 148 }
samux 1:fb4494783863 149
samux 1:fb4494783863 150 bool UDPSocket::readEndpoint(Endpoint & ep)
samux 1:fb4494783863 151 {
michaeljkoster 19:fb8d5bff2076 152 ep = currentEndpoint;
michaeljkoster 16:3f0efaa57a12 153 return true;
samux 1:fb4494783863 154 }