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

Committer:
sarahmarshy
Date:
Wed Jun 10 15:47:33 2015 +0000
Revision:
48:03fd9333670d
Parent:
19:fb8d5bff2076 
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 #ifndef UDPSOCKET_H
samux 1:fb4494783863 20 #define UDPSOCKET_H
samux 1:fb4494783863 21
samux 1:fb4494783863 22 #include "Endpoint.h"
samux 1:fb4494783863 23 #include "Socket.h"
samux 1:fb4494783863 24
samux 1:fb4494783863 25 #include <cstdint>
samux 1:fb4494783863 26
samux 1:fb4494783863 27 /**
samux 1:fb4494783863 28 UDP Socket
samux 1:fb4494783863 29 */
samux 1:fb4494783863 30 class UDPSocket: public Socket {
samux 1:fb4494783863 31
samux 1:fb4494783863 32 public:
samux 1:fb4494783863 33 /** Instantiate an UDP Socket.
samux 1:fb4494783863 34 */
samux 1:fb4494783863 35 UDPSocket();
samux 1:fb4494783863 36
samux 1:fb4494783863 37 /** Init the UDP Client Socket without binding it to any specific port
samux 1:fb4494783863 38 \return 0 on success, -1 on failure.
samux 1:fb4494783863 39 */
samux 1:fb4494783863 40 int init(void);
samux 1:fb4494783863 41
samux 1:fb4494783863 42 /** Bind a UDP Server Socket to a specific port
samux 1:fb4494783863 43 \param port The port to listen for incoming connections on
samux 1:fb4494783863 44 \return 0 on success, -1 on failure.
samux 1:fb4494783863 45 */
samux 1:fb4494783863 46 int bind(int port = -1);
samux 1:fb4494783863 47
samux 1:fb4494783863 48 /** Send a packet to a remote endpoint
samux 1:fb4494783863 49 \param remote The remote endpoint
samux 1:fb4494783863 50 \param packet The packet to be sent
samux 1:fb4494783863 51 \param length The length of the packet to be sent
samux 1:fb4494783863 52 \return the number of written bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 53 */
samux 1:fb4494783863 54 int sendTo(Endpoint &remote, char *packet, int length);
samux 1:fb4494783863 55
samux 1:fb4494783863 56 /** Receive a packet from a remote endpoint
samux 1:fb4494783863 57 \param remote The remote endpoint
samux 1:fb4494783863 58 \param buffer The buffer for storing the incoming packet data. If a packet
samux 1:fb4494783863 59 is too long to fit in the supplied buffer, excess bytes are discarded
samux 1:fb4494783863 60 \param length The length of the buffer
samux 1:fb4494783863 61 \return the number of received bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 62 */
samux 1:fb4494783863 63 int receiveFrom(Endpoint &remote, char *buffer, int length);
samux 1:fb4494783863 64
samux 1:fb4494783863 65 private:
samux 1:fb4494783863 66 bool confEndpoint(Endpoint & ep);
samux 1:fb4494783863 67 bool readEndpoint(Endpoint & ep);
samux 1:fb4494783863 68 bool endpoint_configured;
samux 1:fb4494783863 69 bool endpoint_read;
michaeljkoster 19:fb8d5bff2076 70 Endpoint currentEndpoint;
samux 1:fb4494783863 71
samux 1:fb4494783863 72 };
samux 1:fb4494783863 73
samux 1:fb4494783863 74 #include "def.h"
samux 1:fb4494783863 75
samux 1:fb4494783863 76 #endif