u-blox / easy-connect

Version of easy-connect with the u-blox cellular platforms C027 and C030 added.

Dependents:   HelloMQTT

esp8266-driver/ESP8266/ESP8266.h@6:304d3ba87a01, 2017-11-03 (annotated)

Committer:
RobMeades
Date:
Fri Nov 03 13:01:23 2017 +0000
Revision:
6:304d3ba87a01
Parent:
0:19aa55d66228 
Add comment concerning N2XX baud rate.

Who changed what in which revision?

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