Junichi Katsu / SimpleIoTBoardLib

Simple IoT Board用のライブラリです。 ESP8266ライブラリの軽量化 送信のみのソフトシリアルライブラリを含んでいます。

Dependents:   SITB_HttpGetSample SITB_IFTTTSample SITB_INA226PRC AmbientExampleSITB ... more

ESP8266InterfaceTiny/ESP8266/ESP8266.h@0:890c12951e96, 2015-11-15 (annotated)

Committer:
jksoft
Date:
Sun Nov 15 13:36:44 2015 +0000
Revision:
0:890c12951e96
??

Who changed what in which revision?

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