Duy tran / easy-connect-v16

version 1.6

Dependents:   iot_water_monitor_v2

ESP8266.h@0:9fa9929d1a8c, 2017-12-12 (annotated)

Committer:
DuyLionTran
Date:
Tue Dec 12 15:57:57 2017 +0000
Revision:
0:9fa9929d1a8c
version 1.6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
DuyLionTran 0:9fa9929d1a8c 1 /* ESP8266Interface Example
DuyLionTran 0:9fa9929d1a8c 2 * Copyright (c) 2015 ARM Limited
DuyLionTran 0:9fa9929d1a8c 3 *
DuyLionTran 0:9fa9929d1a8c 4 * Licensed under the Apache License, Version 2.0 (the "License");
DuyLionTran 0:9fa9929d1a8c 5 * you may not use this file except in compliance with the License.
DuyLionTran 0:9fa9929d1a8c 6 * You may obtain a copy of the License at
DuyLionTran 0:9fa9929d1a8c 7 *
DuyLionTran 0:9fa9929d1a8c 8 * http://www.apache.org/licenses/LICENSE-2.0
DuyLionTran 0:9fa9929d1a8c 9 *
DuyLionTran 0:9fa9929d1a8c 10 * Unless required by applicable law or agreed to in writing, software
DuyLionTran 0:9fa9929d1a8c 11 * distributed under the License is distributed on an "AS IS" BASIS,
DuyLionTran 0:9fa9929d1a8c 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
DuyLionTran 0:9fa9929d1a8c 13 * See the License for the specific language governing permissions and
DuyLionTran 0:9fa9929d1a8c 14 * limitations under the License.
DuyLionTran 0:9fa9929d1a8c 15 */
DuyLionTran 0:9fa9929d1a8c 16
DuyLionTran 0:9fa9929d1a8c 17 #ifndef ESP8266_H
DuyLionTran 0:9fa9929d1a8c 18 #define ESP8266_H
DuyLionTran 0:9fa9929d1a8c 19
DuyLionTran 0:9fa9929d1a8c 20 #include "ATCmdParser.h"
DuyLionTran 0:9fa9929d1a8c 21
DuyLionTran 0:9fa9929d1a8c 22 /** ESP8266Interface class.
DuyLionTran 0:9fa9929d1a8c 23 This is an interface to a ESP8266 radio.
DuyLionTran 0:9fa9929d1a8c 24 */
DuyLionTran 0:9fa9929d1a8c 25 class ESP8266
DuyLionTran 0:9fa9929d1a8c 26 {
DuyLionTran 0:9fa9929d1a8c 27 public:
DuyLionTran 0:9fa9929d1a8c 28 ESP8266(PinName tx, PinName rx, bool debug=false);
DuyLionTran 0:9fa9929d1a8c 29
DuyLionTran 0:9fa9929d1a8c 30 /**
DuyLionTran 0:9fa9929d1a8c 31 * Check firmware version of ESP8266
DuyLionTran 0:9fa9929d1a8c 32 *
DuyLionTran 0:9fa9929d1a8c 33 * @return integer firmware version or -1 if firmware query command gives outdated response
DuyLionTran 0:9fa9929d1a8c 34 */
DuyLionTran 0:9fa9929d1a8c 35 int get_firmware_version(void);
DuyLionTran 0:9fa9929d1a8c 36
DuyLionTran 0:9fa9929d1a8c 37 /**
DuyLionTran 0:9fa9929d1a8c 38 * Startup the ESP8266
DuyLionTran 0:9fa9929d1a8c 39 *
DuyLionTran 0:9fa9929d1a8c 40 * @param mode mode of WIFI 1-client, 2-host, 3-both
DuyLionTran 0:9fa9929d1a8c 41 * @return true only if ESP8266 was setup correctly
DuyLionTran 0:9fa9929d1a8c 42 */
DuyLionTran 0:9fa9929d1a8c 43 bool startup(int mode);
DuyLionTran 0:9fa9929d1a8c 44
DuyLionTran 0:9fa9929d1a8c 45 /**
DuyLionTran 0:9fa9929d1a8c 46 * Reset ESP8266
DuyLionTran 0:9fa9929d1a8c 47 *
DuyLionTran 0:9fa9929d1a8c 48 * @return true only if ESP8266 resets successfully
DuyLionTran 0:9fa9929d1a8c 49 */
DuyLionTran 0:9fa9929d1a8c 50 bool reset(void);
DuyLionTran 0:9fa9929d1a8c 51
DuyLionTran 0:9fa9929d1a8c 52 /**
DuyLionTran 0:9fa9929d1a8c 53 * Enable/Disable DHCP
DuyLionTran 0:9fa9929d1a8c 54 *
DuyLionTran 0:9fa9929d1a8c 55 * @param enabled DHCP enabled when true
DuyLionTran 0:9fa9929d1a8c 56 * @param mode mode of DHCP 0-softAP, 1-station, 2-both
DuyLionTran 0:9fa9929d1a8c 57 * @return true only if ESP8266 enables/disables DHCP successfully
DuyLionTran 0:9fa9929d1a8c 58 */
DuyLionTran 0:9fa9929d1a8c 59 bool dhcp(bool enabled, int mode);
DuyLionTran 0:9fa9929d1a8c 60
DuyLionTran 0:9fa9929d1a8c 61 /**
DuyLionTran 0:9fa9929d1a8c 62 * Connect ESP8266 to AP
DuyLionTran 0:9fa9929d1a8c 63 *
DuyLionTran 0:9fa9929d1a8c 64 * @param ap the name of the AP
DuyLionTran 0:9fa9929d1a8c 65 * @param passPhrase the password of AP
DuyLionTran 0:9fa9929d1a8c 66 * @return true only if ESP8266 is connected successfully
DuyLionTran 0:9fa9929d1a8c 67 */
DuyLionTran 0:9fa9929d1a8c 68 bool connect(const char *ap, const char *passPhrase);
DuyLionTran 0:9fa9929d1a8c 69
DuyLionTran 0:9fa9929d1a8c 70 /**
DuyLionTran 0:9fa9929d1a8c 71 * Disconnect ESP8266 from AP
DuyLionTran 0:9fa9929d1a8c 72 *
DuyLionTran 0:9fa9929d1a8c 73 * @return true only if ESP8266 is disconnected successfully
DuyLionTran 0:9fa9929d1a8c 74 */
DuyLionTran 0:9fa9929d1a8c 75 bool disconnect(void);
DuyLionTran 0:9fa9929d1a8c 76
DuyLionTran 0:9fa9929d1a8c 77 /**
DuyLionTran 0:9fa9929d1a8c 78 * Get the IP address of ESP8266
DuyLionTran 0:9fa9929d1a8c 79 *
DuyLionTran 0:9fa9929d1a8c 80 * @return null-teriminated IP address or null if no IP address is assigned
DuyLionTran 0:9fa9929d1a8c 81 */
DuyLionTran 0:9fa9929d1a8c 82 const char *getIPAddress(void);
DuyLionTran 0:9fa9929d1a8c 83
DuyLionTran 0:9fa9929d1a8c 84 /**
DuyLionTran 0:9fa9929d1a8c 85 * Get the MAC address of ESP8266
DuyLionTran 0:9fa9929d1a8c 86 *
DuyLionTran 0:9fa9929d1a8c 87 * @return null-terminated MAC address or null if no MAC address is assigned
DuyLionTran 0:9fa9929d1a8c 88 */
DuyLionTran 0:9fa9929d1a8c 89 const char *getMACAddress(void);
DuyLionTran 0:9fa9929d1a8c 90
DuyLionTran 0:9fa9929d1a8c 91 /** Get the local gateway
DuyLionTran 0:9fa9929d1a8c 92 *
DuyLionTran 0:9fa9929d1a8c 93 * @return Null-terminated representation of the local gateway
DuyLionTran 0:9fa9929d1a8c 94 * or null if no network mask has been recieved
DuyLionTran 0:9fa9929d1a8c 95 */
DuyLionTran 0:9fa9929d1a8c 96 const char *getGateway();
DuyLionTran 0:9fa9929d1a8c 97
DuyLionTran 0:9fa9929d1a8c 98 /** Get the local network mask
DuyLionTran 0:9fa9929d1a8c 99 *
DuyLionTran 0:9fa9929d1a8c 100 * @return Null-terminated representation of the local network mask
DuyLionTran 0:9fa9929d1a8c 101 * or null if no network mask has been recieved
DuyLionTran 0:9fa9929d1a8c 102 */
DuyLionTran 0:9fa9929d1a8c 103 const char *getNetmask();
DuyLionTran 0:9fa9929d1a8c 104
DuyLionTran 0:9fa9929d1a8c 105 /* Return RSSI for active connection
DuyLionTran 0:9fa9929d1a8c 106 *
DuyLionTran 0:9fa9929d1a8c 107 * @return Measured RSSI
DuyLionTran 0:9fa9929d1a8c 108 */
DuyLionTran 0:9fa9929d1a8c 109 int8_t getRSSI();
DuyLionTran 0:9fa9929d1a8c 110
DuyLionTran 0:9fa9929d1a8c 111 /**
DuyLionTran 0:9fa9929d1a8c 112 * Check if ESP8266 is conenected
DuyLionTran 0:9fa9929d1a8c 113 *
DuyLionTran 0:9fa9929d1a8c 114 * @return true only if the chip has an IP address
DuyLionTran 0:9fa9929d1a8c 115 */
DuyLionTran 0:9fa9929d1a8c 116 bool isConnected(void);
DuyLionTran 0:9fa9929d1a8c 117
DuyLionTran 0:9fa9929d1a8c 118 /** Scan for available networks
DuyLionTran 0:9fa9929d1a8c 119 *
DuyLionTran 0:9fa9929d1a8c 120 * @param ap Pointer to allocated array to store discovered AP
DuyLionTran 0:9fa9929d1a8c 121 * @param limit Size of allocated @a res array, or 0 to only count available AP
DuyLionTran 0:9fa9929d1a8c 122 * @return Number of entries in @a res, or if @a count was 0 number of available networks, negative on error
DuyLionTran 0:9fa9929d1a8c 123 * see @a nsapi_error
DuyLionTran 0:9fa9929d1a8c 124 */
DuyLionTran 0:9fa9929d1a8c 125 int scan(WiFiAccessPoint *res, unsigned limit);
DuyLionTran 0:9fa9929d1a8c 126
DuyLionTran 0:9fa9929d1a8c 127 /**Perform a dns query
DuyLionTran 0:9fa9929d1a8c 128 *
DuyLionTran 0:9fa9929d1a8c 129 * @param name Hostname to resolve
DuyLionTran 0:9fa9929d1a8c 130 * @param ip Buffer to store IP address
DuyLionTran 0:9fa9929d1a8c 131 * @return 0 true on success, false on failure
DuyLionTran 0:9fa9929d1a8c 132 */
DuyLionTran 0:9fa9929d1a8c 133 bool dns_lookup(const char *name, char *ip);
DuyLionTran 0:9fa9929d1a8c 134
DuyLionTran 0:9fa9929d1a8c 135 /**
DuyLionTran 0:9fa9929d1a8c 136 * Open a socketed connection
DuyLionTran 0:9fa9929d1a8c 137 *
DuyLionTran 0:9fa9929d1a8c 138 * @param type the type of socket to open "UDP" or "TCP"
DuyLionTran 0:9fa9929d1a8c 139 * @param id id to give the new socket, valid 0-4
DuyLionTran 0:9fa9929d1a8c 140 * @param port port to open connection with
DuyLionTran 0:9fa9929d1a8c 141 * @param addr the IP address of the destination
DuyLionTran 0:9fa9929d1a8c 142 * @return true only if socket opened successfully
DuyLionTran 0:9fa9929d1a8c 143 */
DuyLionTran 0:9fa9929d1a8c 144 bool open(const char *type, int id, const char* addr, int port);
DuyLionTran 0:9fa9929d1a8c 145
DuyLionTran 0:9fa9929d1a8c 146 /**
DuyLionTran 0:9fa9929d1a8c 147 * Sends data to an open socket
DuyLionTran 0:9fa9929d1a8c 148 *
DuyLionTran 0:9fa9929d1a8c 149 * @param id id of socket to send to
DuyLionTran 0:9fa9929d1a8c 150 * @param data data to be sent
DuyLionTran 0:9fa9929d1a8c 151 * @param amount amount of data to be sent - max 1024
DuyLionTran 0:9fa9929d1a8c 152 * @return true only if data sent successfully
DuyLionTran 0:9fa9929d1a8c 153 */
DuyLionTran 0:9fa9929d1a8c 154 bool send(int id, const void *data, uint32_t amount);
DuyLionTran 0:9fa9929d1a8c 155
DuyLionTran 0:9fa9929d1a8c 156 /**
DuyLionTran 0:9fa9929d1a8c 157 * Receives data from an open socket
DuyLionTran 0:9fa9929d1a8c 158 *
DuyLionTran 0:9fa9929d1a8c 159 * @param id id to receive from
DuyLionTran 0:9fa9929d1a8c 160 * @param data placeholder for returned information
DuyLionTran 0:9fa9929d1a8c 161 * @param amount number of bytes to be received
DuyLionTran 0:9fa9929d1a8c 162 * @return the number of bytes received
DuyLionTran 0:9fa9929d1a8c 163 */
DuyLionTran 0:9fa9929d1a8c 164 int32_t recv(int id, void *data, uint32_t amount);
DuyLionTran 0:9fa9929d1a8c 165
DuyLionTran 0:9fa9929d1a8c 166 /**
DuyLionTran 0:9fa9929d1a8c 167 * Closes a socket
DuyLionTran 0:9fa9929d1a8c 168 *
DuyLionTran 0:9fa9929d1a8c 169 * @param id id of socket to close, valid only 0-4
DuyLionTran 0:9fa9929d1a8c 170 * @return true only if socket is closed successfully
DuyLionTran 0:9fa9929d1a8c 171 */
DuyLionTran 0:9fa9929d1a8c 172 bool close(int id);
DuyLionTran 0:9fa9929d1a8c 173
DuyLionTran 0:9fa9929d1a8c 174 /**
DuyLionTran 0:9fa9929d1a8c 175 * Allows timeout to be changed between commands
DuyLionTran 0:9fa9929d1a8c 176 *
DuyLionTran 0:9fa9929d1a8c 177 * @param timeout_ms timeout of the connection
DuyLionTran 0:9fa9929d1a8c 178 */
DuyLionTran 0:9fa9929d1a8c 179 void setTimeout(uint32_t timeout_ms);
DuyLionTran 0:9fa9929d1a8c 180
DuyLionTran 0:9fa9929d1a8c 181 /**
DuyLionTran 0:9fa9929d1a8c 182 * Checks if data is available
DuyLionTran 0:9fa9929d1a8c 183 */
DuyLionTran 0:9fa9929d1a8c 184 bool readable();
DuyLionTran 0:9fa9929d1a8c 185
DuyLionTran 0:9fa9929d1a8c 186 /**
DuyLionTran 0:9fa9929d1a8c 187 * Checks if data can be written
DuyLionTran 0:9fa9929d1a8c 188 */
DuyLionTran 0:9fa9929d1a8c 189 bool writeable();
DuyLionTran 0:9fa9929d1a8c 190
DuyLionTran 0:9fa9929d1a8c 191 /**
DuyLionTran 0:9fa9929d1a8c 192 * Attach a function to call whenever network state has changed
DuyLionTran 0:9fa9929d1a8c 193 *
DuyLionTran 0:9fa9929d1a8c 194 * @param func A pointer to a void function, or 0 to set as none
DuyLionTran 0:9fa9929d1a8c 195 */
DuyLionTran 0:9fa9929d1a8c 196 void attach(Callback<void()> func);
DuyLionTran 0:9fa9929d1a8c 197
DuyLionTran 0:9fa9929d1a8c 198 /**
DuyLionTran 0:9fa9929d1a8c 199 * Attach a function to call whenever network state has changed
DuyLionTran 0:9fa9929d1a8c 200 *
DuyLionTran 0:9fa9929d1a8c 201 * @param obj pointer to the object to call the member function on
DuyLionTran 0:9fa9929d1a8c 202 * @param method pointer to the member function to call
DuyLionTran 0:9fa9929d1a8c 203 */
DuyLionTran 0:9fa9929d1a8c 204 template <typename T, typename M>
DuyLionTran 0:9fa9929d1a8c 205 void attach(T *obj, M method) {
DuyLionTran 0:9fa9929d1a8c 206 attach(Callback<void()>(obj, method));
DuyLionTran 0:9fa9929d1a8c 207 }
DuyLionTran 0:9fa9929d1a8c 208
DuyLionTran 0:9fa9929d1a8c 209 private:
DuyLionTran 0:9fa9929d1a8c 210 UARTSerial _serial;
DuyLionTran 0:9fa9929d1a8c 211 ATCmdParser _parser;
DuyLionTran 0:9fa9929d1a8c 212
DuyLionTran 0:9fa9929d1a8c 213 struct packet {
DuyLionTran 0:9fa9929d1a8c 214 struct packet *next;
DuyLionTran 0:9fa9929d1a8c 215 int id;
DuyLionTran 0:9fa9929d1a8c 216 uint32_t len;
DuyLionTran 0:9fa9929d1a8c 217 // data follows
DuyLionTran 0:9fa9929d1a8c 218 } *_packets, **_packets_end;
DuyLionTran 0:9fa9929d1a8c 219 void _packet_handler();
DuyLionTran 0:9fa9929d1a8c 220 bool recv_ap(nsapi_wifi_ap_t *ap);
DuyLionTran 0:9fa9929d1a8c 221
DuyLionTran 0:9fa9929d1a8c 222 char _ip_buffer[16];
DuyLionTran 0:9fa9929d1a8c 223 char _gateway_buffer[16];
DuyLionTran 0:9fa9929d1a8c 224 char _netmask_buffer[16];
DuyLionTran 0:9fa9929d1a8c 225 char _mac_buffer[18];
DuyLionTran 0:9fa9929d1a8c 226 };
DuyLionTran 0:9fa9929d1a8c 227
DuyLionTran 0:9fa9929d1a8c 228 #endif