ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

NetworkJoin.cpp@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
29:b6af04b77a56
Child:
33:9b690d76eedf
increase ota timeout to be 5 seconds (instead of 1.5 sec)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 29:b6af04b77a56 1 /**
dan_ackme 29:b6af04b77a56 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 29:b6af04b77a56 3 *
dan_ackme 29:b6af04b77a56 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 29:b6af04b77a56 5 * All rights reserved.
dan_ackme 29:b6af04b77a56 6 *
dan_ackme 29:b6af04b77a56 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 29:b6af04b77a56 8 * are permitted provided that the following conditions are met:
dan_ackme 29:b6af04b77a56 9 *
dan_ackme 29:b6af04b77a56 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 29:b6af04b77a56 11 * this list of conditions and the following disclaimer.
dan_ackme 29:b6af04b77a56 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 29:b6af04b77a56 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 29:b6af04b77a56 14 * and/or other materials provided with the distribution.
dan_ackme 29:b6af04b77a56 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 29:b6af04b77a56 16 * derived from this software without specific prior written permission.
dan_ackme 29:b6af04b77a56 17 *
dan_ackme 29:b6af04b77a56 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 29:b6af04b77a56 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 29:b6af04b77a56 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 29:b6af04b77a56 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 29:b6af04b77a56 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 29:b6af04b77a56 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 29:b6af04b77a56 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 29:b6af04b77a56 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 29:b6af04b77a56 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 29:b6af04b77a56 27 * OF SUCH DAMAGE.
dan_ackme 29:b6af04b77a56 28 */
dan_ackme 29:b6af04b77a56 29 #include "Wiconnect.h"
dan_ackme 29:b6af04b77a56 30 #include "internal/common.h"
dan_ackme 29:b6af04b77a56 31
dan_ackme 29:b6af04b77a56 32 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 33 WiconnectResult NetworkInterface::join(const char* ssid, const char *password, const Callback &completeHandler_)
dan_ackme 29:b6af04b77a56 34 {
dan_ackme 29:b6af04b77a56 35 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 29:b6af04b77a56 36
dan_ackme 29:b6af04b77a56 37 enum
dan_ackme 29:b6af04b77a56 38 {
dan_ackme 29:b6af04b77a56 39 FS_SET_SSID,
dan_ackme 29:b6af04b77a56 40 FS_SET_PASSWORD,
dan_ackme 29:b6af04b77a56 41 FS_NETWORK_UP,
dan_ackme 29:b6af04b77a56 42 FS_GET_STATUS
dan_ackme 29:b6af04b77a56 43 };
dan_ackme 29:b6af04b77a56 44
dan_ackme 29:b6af04b77a56 45 CHECK_CALLBACK_AVAILABLE(completeHandler_);
dan_ackme 29:b6af04b77a56 46
dan_ackme 29:b6af04b77a56 47 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 48
dan_ackme 29:b6af04b77a56 49 if(wiconnect->internalProcessingState == FS_SET_SSID)
dan_ackme 29:b6af04b77a56 50 {
dan_ackme 29:b6af04b77a56 51 if(ssid == NULL ||
dan_ackme 29:b6af04b77a56 52 WICONNECT_SUCCEEDED(result, wiconnect->sendCommand("set wlan.ssid %s", ssid)))
dan_ackme 29:b6af04b77a56 53 {
dan_ackme 29:b6af04b77a56 54 wiconnect->internalProcessingState = FS_SET_PASSWORD;
dan_ackme 29:b6af04b77a56 55 }
dan_ackme 29:b6af04b77a56 56 }
dan_ackme 29:b6af04b77a56 57
dan_ackme 29:b6af04b77a56 58 if(wiconnect->internalProcessingState == FS_SET_PASSWORD)
dan_ackme 29:b6af04b77a56 59 {
dan_ackme 29:b6af04b77a56 60 if(password == NULL || *password == 0 ||
dan_ackme 29:b6af04b77a56 61 WICONNECT_SUCCEEDED(result, wiconnect->sendCommand("set wlan.passkey %s", password)))
dan_ackme 29:b6af04b77a56 62 {
dan_ackme 29:b6af04b77a56 63 wiconnect->internalProcessingState = FS_NETWORK_UP;
dan_ackme 29:b6af04b77a56 64 }
dan_ackme 29:b6af04b77a56 65 }
dan_ackme 29:b6af04b77a56 66
dan_ackme 29:b6af04b77a56 67 if(wiconnect->internalProcessingState == FS_NETWORK_UP)
dan_ackme 29:b6af04b77a56 68 {
dan_ackme 29:b6af04b77a56 69 if(WICONNECT_SUCCEEDED(result, wiconnect->sendCommand("network_up")))
dan_ackme 29:b6af04b77a56 70 {
dan_ackme 29:b6af04b77a56 71 if(!completeHandler_.isValid())
dan_ackme 29:b6af04b77a56 72 {
dan_ackme 29:b6af04b77a56 73 wiconnect->internalProcessingState = FS_GET_STATUS;
dan_ackme 29:b6af04b77a56 74 }
dan_ackme 29:b6af04b77a56 75 #ifdef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 29:b6af04b77a56 76 else
dan_ackme 29:b6af04b77a56 77 {
dan_ackme 29:b6af04b77a56 78 monitorTimer.stop();
dan_ackme 29:b6af04b77a56 79 completeHandler = completeHandler_;
dan_ackme 29:b6af04b77a56 80 monitorTimer.start(this, &NetworkInterface::joinStatusMonitor, 1000);
dan_ackme 29:b6af04b77a56 81 }
dan_ackme 29:b6af04b77a56 82 #endif
dan_ackme 29:b6af04b77a56 83 }
dan_ackme 29:b6af04b77a56 84 }
dan_ackme 29:b6af04b77a56 85
dan_ackme 29:b6af04b77a56 86 if(wiconnect->internalProcessingState == FS_GET_STATUS)
dan_ackme 29:b6af04b77a56 87 {
dan_ackme 29:b6af04b77a56 88 #define MAX_JOIN_TIME 30000
dan_ackme 29:b6af04b77a56 89 TimeoutTimer timeout;
dan_ackme 29:b6af04b77a56 90
dan_ackme 29:b6af04b77a56 91 status_loop:
dan_ackme 29:b6af04b77a56 92 if(WICONNECT_SUCCEEDED(result, wiconnect->sendCommand("get wlan.join.result")))
dan_ackme 29:b6af04b77a56 93 {
dan_ackme 29:b6af04b77a56 94 int32_t status;
dan_ackme 29:b6af04b77a56 95 if(!WICONNECT_FAILED(result, wiconnect->responseToInt32(&status)))
dan_ackme 29:b6af04b77a56 96 {
dan_ackme 29:b6af04b77a56 97 if((NetworkJoinResult)status == NETWORK_JOIN_RESULT_JOINING)
dan_ackme 29:b6af04b77a56 98 {
dan_ackme 29:b6af04b77a56 99 if(timeout.timedOut(MAX_JOIN_TIME))
dan_ackme 29:b6af04b77a56 100 {
dan_ackme 29:b6af04b77a56 101 result = WICONNECT_TIMEOUT;
dan_ackme 29:b6af04b77a56 102 }
dan_ackme 29:b6af04b77a56 103 else if(!wiconnect->nonBlocking)
dan_ackme 29:b6af04b77a56 104 {
dan_ackme 29:b6af04b77a56 105 goto status_loop;
dan_ackme 29:b6af04b77a56 106 }
dan_ackme 29:b6af04b77a56 107 else
dan_ackme 29:b6af04b77a56 108 {
dan_ackme 29:b6af04b77a56 109 result = WICONNECT_PROCESSING;
dan_ackme 29:b6af04b77a56 110 }
dan_ackme 29:b6af04b77a56 111 }
dan_ackme 29:b6af04b77a56 112 else
dan_ackme 29:b6af04b77a56 113 {
dan_ackme 29:b6af04b77a56 114 result = ((NetworkJoinResult)status == NETWORK_JOIN_RESULT_SUCCESS) ? WICONNECT_SUCCESS : WICONNECT_NOT_CONNECTED;
dan_ackme 29:b6af04b77a56 115 }
dan_ackme 29:b6af04b77a56 116 }
dan_ackme 29:b6af04b77a56 117 }
dan_ackme 29:b6af04b77a56 118 }
dan_ackme 29:b6af04b77a56 119
dan_ackme 29:b6af04b77a56 120 CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 121
dan_ackme 29:b6af04b77a56 122 return result;
dan_ackme 29:b6af04b77a56 123 }
dan_ackme 29:b6af04b77a56 124
dan_ackme 29:b6af04b77a56 125
dan_ackme 29:b6af04b77a56 126
dan_ackme 29:b6af04b77a56 127 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 128 WiconnectResult NetworkInterface::leave()
dan_ackme 29:b6af04b77a56 129 {
dan_ackme 29:b6af04b77a56 130 WiconnectResult result;
dan_ackme 29:b6af04b77a56 131
dan_ackme 29:b6af04b77a56 132 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 133
dan_ackme 29:b6af04b77a56 134 #ifdef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 29:b6af04b77a56 135 monitorTimer.stop();
dan_ackme 29:b6af04b77a56 136 #endif
dan_ackme 29:b6af04b77a56 137 result = wiconnect->sendCommand("network_down");
dan_ackme 29:b6af04b77a56 138
dan_ackme 29:b6af04b77a56 139 CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 140
dan_ackme 29:b6af04b77a56 141 return result;
dan_ackme 29:b6af04b77a56 142 }
dan_ackme 29:b6af04b77a56 143
dan_ackme 29:b6af04b77a56 144
dan_ackme 29:b6af04b77a56 145 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 146 WiconnectResult NetworkInterface::getNetworkStatus(NetworkStatus *statusPtr)
dan_ackme 29:b6af04b77a56 147 {
dan_ackme 29:b6af04b77a56 148 WiconnectResult result;
dan_ackme 29:b6af04b77a56 149
dan_ackme 29:b6af04b77a56 150 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 151
dan_ackme 29:b6af04b77a56 152 if(WICONNECT_SUCCEEDED(result, wiconnect->sendCommand("get network.status")))
dan_ackme 29:b6af04b77a56 153 {
dan_ackme 29:b6af04b77a56 154 int32_t status;
dan_ackme 29:b6af04b77a56 155 if(!WICONNECT_FAILED(result, wiconnect->responseToInt32(&status)))
dan_ackme 29:b6af04b77a56 156 {
dan_ackme 29:b6af04b77a56 157 if(status != NETWORK_STATUS_DOWN)
dan_ackme 29:b6af04b77a56 158 {
dan_ackme 29:b6af04b77a56 159 #ifdef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 29:b6af04b77a56 160 monitorTimer.stop();
dan_ackme 29:b6af04b77a56 161 #endif
dan_ackme 29:b6af04b77a56 162 }
dan_ackme 29:b6af04b77a56 163 *statusPtr = (NetworkStatus)status;
dan_ackme 29:b6af04b77a56 164 }
dan_ackme 29:b6af04b77a56 165 }
dan_ackme 29:b6af04b77a56 166
dan_ackme 29:b6af04b77a56 167 CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 168
dan_ackme 29:b6af04b77a56 169 return result;
dan_ackme 29:b6af04b77a56 170 }
dan_ackme 29:b6af04b77a56 171
dan_ackme 29:b6af04b77a56 172 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 173 WiconnectResult NetworkInterface::getNetworkJoinResult(NetworkJoinResult *joinResultPtr)
dan_ackme 29:b6af04b77a56 174 {
dan_ackme 29:b6af04b77a56 175 WiconnectResult result;
dan_ackme 29:b6af04b77a56 176
dan_ackme 29:b6af04b77a56 177 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 178
dan_ackme 29:b6af04b77a56 179 if(WICONNECT_SUCCEEDED(result, wiconnect->sendCommand("get wlan.join.result")))
dan_ackme 29:b6af04b77a56 180 {
dan_ackme 29:b6af04b77a56 181 int32_t status;
dan_ackme 29:b6af04b77a56 182 if(!WICONNECT_FAILED(result, wiconnect->responseToInt32(&status)))
dan_ackme 29:b6af04b77a56 183 {
dan_ackme 29:b6af04b77a56 184 if(status != NETWORK_JOIN_RESULT_JOINING)
dan_ackme 29:b6af04b77a56 185 {
dan_ackme 29:b6af04b77a56 186 #ifdef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 29:b6af04b77a56 187 monitorTimer.stop();
dan_ackme 29:b6af04b77a56 188 #endif
dan_ackme 29:b6af04b77a56 189 }
dan_ackme 29:b6af04b77a56 190 *joinResultPtr = (NetworkJoinResult)status;
dan_ackme 29:b6af04b77a56 191 }
dan_ackme 29:b6af04b77a56 192 }
dan_ackme 29:b6af04b77a56 193
dan_ackme 29:b6af04b77a56 194 CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 195
dan_ackme 29:b6af04b77a56 196 return result;
dan_ackme 29:b6af04b77a56 197 }
dan_ackme 29:b6af04b77a56 198
dan_ackme 29:b6af04b77a56 199 #ifdef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 29:b6af04b77a56 200
dan_ackme 29:b6af04b77a56 201
dan_ackme 29:b6af04b77a56 202 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 203 // this is called every 1s by the monitorTimer
dan_ackme 29:b6af04b77a56 204 void NetworkInterface::joinStatusMonitor()
dan_ackme 29:b6af04b77a56 205 {
dan_ackme 29:b6af04b77a56 206 static char responseBuffer[4];
dan_ackme 29:b6af04b77a56 207 static uint8_t cmdBuffer[sizeof(QueuedCommand)];
dan_ackme 29:b6af04b77a56 208 QueuedCommand *cmd = (QueuedCommand*)cmdBuffer;
dan_ackme 29:b6af04b77a56 209
dan_ackme 29:b6af04b77a56 210 monitorTimer.stop();
dan_ackme 29:b6af04b77a56 211
dan_ackme 29:b6af04b77a56 212 *cmd = QueuedCommand(sizeof(responseBuffer), responseBuffer, "get wlan.join.result");
dan_ackme 29:b6af04b77a56 213
dan_ackme 29:b6af04b77a56 214 wiconnect->enqueueCommand(cmd, Callback(this, &NetworkInterface::joinStatusCheckCallback));
dan_ackme 29:b6af04b77a56 215 }
dan_ackme 29:b6af04b77a56 216
dan_ackme 29:b6af04b77a56 217 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 218 // this is called on the completion of the 'get'wlan.join.result' command above
dan_ackme 29:b6af04b77a56 219 void NetworkInterface::joinStatusCheckCallback(WiconnectResult result, void *arg1, void *arg2)
dan_ackme 29:b6af04b77a56 220 {
dan_ackme 29:b6af04b77a56 221 bool isComplete = false;
dan_ackme 29:b6af04b77a56 222 NetworkJoinResult joinResult = NETWORK_JOIN_RESULT_NONE;
dan_ackme 29:b6af04b77a56 223
dan_ackme 29:b6af04b77a56 224 QueuedCommand *cmd = (QueuedCommand*)arg1;
dan_ackme 29:b6af04b77a56 225
dan_ackme 29:b6af04b77a56 226 if(result == WICONNECT_SUCCESS)
dan_ackme 29:b6af04b77a56 227 {
dan_ackme 29:b6af04b77a56 228 int32_t status;
dan_ackme 29:b6af04b77a56 229 if(!StringUtil::strToInt32(cmd->responseBuffer, &status))
dan_ackme 29:b6af04b77a56 230 {
dan_ackme 29:b6af04b77a56 231 result = WICONNECT_RESPONSE_PARSE_ERROR;
dan_ackme 29:b6af04b77a56 232 }
dan_ackme 29:b6af04b77a56 233 else if((NetworkJoinResult)status != NETWORK_JOIN_RESULT_JOINING)
dan_ackme 29:b6af04b77a56 234 {
dan_ackme 29:b6af04b77a56 235 isComplete = true;
dan_ackme 29:b6af04b77a56 236 joinResult = (NetworkJoinResult)status;
dan_ackme 29:b6af04b77a56 237 result = (joinResult == NETWORK_JOIN_RESULT_SUCCESS) ? WICONNECT_SUCCESS : WICONNECT_NOT_CONNECTED;
dan_ackme 29:b6af04b77a56 238 }
dan_ackme 29:b6af04b77a56 239 }
dan_ackme 29:b6af04b77a56 240
dan_ackme 29:b6af04b77a56 241 if(isComplete || result != WICONNECT_SUCCESS)
dan_ackme 29:b6af04b77a56 242 {
dan_ackme 29:b6af04b77a56 243 completeHandler.call(result, (void*)joinResult, NULL);
dan_ackme 29:b6af04b77a56 244 }
dan_ackme 29:b6af04b77a56 245 else
dan_ackme 29:b6af04b77a56 246 {
dan_ackme 29:b6af04b77a56 247 monitorTimer.start(this, &NetworkInterface::joinStatusMonitor, 1000);
dan_ackme 29:b6af04b77a56 248 }
dan_ackme 29:b6af04b77a56 249 }
dan_ackme 29:b6af04b77a56 250
dan_ackme 29:b6af04b77a56 251 #endif