Duy tran / easy-connect

CUSTOMIZED FOR WATER MONITOR

ESP8266.h@0:c9094fbda0bd, 2017-12-07 (annotated)

Committer:
DuyLionTran
Date:
Thu Dec 07 17:07:08 2017 +0000
Revision:
0:c9094fbda0bd
CUSTOMIZED FOR WATER MONITOR

Who changed what in which revision?

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