Junichi Katsu / MultiIoTBoardLib

test

Dependencies:   BME280 SB1602E

Fork of MultiIoTBoardLib by Junichi Katsu

ESP8266InterfaceTiny/ESP8266/ESP8266.h@0:bad9495b4215, 2017-07-28 (annotated)

Committer:
jksoft
Date:
Fri Jul 28 02:23:25 2017 +0000
Revision:
0:bad9495b4215
First edition

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jksoft 0:bad9495b4215 1 /* Copyright (C) 2012 mbed.org, MIT License
jksoft 0:bad9495b4215 2 *
jksoft 0:bad9495b4215 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
jksoft 0:bad9495b4215 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
jksoft 0:bad9495b4215 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
jksoft 0:bad9495b4215 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
jksoft 0:bad9495b4215 7 * furnished to do so, subject to the following conditions:
jksoft 0:bad9495b4215 8 *
jksoft 0:bad9495b4215 9 * The above copyright notice and this permission notice shall be included in all copies or
jksoft 0:bad9495b4215 10 * substantial portions of the Software.
jksoft 0:bad9495b4215 11 *
jksoft 0:bad9495b4215 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
jksoft 0:bad9495b4215 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
jksoft 0:bad9495b4215 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
jksoft 0:bad9495b4215 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jksoft 0:bad9495b4215 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
jksoft 0:bad9495b4215 17 *
jksoft 0:bad9495b4215 18 * @section DESCRIPTION
jksoft 0:bad9495b4215 19 *
jksoft 0:bad9495b4215 20 * ESP8266 serial wifi module
jksoft 0:bad9495b4215 21 *
jksoft 0:bad9495b4215 22 * Datasheet:
jksoft 0:bad9495b4215 23 *
jksoft 0:bad9495b4215 24 * http://www.electrodragon.com/w/Wi07c
jksoft 0:bad9495b4215 25 */
jksoft 0:bad9495b4215 26
jksoft 0:bad9495b4215 27 #ifndef ESP8266_H
jksoft 0:bad9495b4215 28 #define ESP8266_H
jksoft 0:bad9495b4215 29
jksoft 0:bad9495b4215 30 #include "mbed.h"
jksoft 0:bad9495b4215 31 #include "CBuffer.h"
jksoft 0:bad9495b4215 32
jksoft 0:bad9495b4215 33 #define DEFAULT_WAIT_RESP_TIMEOUT 500
jksoft 0:bad9495b4215 34 #define ESP_TCP_TYPE 1
jksoft 0:bad9495b4215 35 #define ESP_UDP_TYPE 0
jksoft 0:bad9495b4215 36 #define ESP_MBUFFE_MAX 256
jksoft 0:bad9495b4215 37
jksoft 0:bad9495b4215 38 /**
jksoft 0:bad9495b4215 39 * The ESP8266 class
jksoft 0:bad9495b4215 40 */
jksoft 0:bad9495b4215 41 class ESP8266
jksoft 0:bad9495b4215 42 {
jksoft 0:bad9495b4215 43
jksoft 0:bad9495b4215 44 public:
jksoft 0:bad9495b4215 45 /**
jksoft 0:bad9495b4215 46 * Constructor
jksoft 0:bad9495b4215 47 *
jksoft 0:bad9495b4215 48 * @param tx mbed pin to use for tx line of Serial interface
jksoft 0:bad9495b4215 49 * @param rx mbed pin to use for rx line of Serial interface
jksoft 0:bad9495b4215 50 * @param reset reset pin of the wifi module ()
jksoft 0:bad9495b4215 51 * @param ssid ssid of the network
jksoft 0:bad9495b4215 52 * @param phrase WEP, WPA or WPA2 key
jksoft 0:bad9495b4215 53 * @param baud the baudrate of the serial connection
jksoft 0:bad9495b4215 54 */
jksoft 0:bad9495b4215 55 ESP8266( PinName tx, PinName rx, PinName reset, const char * ssid, const char * phrase, uint32_t baud );
jksoft 0:bad9495b4215 56
jksoft 0:bad9495b4215 57 /**
jksoft 0:bad9495b4215 58 * Connect the wifi module to the ssid contained in the constructor.
jksoft 0:bad9495b4215 59 *
jksoft 0:bad9495b4215 60 * @return true if connected, false otherwise
jksoft 0:bad9495b4215 61 */
jksoft 0:bad9495b4215 62 bool join();
jksoft 0:bad9495b4215 63
jksoft 0:bad9495b4215 64 /**
jksoft 0:bad9495b4215 65 * Same as Join: connect to the ssid and get DHCP settings
jksoft 0:bad9495b4215 66 * @return true if successful
jksoft 0:bad9495b4215 67 */
jksoft 0:bad9495b4215 68 bool connect();
jksoft 0:bad9495b4215 69
jksoft 0:bad9495b4215 70 /**
jksoft 0:bad9495b4215 71 * Check connection to the access point
jksoft 0:bad9495b4215 72 * @return true if successful
jksoft 0:bad9495b4215 73 */
jksoft 0:bad9495b4215 74 bool is_connected();
jksoft 0:bad9495b4215 75
jksoft 0:bad9495b4215 76 /**
jksoft 0:bad9495b4215 77 * Disconnect the ESP8266 module from the access point
jksoft 0:bad9495b4215 78 *
jksoft 0:bad9495b4215 79 * @return true if successful
jksoft 0:bad9495b4215 80 */
jksoft 0:bad9495b4215 81 bool disconnect();
jksoft 0:bad9495b4215 82
jksoft 0:bad9495b4215 83 /*
jksoft 0:bad9495b4215 84 * Start up a UDP or TCP Connection
jksoft 0:bad9495b4215 85 * @param type 0 for UDP, 1 for TCP
jksoft 0:bad9495b4215 86 * @param ip A string that contains the IP, no quotes
jksoft 0:bad9495b4215 87 * @param port Numerical port number to connect to
jksoft 0:bad9495b4215 88 * @param id number between 0-4, if defined it denotes ID to use in multimode (Default to Single connection mode with -1)
jksoft 0:bad9495b4215 89 * @return true if sucessful, 0 if fail
jksoft 0:bad9495b4215 90 */
jksoft 0:bad9495b4215 91 bool start(bool type, char* ip, int port, int id = -1);
jksoft 0:bad9495b4215 92
jksoft 0:bad9495b4215 93 /*
jksoft 0:bad9495b4215 94 * Legacy Start for UDP only connection in transparent mode
jksoft 0:bad9495b4215 95 * @param ip A string that contains the IP, no quotes
jksoft 0:bad9495b4215 96 * @param id number between 0-4
jksoft 0:bad9495b4215 97 * @param port Numerical port number to connect to
jksoft 0:bad9495b4215 98 * @param length number of characters in the message being sent
jksoft 0:bad9495b4215 99 */
jksoft 0:bad9495b4215 100 bool startUDP(char* ip, int port, int id, int length);
jksoft 0:bad9495b4215 101
jksoft 0:bad9495b4215 102 /*
jksoft 0:bad9495b4215 103 * Legacy Start for UDP only connection in transparent mode
jksoft 0:bad9495b4215 104 * @param ip A string that contains the IP, no quotes
jksoft 0:bad9495b4215 105 * @param id number between 0-4
jksoft 0:bad9495b4215 106 * @param port Numerical port number to connect to
jksoft 0:bad9495b4215 107 * @param length number of characters in the message being sent
jksoft 0:bad9495b4215 108 */
jksoft 0:bad9495b4215 109 //bool startUDP(char* ip, int port, int id, int length);
jksoft 0:bad9495b4215 110
jksoft 0:bad9495b4215 111 /*
jksoft 0:bad9495b4215 112 *Starts the ESP chip as a TCP Server
jksoft 0:bad9495b4215 113 *@param port Numerical port of the server, default is 333
jksoft 0:bad9495b4215 114 */
jksoft 0:bad9495b4215 115 bool startTCPServer(int port = 333);
jksoft 0:bad9495b4215 116
jksoft 0:bad9495b4215 117 /**
jksoft 0:bad9495b4215 118 * Close a connection
jksoft 0:bad9495b4215 119 *
jksoft 0:bad9495b4215 120 * @return true if successful
jksoft 0:bad9495b4215 121 */
jksoft 0:bad9495b4215 122 bool close();
jksoft 0:bad9495b4215 123
jksoft 0:bad9495b4215 124 /**
jksoft 0:bad9495b4215 125 * Return the IP address
jksoft 0:bad9495b4215 126 * @return IP address as a string
jksoft 0:bad9495b4215 127 */
jksoft 0:bad9495b4215 128 char* getIPAddress();
jksoft 0:bad9495b4215 129
jksoft 0:bad9495b4215 130 /**
jksoft 0:bad9495b4215 131 * Return the IP address from host name
jksoft 0:bad9495b4215 132 * @return true on success, false on failure
jksoft 0:bad9495b4215 133 */
jksoft 0:bad9495b4215 134 bool gethostbyname(const char * host, char * ip);
jksoft 0:bad9495b4215 135
jksoft 0:bad9495b4215 136 /**
jksoft 0:bad9495b4215 137 * Reset the wifi module
jksoft 0:bad9495b4215 138 */
jksoft 0:bad9495b4215 139 void reset();
jksoft 0:bad9495b4215 140
jksoft 0:bad9495b4215 141 /**
jksoft 0:bad9495b4215 142 * Reboot the wifi module
jksoft 0:bad9495b4215 143 */
jksoft 0:bad9495b4215 144 bool reboot();
jksoft 0:bad9495b4215 145
jksoft 0:bad9495b4215 146 /**
jksoft 0:bad9495b4215 147 * Check if characters are available
jksoft 0:bad9495b4215 148 *
jksoft 0:bad9495b4215 149 * @return number of available characters
jksoft 0:bad9495b4215 150 */
jksoft 0:bad9495b4215 151 int readable();
jksoft 0:bad9495b4215 152
jksoft 0:bad9495b4215 153 /**
jksoft 0:bad9495b4215 154 * Check if characters are available
jksoft 0:bad9495b4215 155 *
jksoft 0:bad9495b4215 156 * @return number of available characters
jksoft 0:bad9495b4215 157 */
jksoft 0:bad9495b4215 158 int writeable();
jksoft 0:bad9495b4215 159
jksoft 0:bad9495b4215 160 /**
jksoft 0:bad9495b4215 161 * Read a character
jksoft 0:bad9495b4215 162 *
jksoft 0:bad9495b4215 163 * @return the character read
jksoft 0:bad9495b4215 164 */
jksoft 0:bad9495b4215 165 char getc();
jksoft 0:bad9495b4215 166
jksoft 0:bad9495b4215 167 /**
jksoft 0:bad9495b4215 168 * Write a character
jksoft 0:bad9495b4215 169 *
jksoft 0:bad9495b4215 170 * @param the character which will be written
jksoft 0:bad9495b4215 171 */
jksoft 0:bad9495b4215 172 int putc(char c);
jksoft 0:bad9495b4215 173
jksoft 0:bad9495b4215 174 /**
jksoft 0:bad9495b4215 175 * Flush the buffer
jksoft 0:bad9495b4215 176 */
jksoft 0:bad9495b4215 177 void flush();
jksoft 0:bad9495b4215 178
jksoft 0:bad9495b4215 179 /**
jksoft 0:bad9495b4215 180 * Send a command to the wifi module. Check if the module is in command mode. If not enter in command mode
jksoft 0:bad9495b4215 181 *
jksoft 0:bad9495b4215 182 * @param str string to be sent
jksoft 0:bad9495b4215 183 * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknowledged. (default: "NO")
jksoft 0:bad9495b4215 184 * @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)
jksoft 0:bad9495b4215 185 *
jksoft 0:bad9495b4215 186 * @return true if successful
jksoft 0:bad9495b4215 187 */
jksoft 0:bad9495b4215 188 bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
jksoft 0:bad9495b4215 189
jksoft 0:bad9495b4215 190 /**
jksoft 0:bad9495b4215 191 * 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.
jksoft 0:bad9495b4215 192 * Useful to send a command to the module and wait a response.
jksoft 0:bad9495b4215 193 *
jksoft 0:bad9495b4215 194 *
jksoft 0:bad9495b4215 195 * @param str string to be sent
jksoft 0:bad9495b4215 196 * @param len string length
jksoft 0:bad9495b4215 197 * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
jksoft 0:bad9495b4215 198 * @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)
jksoft 0:bad9495b4215 199 *
jksoft 0:bad9495b4215 200 * @return true if ACK has been found in the response from the wifi module. False otherwise or if there is no response in 5s.
jksoft 0:bad9495b4215 201 */
jksoft 0:bad9495b4215 202 int send(const char * buf, int len);
jksoft 0:bad9495b4215 203
jksoft 0:bad9495b4215 204 static ESP8266 * getInstance() {
jksoft 0:bad9495b4215 205 return inst;
jksoft 0:bad9495b4215 206 };
jksoft 0:bad9495b4215 207
jksoft 0:bad9495b4215 208 protected:
jksoft 0:bad9495b4215 209 int strfind(const char *str,const char *chkstr,int pos=0);
jksoft 0:bad9495b4215 210 char* substr(const char *str , char *outstr , int pos1 , int pos2 );
jksoft 0:bad9495b4215 211 int strcount(const char *str , char countstr );
jksoft 0:bad9495b4215 212
jksoft 0:bad9495b4215 213
jksoft 0:bad9495b4215 214 RawSerial wifi;
jksoft 0:bad9495b4215 215 DigitalOut reset_pin;
jksoft 0:bad9495b4215 216 char phrase[30];
jksoft 0:bad9495b4215 217 char ssid[30];
jksoft 0:bad9495b4215 218 char ipString[20];
jksoft 0:bad9495b4215 219 CircBuffer<char> buf_ESP8266;
jksoft 0:bad9495b4215 220
jksoft 0:bad9495b4215 221 static ESP8266 * inst;
jksoft 0:bad9495b4215 222
jksoft 0:bad9495b4215 223 void attach_rx(bool null);
jksoft 0:bad9495b4215 224 void handler_rx(void);
jksoft 0:bad9495b4215 225
jksoft 0:bad9495b4215 226
jksoft 0:bad9495b4215 227 typedef struct STATE {
jksoft 0:bad9495b4215 228 bool associated;
jksoft 0:bad9495b4215 229 bool cmdMode;
jksoft 0:bad9495b4215 230 } State;
jksoft 0:bad9495b4215 231
jksoft 0:bad9495b4215 232 State state;
jksoft 0:bad9495b4215 233 };
jksoft 0:bad9495b4215 234
jksoft 0:bad9495b4215 235 #endif