Ram Gandikota / Mbed OS metronome

FRDM K64F Metronome

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

Committer:
ram54288
Date:
Sun May 14 18:35:07 2017 +0000
Revision:
0:a2cb7295a1f7
Initial commit

Who changed what in which revision?

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