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)

ESP8266/ESP8266.h@31:fd0eaf273b11, 2015-04-30 (annotated)

Committer:
mbedAustin
Date:
Thu Apr 30 04:53:21 2015 +0000
Revision:
31:fd0eaf273b11
Parent:
30:c035696b9397
Child:
32:cf071dc33972
safety 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 * @section DESCRIPTION
samux 1:fb4494783863 19 *
michaeljkoster 16:3f0efaa57a12 20 * ESP8266 serial wifi module
samux 1:fb4494783863 21 *
samux 1:fb4494783863 22 * Datasheet:
samux 1:fb4494783863 23 *
michaeljkoster 16:3f0efaa57a12 24 * http://www.electrodragon.com/w/Wi07c
samux 1:fb4494783863 25 */
samux 1:fb4494783863 26
michaeljkoster 13:41098c907200 27 #ifndef ESP8266_H
michaeljkoster 13:41098c907200 28 #define ESP8266_H
samux 1:fb4494783863 29
samux 1:fb4494783863 30 #include "mbed.h"
samux 1:fb4494783863 31 #include "CBuffer.h"
samux 1:fb4494783863 32
samux 1:fb4494783863 33 #define DEFAULT_WAIT_RESP_TIMEOUT 500
mbedAustin 30:c035696b9397 34 #define ESP_TCP_TYPE 1
mbedAustin 30:c035696b9397 35 #define ESP_UDP_TYPE 0
samux 1:fb4494783863 36
screamer 5:81e264dbbf03 37 /**
michaeljkoster 13:41098c907200 38 * The ESP8266 class
screamer 5:81e264dbbf03 39 */
michaeljkoster 13:41098c907200 40 class ESP8266
samux 1:fb4494783863 41 {
samux 1:fb4494783863 42
samux 1:fb4494783863 43 public:
screamer 5:81e264dbbf03 44 /**
samux 1:fb4494783863 45 * Constructor
samux 1:fb4494783863 46 *
samux 1:fb4494783863 47 * @param tx mbed pin to use for tx line of Serial interface
samux 1:fb4494783863 48 * @param rx mbed pin to use for rx line of Serial interface
samux 1:fb4494783863 49 * @param reset reset pin of the wifi module ()
samux 1:fb4494783863 50 * @param ssid ssid of the network
screamer 9:f2439377c172 51 * @param phrase WEP, WPA or WPA2 key
mbedAustin 28:91e65e22e63a 52 * @param baud the baudrate of the serial connection
samux 1:fb4494783863 53 */
mbedAustin 28:91e65e22e63a 54 ESP8266( PinName tx, PinName rx, PinName reset, const char * ssid, const char * phrase, uint32_t baud );
samux 1:fb4494783863 55
screamer 5:81e264dbbf03 56 /**
samux 1:fb4494783863 57 * Connect the wifi module to the ssid contained in the constructor.
samux 1:fb4494783863 58 *
samux 1:fb4494783863 59 * @return true if connected, false otherwise
samux 1:fb4494783863 60 */
samux 1:fb4494783863 61 bool join();
samux 1:fb4494783863 62
screamer 5:81e264dbbf03 63 /**
michaeljkoster 15:37a7a56a424f 64 * Same as Join: connect to the ssid and get DHCP settings
screamer 6:5176e0864078 65 * @return true if successful
samux 1:fb4494783863 66 */
michaeljkoster 13:41098c907200 67 bool connect();
michaeljkoster 13:41098c907200 68
screamer 5:81e264dbbf03 69 /**
michaeljkoster 13:41098c907200 70 * Check connection to the access point
screamer 6:5176e0864078 71 * @return true if successful
samux 1:fb4494783863 72 */
michaeljkoster 13:41098c907200 73 bool is_connected();
samux 1:fb4494783863 74
screamer 5:81e264dbbf03 75 /**
michaeljkoster 15:37a7a56a424f 76 * Disconnect the ESP8266 module from the access point
michaeljkoster 15:37a7a56a424f 77 *
michaeljkoster 15:37a7a56a424f 78 * @return true if successful
michaeljkoster 15:37a7a56a424f 79 */
michaeljkoster 15:37a7a56a424f 80 bool disconnect();
michaeljkoster 16:3f0efaa57a12 81
michaeljkoster 16:3f0efaa57a12 82 /*
mbedAustin 30:c035696b9397 83 * Start up a UDP or TCP Connection
mbedAustin 30:c035696b9397 84 * @param type 0 for UDP, 1 for TCP
mbedAustin 30:c035696b9397 85 * @param ip A string that contains the IP, no quotes
mbedAustin 30:c035696b9397 86 * @param port Numerical port number to connect to
mbedAustin 30:c035696b9397 87 * @param id number between 0-4, if defined it denotes ID to use in multimode (Default to Single connection mode with -1)
mbedAustin 30:c035696b9397 88 * @return true if sucessful, 0 if fail
michaeljkoster 16:3f0efaa57a12 89 */
mbedAustin 30:c035696b9397 90 bool start(bool type, char* ip, int port, int id = -1);
mbedAustin 30:c035696b9397 91
mbedAustin 30:c035696b9397 92 /*
mbedAustin 30:c035696b9397 93 * Legacy Start for UDP only connection in transparent mode
mbedAustin 30:c035696b9397 94 * @param ip A string that contains the IP, no quotes
mbedAustin 30:c035696b9397 95 * @param port Numerical port number to connect to
mbedAustin 30:c035696b9397 96 */
mbedAustin 31:fd0eaf273b11 97 bool startUDP(char* ip, int port);
michaeljkoster 15:37a7a56a424f 98
michaeljkoster 15:37a7a56a424f 99 /**
michaeljkoster 16:3f0efaa57a12 100 * Close a connection
michaeljkoster 15:37a7a56a424f 101 *
michaeljkoster 15:37a7a56a424f 102 * @return true if successful
michaeljkoster 15:37a7a56a424f 103 */
michaeljkoster 15:37a7a56a424f 104 bool close();
michaeljkoster 15:37a7a56a424f 105
michaeljkoster 15:37a7a56a424f 106 /**
michaeljkoster 14:4d1128f72e00 107 * Return the IP address
michaeljkoster 14:4d1128f72e00 108 * @return IP address as a string
michaeljkoster 14:4d1128f72e00 109 */
michaeljkoster 14:4d1128f72e00 110 char* getIPAddress();
michaeljkoster 15:37a7a56a424f 111
michaeljkoster 15:37a7a56a424f 112 /**
michaeljkoster 15:37a7a56a424f 113 * Return the IP address from host name
mbedAustin 31:fd0eaf273b11 114 * @return true on success, false on failure
michaeljkoster 15:37a7a56a424f 115 */ bool gethostbyname(const char * host, char * ip);
michaeljkoster 15:37a7a56a424f 116
michaeljkoster 14:4d1128f72e00 117 /**
samux 1:fb4494783863 118 * Reset the wifi module
samux 1:fb4494783863 119 */
samux 1:fb4494783863 120 void reset();
samux 3:9aa05e19c62e 121
screamer 5:81e264dbbf03 122 /**
samux 3:9aa05e19c62e 123 * Reboot the wifi module
samux 3:9aa05e19c62e 124 */
samux 3:9aa05e19c62e 125 bool reboot();
samux 1:fb4494783863 126
screamer 5:81e264dbbf03 127 /**
samux 1:fb4494783863 128 * Check if characters are available
samux 1:fb4494783863 129 *
samux 1:fb4494783863 130 * @return number of available characters
samux 1:fb4494783863 131 */
samux 1:fb4494783863 132 int readable();
samux 1:fb4494783863 133
screamer 5:81e264dbbf03 134 /**
samux 1:fb4494783863 135 * Check if characters are available
samux 1:fb4494783863 136 *
samux 1:fb4494783863 137 * @return number of available characters
samux 1:fb4494783863 138 */
samux 1:fb4494783863 139 int writeable();
samux 1:fb4494783863 140
screamer 5:81e264dbbf03 141 /**
samux 1:fb4494783863 142 * Read a character
samux 1:fb4494783863 143 *
samux 1:fb4494783863 144 * @return the character read
samux 1:fb4494783863 145 */
samux 1:fb4494783863 146 char getc();
samux 1:fb4494783863 147
screamer 5:81e264dbbf03 148 /**
samux 1:fb4494783863 149 * Write a character
samux 1:fb4494783863 150 *
samux 1:fb4494783863 151 * @param the character which will be written
samux 1:fb4494783863 152 */
samux 1:fb4494783863 153 int putc(char c);
samux 1:fb4494783863 154
screamer 5:81e264dbbf03 155 /**
michaeljkoster 15:37a7a56a424f 156 * Flush the buffer
michaeljkoster 15:37a7a56a424f 157 */
michaeljkoster 15:37a7a56a424f 158 void flush();
michaeljkoster 15:37a7a56a424f 159
michaeljkoster 15:37a7a56a424f 160 /**
mbedAustin 28:91e65e22e63a 161 * Send a command to the wifi module. Check if the module is in command mode. If not enter in command mode
michaeljkoster 15:37a7a56a424f 162 *
michaeljkoster 15:37a7a56a424f 163 * @param str string to be sent
michaeljkoster 15:37a7a56a424f 164 * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
michaeljkoster 15:37a7a56a424f 165 * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
samux 1:fb4494783863 166 *
screamer 6:5176e0864078 167 * @return true if successful
samux 1:fb4494783863 168 */
michaeljkoster 15:37a7a56a424f 169 bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
michaeljkoster 15:37a7a56a424f 170
screamer 5:81e264dbbf03 171 /**
samux 1:fb4494783863 172 * Send a string to the wifi module by serial port. This function desactivates the user interrupt handler when a character is received to analyze the response from the wifi module.
samux 1:fb4494783863 173 * Useful to send a command to the module and wait a response.
samux 1:fb4494783863 174 *
samux 1:fb4494783863 175 *
samux 1:fb4494783863 176 * @param str string to be sent
samux 1:fb4494783863 177 * @param len string length
samux 1:fb4494783863 178 * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
samux 1:fb4494783863 179 * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
samux 1:fb4494783863 180 *
samux 1:fb4494783863 181 * @return true if ACK has been found in the response from the wifi module. False otherwise or if there is no response in 5s.
samux 1:fb4494783863 182 */
michaeljkoster 16:3f0efaa57a12 183 int send(const char * buf, int len);
samux 1:fb4494783863 184
michaeljkoster 13:41098c907200 185 static ESP8266 * getInstance() {
samux 1:fb4494783863 186 return inst;
samux 1:fb4494783863 187 };
samux 1:fb4494783863 188
samux 1:fb4494783863 189 protected:
mbedAustin 28:91e65e22e63a 190 RawSerial wifi;
samux 1:fb4494783863 191 DigitalOut reset_pin;
samux 1:fb4494783863 192 char phrase[30];
samux 1:fb4494783863 193 char ssid[30];
michaeljkoster 14:4d1128f72e00 194 char ipString[20];
michaeljkoster 13:41098c907200 195 CircBuffer<char> buf_ESP8266;
samux 1:fb4494783863 196
michaeljkoster 13:41098c907200 197 static ESP8266 * inst;
samux 1:fb4494783863 198
samux 1:fb4494783863 199 void attach_rx(bool null);
samux 1:fb4494783863 200 void handler_rx(void);
samux 1:fb4494783863 201
samux 1:fb4494783863 202
samux 1:fb4494783863 203 typedef struct STATE {
samux 1:fb4494783863 204 bool associated;
michaeljkoster 22:c4360e61486a 205 bool cmdMode;
samux 1:fb4494783863 206 } State;
samux 1:fb4494783863 207
samux 1:fb4494783863 208 State state;
samux 1:fb4494783863 209 };
samux 1:fb4494783863 210
samux 1:fb4494783863 211 #endif