Ram Gandikota / Mbed OS ABCD

A metronome using the FRDM K64F board

easy-connect/esp8266-driver/ESP8266Interface.cpp@0:a7a43371b306, 2017-05-14 (annotated)

Committer:
ram54288
Date:
Sun May 14 18:40:18 2017 +0000
Revision:
0:a7a43371b306
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ram54288 0:a7a43371b306 1 /* ESP8266 implementation of NetworkInterfaceAPI
ram54288 0:a7a43371b306 2 * Copyright (c) 2015 ARM Limited
ram54288 0:a7a43371b306 3 *
ram54288 0:a7a43371b306 4 * Licensed under the Apache License, Version 2.0 (the "License");
ram54288 0:a7a43371b306 5 * you may not use this file except in compliance with the License.
ram54288 0:a7a43371b306 6 * You may obtain a copy of the License at
ram54288 0:a7a43371b306 7 *
ram54288 0:a7a43371b306 8 * http://www.apache.org/licenses/LICENSE-2.0
ram54288 0:a7a43371b306 9 *
ram54288 0:a7a43371b306 10 * Unless required by applicable law or agreed to in writing, software
ram54288 0:a7a43371b306 11 * distributed under the License is distributed on an "AS IS" BASIS,
ram54288 0:a7a43371b306 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ram54288 0:a7a43371b306 13 * See the License for the specific language governing permissions and
ram54288 0:a7a43371b306 14 * limitations under the License.
ram54288 0:a7a43371b306 15 */
ram54288 0:a7a43371b306 16
ram54288 0:a7a43371b306 17 #include <string.h>
ram54288 0:a7a43371b306 18 #include "ESP8266Interface.h"
ram54288 0:a7a43371b306 19
ram54288 0:a7a43371b306 20 // Various timeouts for different ESP8266 operations
ram54288 0:a7a43371b306 21 #define ESP8266_CONNECT_TIMEOUT 15000
ram54288 0:a7a43371b306 22 #define ESP8266_SEND_TIMEOUT 500
ram54288 0:a7a43371b306 23 #define ESP8266_RECV_TIMEOUT 0
ram54288 0:a7a43371b306 24 #define ESP8266_MISC_TIMEOUT 500
ram54288 0:a7a43371b306 25
ram54288 0:a7a43371b306 26 // ESP8266Interface implementation
ram54288 0:a7a43371b306 27 ESP8266Interface::ESP8266Interface(PinName tx, PinName rx, bool debug)
ram54288 0:a7a43371b306 28 : _esp(tx, rx, debug)
ram54288 0:a7a43371b306 29 {
ram54288 0:a7a43371b306 30 memset(_ids, 0, sizeof(_ids));
ram54288 0:a7a43371b306 31 memset(_cbs, 0, sizeof(_cbs));
ram54288 0:a7a43371b306 32
ram54288 0:a7a43371b306 33 _esp.attach(this, &ESP8266Interface::event);
ram54288 0:a7a43371b306 34 }
ram54288 0:a7a43371b306 35
ram54288 0:a7a43371b306 36 int ESP8266Interface::connect(const char *ssid, const char *pass, nsapi_security_t security,
ram54288 0:a7a43371b306 37 uint8_t channel)
ram54288 0:a7a43371b306 38 {
ram54288 0:a7a43371b306 39 if (channel != 0) {
ram54288 0:a7a43371b306 40 return NSAPI_ERROR_UNSUPPORTED;
ram54288 0:a7a43371b306 41 }
ram54288 0:a7a43371b306 42
ram54288 0:a7a43371b306 43 set_credentials(ssid, pass, security);
ram54288 0:a7a43371b306 44 return connect();
ram54288 0:a7a43371b306 45 }
ram54288 0:a7a43371b306 46
ram54288 0:a7a43371b306 47 int ESP8266Interface::connect()
ram54288 0:a7a43371b306 48 {
ram54288 0:a7a43371b306 49 _esp.setTimeout(ESP8266_CONNECT_TIMEOUT);
ram54288 0:a7a43371b306 50
ram54288 0:a7a43371b306 51 if (!_esp.startup(3)) {
ram54288 0:a7a43371b306 52 return NSAPI_ERROR_DEVICE_ERROR;
ram54288 0:a7a43371b306 53 }
ram54288 0:a7a43371b306 54
ram54288 0:a7a43371b306 55 if (!_esp.dhcp(true, 1)) {
ram54288 0:a7a43371b306 56 return NSAPI_ERROR_DHCP_FAILURE;
ram54288 0:a7a43371b306 57 }
ram54288 0:a7a43371b306 58
ram54288 0:a7a43371b306 59 if (!_esp.connect(ap_ssid, ap_pass)) {
ram54288 0:a7a43371b306 60 return NSAPI_ERROR_NO_CONNECTION;
ram54288 0:a7a43371b306 61 }
ram54288 0:a7a43371b306 62
ram54288 0:a7a43371b306 63 if (!_esp.getIPAddress()) {
ram54288 0:a7a43371b306 64 return NSAPI_ERROR_DHCP_FAILURE;
ram54288 0:a7a43371b306 65 }
ram54288 0:a7a43371b306 66
ram54288 0:a7a43371b306 67 return NSAPI_ERROR_OK;
ram54288 0:a7a43371b306 68 }
ram54288 0:a7a43371b306 69
ram54288 0:a7a43371b306 70 int ESP8266Interface::set_credentials(const char *ssid, const char *pass, nsapi_security_t security)
ram54288 0:a7a43371b306 71 {
ram54288 0:a7a43371b306 72 memset(ap_ssid, 0, sizeof(ap_ssid));
ram54288 0:a7a43371b306 73 strncpy(ap_ssid, ssid, sizeof(ap_ssid));
ram54288 0:a7a43371b306 74
ram54288 0:a7a43371b306 75 memset(ap_pass, 0, sizeof(ap_pass));
ram54288 0:a7a43371b306 76 strncpy(ap_pass, pass, sizeof(ap_pass));
ram54288 0:a7a43371b306 77
ram54288 0:a7a43371b306 78 ap_sec = security;
ram54288 0:a7a43371b306 79
ram54288 0:a7a43371b306 80 return 0;
ram54288 0:a7a43371b306 81 }
ram54288 0:a7a43371b306 82
ram54288 0:a7a43371b306 83 int ESP8266Interface::set_channel(uint8_t channel)
ram54288 0:a7a43371b306 84 {
ram54288 0:a7a43371b306 85 return NSAPI_ERROR_UNSUPPORTED;
ram54288 0:a7a43371b306 86 }
ram54288 0:a7a43371b306 87
ram54288 0:a7a43371b306 88
ram54288 0:a7a43371b306 89 int ESP8266Interface::disconnect()
ram54288 0:a7a43371b306 90 {
ram54288 0:a7a43371b306 91 _esp.setTimeout(ESP8266_MISC_TIMEOUT);
ram54288 0:a7a43371b306 92
ram54288 0:a7a43371b306 93 if (!_esp.disconnect()) {
ram54288 0:a7a43371b306 94 return NSAPI_ERROR_DEVICE_ERROR;
ram54288 0:a7a43371b306 95 }
ram54288 0:a7a43371b306 96
ram54288 0:a7a43371b306 97 return NSAPI_ERROR_OK;
ram54288 0:a7a43371b306 98 }
ram54288 0:a7a43371b306 99
ram54288 0:a7a43371b306 100 const char *ESP8266Interface::get_ip_address()
ram54288 0:a7a43371b306 101 {
ram54288 0:a7a43371b306 102 return _esp.getIPAddress();
ram54288 0:a7a43371b306 103 }
ram54288 0:a7a43371b306 104
ram54288 0:a7a43371b306 105 const char *ESP8266Interface::get_mac_address()
ram54288 0:a7a43371b306 106 {
ram54288 0:a7a43371b306 107 return _esp.getMACAddress();
ram54288 0:a7a43371b306 108 }
ram54288 0:a7a43371b306 109
ram54288 0:a7a43371b306 110 const char *ESP8266Interface::get_gateway()
ram54288 0:a7a43371b306 111 {
ram54288 0:a7a43371b306 112 return _esp.getGateway();
ram54288 0:a7a43371b306 113 }
ram54288 0:a7a43371b306 114
ram54288 0:a7a43371b306 115 const char *ESP8266Interface::get_netmask()
ram54288 0:a7a43371b306 116 {
ram54288 0:a7a43371b306 117 return _esp.getNetmask();
ram54288 0:a7a43371b306 118 }
ram54288 0:a7a43371b306 119
ram54288 0:a7a43371b306 120 int8_t ESP8266Interface::get_rssi()
ram54288 0:a7a43371b306 121 {
ram54288 0:a7a43371b306 122 return _esp.getRSSI();
ram54288 0:a7a43371b306 123 }
ram54288 0:a7a43371b306 124
ram54288 0:a7a43371b306 125 int ESP8266Interface::scan(WiFiAccessPoint *res, unsigned count)
ram54288 0:a7a43371b306 126 {
ram54288 0:a7a43371b306 127 return _esp.scan(res, count);
ram54288 0:a7a43371b306 128 }
ram54288 0:a7a43371b306 129
ram54288 0:a7a43371b306 130 struct esp8266_socket {
ram54288 0:a7a43371b306 131 int id;
ram54288 0:a7a43371b306 132 nsapi_protocol_t proto;
ram54288 0:a7a43371b306 133 bool connected;
ram54288 0:a7a43371b306 134 SocketAddress addr;
ram54288 0:a7a43371b306 135 };
ram54288 0:a7a43371b306 136
ram54288 0:a7a43371b306 137 int ESP8266Interface::socket_open(void **handle, nsapi_protocol_t proto)
ram54288 0:a7a43371b306 138 {
ram54288 0:a7a43371b306 139 // Look for an unused socket
ram54288 0:a7a43371b306 140 int id = -1;
ram54288 0:a7a43371b306 141
ram54288 0:a7a43371b306 142 for (int i = 0; i < ESP8266_SOCKET_COUNT; i++) {
ram54288 0:a7a43371b306 143 if (!_ids[i]) {
ram54288 0:a7a43371b306 144 id = i;
ram54288 0:a7a43371b306 145 _ids[i] = true;
ram54288 0:a7a43371b306 146 break;
ram54288 0:a7a43371b306 147 }
ram54288 0:a7a43371b306 148 }
ram54288 0:a7a43371b306 149
ram54288 0:a7a43371b306 150 if (id == -1) {
ram54288 0:a7a43371b306 151 return NSAPI_ERROR_NO_SOCKET;
ram54288 0:a7a43371b306 152 }
ram54288 0:a7a43371b306 153
ram54288 0:a7a43371b306 154 struct esp8266_socket *socket = new struct esp8266_socket;
ram54288 0:a7a43371b306 155 if (!socket) {
ram54288 0:a7a43371b306 156 return NSAPI_ERROR_NO_SOCKET;
ram54288 0:a7a43371b306 157 }
ram54288 0:a7a43371b306 158
ram54288 0:a7a43371b306 159 socket->id = id;
ram54288 0:a7a43371b306 160 socket->proto = proto;
ram54288 0:a7a43371b306 161 socket->connected = false;
ram54288 0:a7a43371b306 162 *handle = socket;
ram54288 0:a7a43371b306 163 return 0;
ram54288 0:a7a43371b306 164 }
ram54288 0:a7a43371b306 165
ram54288 0:a7a43371b306 166 int ESP8266Interface::socket_close(void *handle)
ram54288 0:a7a43371b306 167 {
ram54288 0:a7a43371b306 168 struct esp8266_socket *socket = (struct esp8266_socket *)handle;
ram54288 0:a7a43371b306 169 int err = 0;
ram54288 0:a7a43371b306 170 _esp.setTimeout(ESP8266_MISC_TIMEOUT);
ram54288 0:a7a43371b306 171
ram54288 0:a7a43371b306 172 if (!_esp.close(socket->id)) {
ram54288 0:a7a43371b306 173 err = NSAPI_ERROR_DEVICE_ERROR;
ram54288 0:a7a43371b306 174 }
ram54288 0:a7a43371b306 175
ram54288 0:a7a43371b306 176 _ids[socket->id] = false;
ram54288 0:a7a43371b306 177 delete socket;
ram54288 0:a7a43371b306 178 return err;
ram54288 0:a7a43371b306 179 }
ram54288 0:a7a43371b306 180
ram54288 0:a7a43371b306 181 int ESP8266Interface::socket_bind(void *handle, const SocketAddress &address)
ram54288 0:a7a43371b306 182 {
ram54288 0:a7a43371b306 183 return NSAPI_ERROR_UNSUPPORTED;
ram54288 0:a7a43371b306 184 }
ram54288 0:a7a43371b306 185
ram54288 0:a7a43371b306 186 int ESP8266Interface::socket_listen(void *handle, int backlog)
ram54288 0:a7a43371b306 187 {
ram54288 0:a7a43371b306 188 return NSAPI_ERROR_UNSUPPORTED;
ram54288 0:a7a43371b306 189 }
ram54288 0:a7a43371b306 190
ram54288 0:a7a43371b306 191 int ESP8266Interface::socket_connect(void *handle, const SocketAddress &addr)
ram54288 0:a7a43371b306 192 {
ram54288 0:a7a43371b306 193 struct esp8266_socket *socket = (struct esp8266_socket *)handle;
ram54288 0:a7a43371b306 194 _esp.setTimeout(ESP8266_MISC_TIMEOUT);
ram54288 0:a7a43371b306 195
ram54288 0:a7a43371b306 196 const char *proto = (socket->proto == NSAPI_UDP) ? "UDP" : "TCP";
ram54288 0:a7a43371b306 197 if (!_esp.open(proto, socket->id, addr.get_ip_address(), addr.get_port())) {
ram54288 0:a7a43371b306 198 return NSAPI_ERROR_DEVICE_ERROR;
ram54288 0:a7a43371b306 199 }
ram54288 0:a7a43371b306 200
ram54288 0:a7a43371b306 201 socket->connected = true;
ram54288 0:a7a43371b306 202 return 0;
ram54288 0:a7a43371b306 203 }
ram54288 0:a7a43371b306 204
ram54288 0:a7a43371b306 205 int ESP8266Interface::socket_accept(void *server, void **socket, SocketAddress *addr)
ram54288 0:a7a43371b306 206 {
ram54288 0:a7a43371b306 207 return NSAPI_ERROR_UNSUPPORTED;
ram54288 0:a7a43371b306 208 }
ram54288 0:a7a43371b306 209
ram54288 0:a7a43371b306 210 int ESP8266Interface::socket_send(void *handle, const void *data, unsigned size)
ram54288 0:a7a43371b306 211 {
ram54288 0:a7a43371b306 212 struct esp8266_socket *socket = (struct esp8266_socket *)handle;
ram54288 0:a7a43371b306 213 _esp.setTimeout(ESP8266_SEND_TIMEOUT);
ram54288 0:a7a43371b306 214
ram54288 0:a7a43371b306 215 if (!_esp.send(socket->id, data, size)) {
ram54288 0:a7a43371b306 216 return NSAPI_ERROR_DEVICE_ERROR;
ram54288 0:a7a43371b306 217 }
ram54288 0:a7a43371b306 218
ram54288 0:a7a43371b306 219 return size;
ram54288 0:a7a43371b306 220 }
ram54288 0:a7a43371b306 221
ram54288 0:a7a43371b306 222 int ESP8266Interface::socket_recv(void *handle, void *data, unsigned size)
ram54288 0:a7a43371b306 223 {
ram54288 0:a7a43371b306 224 struct esp8266_socket *socket = (struct esp8266_socket *)handle;
ram54288 0:a7a43371b306 225 _esp.setTimeout(ESP8266_RECV_TIMEOUT);
ram54288 0:a7a43371b306 226
ram54288 0:a7a43371b306 227 int32_t recv = _esp.recv(socket->id, data, size);
ram54288 0:a7a43371b306 228 if (recv < 0) {
ram54288 0:a7a43371b306 229 return NSAPI_ERROR_WOULD_BLOCK;
ram54288 0:a7a43371b306 230 }
ram54288 0:a7a43371b306 231
ram54288 0:a7a43371b306 232 return recv;
ram54288 0:a7a43371b306 233 }
ram54288 0:a7a43371b306 234
ram54288 0:a7a43371b306 235 int ESP8266Interface::socket_sendto(void *handle, const SocketAddress &addr, const void *data, unsigned size)
ram54288 0:a7a43371b306 236 {
ram54288 0:a7a43371b306 237 struct esp8266_socket *socket = (struct esp8266_socket *)handle;
ram54288 0:a7a43371b306 238
ram54288 0:a7a43371b306 239 if (socket->connected && socket->addr != addr) {
ram54288 0:a7a43371b306 240 _esp.setTimeout(ESP8266_MISC_TIMEOUT);
ram54288 0:a7a43371b306 241 if (!_esp.close(socket->id)) {
ram54288 0:a7a43371b306 242 return NSAPI_ERROR_DEVICE_ERROR;
ram54288 0:a7a43371b306 243 }
ram54288 0:a7a43371b306 244 socket->connected = false;
ram54288 0:a7a43371b306 245 }
ram54288 0:a7a43371b306 246
ram54288 0:a7a43371b306 247 if (!socket->connected) {
ram54288 0:a7a43371b306 248 int err = socket_connect(socket, addr);
ram54288 0:a7a43371b306 249 if (err < 0) {
ram54288 0:a7a43371b306 250 return err;
ram54288 0:a7a43371b306 251 }
ram54288 0:a7a43371b306 252 socket->addr = addr;
ram54288 0:a7a43371b306 253 }
ram54288 0:a7a43371b306 254
ram54288 0:a7a43371b306 255 return socket_send(socket, data, size);
ram54288 0:a7a43371b306 256 }
ram54288 0:a7a43371b306 257
ram54288 0:a7a43371b306 258 int ESP8266Interface::socket_recvfrom(void *handle, SocketAddress *addr, void *data, unsigned size)
ram54288 0:a7a43371b306 259 {
ram54288 0:a7a43371b306 260 struct esp8266_socket *socket = (struct esp8266_socket *)handle;
ram54288 0:a7a43371b306 261 int ret = socket_recv(socket, data, size);
ram54288 0:a7a43371b306 262 if (ret >= 0 && addr) {
ram54288 0:a7a43371b306 263 *addr = socket->addr;
ram54288 0:a7a43371b306 264 }
ram54288 0:a7a43371b306 265
ram54288 0:a7a43371b306 266 return ret;
ram54288 0:a7a43371b306 267 }
ram54288 0:a7a43371b306 268
ram54288 0:a7a43371b306 269 void ESP8266Interface::socket_attach(void *handle, void (*callback)(void *), void *data)
ram54288 0:a7a43371b306 270 {
ram54288 0:a7a43371b306 271 struct esp8266_socket *socket = (struct esp8266_socket *)handle;
ram54288 0:a7a43371b306 272 _cbs[socket->id].callback = callback;
ram54288 0:a7a43371b306 273 _cbs[socket->id].data = data;
ram54288 0:a7a43371b306 274 }
ram54288 0:a7a43371b306 275
ram54288 0:a7a43371b306 276 void ESP8266Interface::event() {
ram54288 0:a7a43371b306 277 for (int i = 0; i < ESP8266_SOCKET_COUNT; i++) {
ram54288 0:a7a43371b306 278 if (_cbs[i].callback) {
ram54288 0:a7a43371b306 279 _cbs[i].callback(_cbs[i].data);
ram54288 0:a7a43371b306 280 }
ram54288 0:a7a43371b306 281 }
ram54288 0:a7a43371b306 282 }