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

Committer:
dan_ackme
Date:
Wed Aug 13 04:41:04 2014 -0700
Revision:
16:7f1d6d359787
Parent:
5:8d91a87ebba2
Child:
24:e27e23297f02
updated documentation and copyright

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 16:7f1d6d359787 1 /**
dan_ackme 16:7f1d6d359787 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 16:7f1d6d359787 3 *
dan_ackme 16:7f1d6d359787 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 16:7f1d6d359787 5 * All rights reserved.
dan_ackme 16:7f1d6d359787 6 *
dan_ackme 16:7f1d6d359787 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 16:7f1d6d359787 8 * are permitted provided that the following conditions are met:
dan_ackme 16:7f1d6d359787 9 *
dan_ackme 16:7f1d6d359787 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 16:7f1d6d359787 11 * this list of conditions and the following disclaimer.
dan_ackme 16:7f1d6d359787 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 16:7f1d6d359787 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 16:7f1d6d359787 14 * and/or other materials provided with the distribution.
dan_ackme 16:7f1d6d359787 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 16:7f1d6d359787 16 * derived from this software without specific prior written permission.
dan_ackme 16:7f1d6d359787 17 *
dan_ackme 16:7f1d6d359787 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 16:7f1d6d359787 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 16:7f1d6d359787 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 16:7f1d6d359787 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 16:7f1d6d359787 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 16:7f1d6d359787 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 16:7f1d6d359787 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 16:7f1d6d359787 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 16:7f1d6d359787 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 16:7f1d6d359787 27 * OF SUCH DAMAGE.
dan_ackme 0:ea85c4bb5e1f 28 */
dan_ackme 0:ea85c4bb5e1f 29
dan_ackme 0:ea85c4bb5e1f 30 #include "CommandCommon.h"
dan_ackme 0:ea85c4bb5e1f 31
dan_ackme 0:ea85c4bb5e1f 32 #ifdef WICONNECT_ASYNC_TIMER_ENABLED
dan_ackme 0:ea85c4bb5e1f 33
dan_ackme 0:ea85c4bb5e1f 34
dan_ackme 0:ea85c4bb5e1f 35
dan_ackme 0:ea85c4bb5e1f 36 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 37 WiconnectResult Wiconnect::enqueueCommand(QueuedCommand *command, const Callback &commandCompleteHandler)
dan_ackme 0:ea85c4bb5e1f 38 {
dan_ackme 0:ea85c4bb5e1f 39 if(commandQueue.isFull())
dan_ackme 0:ea85c4bb5e1f 40 {
dan_ackme 0:ea85c4bb5e1f 41 return WICONNECT_OVERFLOW;
dan_ackme 0:ea85c4bb5e1f 42 }
dan_ackme 0:ea85c4bb5e1f 43 command->setCompletedCallback(commandCompleteHandler);
dan_ackme 0:ea85c4bb5e1f 44 DEBUG_INFO("Queuing command: %s", command->getCommand());
dan_ackme 0:ea85c4bb5e1f 45 commandQueue.push(command);
dan_ackme 0:ea85c4bb5e1f 46 processNextQueuedCommand();
dan_ackme 0:ea85c4bb5e1f 47 return WICONNECT_SUCCESS;
dan_ackme 0:ea85c4bb5e1f 48 }
dan_ackme 0:ea85c4bb5e1f 49
dan_ackme 0:ea85c4bb5e1f 50 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 51 void Wiconnect::processNextQueuedCommand()
dan_ackme 0:ea85c4bb5e1f 52 {
dan_ackme 0:ea85c4bb5e1f 53 if(commandQueue.isEmpty())
dan_ackme 0:ea85c4bb5e1f 54 {
dan_ackme 0:ea85c4bb5e1f 55 return;
dan_ackme 0:ea85c4bb5e1f 56 }
dan_ackme 0:ea85c4bb5e1f 57 else if(commandExecuting)
dan_ackme 0:ea85c4bb5e1f 58 {
dan_ackme 0:ea85c4bb5e1f 59 return;
dan_ackme 0:ea85c4bb5e1f 60 }
dan_ackme 0:ea85c4bb5e1f 61
dan_ackme 0:ea85c4bb5e1f 62 CommandContext *context = (CommandContext*)commandContext;
dan_ackme 0:ea85c4bb5e1f 63 CommandHeader *header = (CommandHeader*)commandHeaderBuffer;
dan_ackme 0:ea85c4bb5e1f 64
dan_ackme 0:ea85c4bb5e1f 65 commandExecuting = true;
dan_ackme 0:ea85c4bb5e1f 66 currentQueuedCommand = commandQueue.pop();
dan_ackme 0:ea85c4bb5e1f 67
dan_ackme 0:ea85c4bb5e1f 68 DEBUG_INFO("Processing next cmd in queue");
dan_ackme 0:ea85c4bb5e1f 69
dan_ackme 0:ea85c4bb5e1f 70 strcpy(commandFormatBuffer, currentQueuedCommand->command);
dan_ackme 0:ea85c4bb5e1f 71
dan_ackme 0:ea85c4bb5e1f 72 RESET_CMD_HEADER(header);
dan_ackme 0:ea85c4bb5e1f 73
dan_ackme 0:ea85c4bb5e1f 74 memset(context, 0, sizeof(CommandContext));
dan_ackme 0:ea85c4bb5e1f 75 if(currentQueuedCommand->responseBufferLen > 0)
dan_ackme 0:ea85c4bb5e1f 76 {
dan_ackme 0:ea85c4bb5e1f 77 context->responseBuffer = currentQueuedCommand->responseBuffer;
dan_ackme 0:ea85c4bb5e1f 78 context->responseBufferLen = currentQueuedCommand->responseBufferLen;
dan_ackme 0:ea85c4bb5e1f 79 }
dan_ackme 0:ea85c4bb5e1f 80 else
dan_ackme 0:ea85c4bb5e1f 81 {
dan_ackme 0:ea85c4bb5e1f 82 context->responseBuffer = internalBuffer;
dan_ackme 0:ea85c4bb5e1f 83 context->responseBufferLen = internalBufferSize;
dan_ackme 0:ea85c4bb5e1f 84 }
dan_ackme 0:ea85c4bb5e1f 85
dan_ackme 0:ea85c4bb5e1f 86 context->responseBufferPtr = context->responseBuffer;
dan_ackme 0:ea85c4bb5e1f 87 context->commandLen = strlen(commandFormatBuffer);
dan_ackme 0:ea85c4bb5e1f 88 context->commandPtr = commandFormatBuffer;
dan_ackme 0:ea85c4bb5e1f 89 context->reader = currentQueuedCommand->reader;
dan_ackme 0:ea85c4bb5e1f 90 context->user = currentQueuedCommand->userData;
dan_ackme 0:ea85c4bb5e1f 91 context->timeoutMs = currentQueuedCommand->timeoutMs;
dan_ackme 0:ea85c4bb5e1f 92 context->callback = currentQueuedCommand->completeCallback;
dan_ackme 0:ea85c4bb5e1f 93 context->nonBlocking = true;
dan_ackme 0:ea85c4bb5e1f 94
dan_ackme 0:ea85c4bb5e1f 95 DEBUG_CMD_SEND(commandFormatBuffer);
dan_ackme 0:ea85c4bb5e1f 96
dan_ackme 0:ea85c4bb5e1f 97 commandExecuting = true;
dan_ackme 0:ea85c4bb5e1f 98 timeoutTimer.reset();
dan_ackme 0:ea85c4bb5e1f 99
dan_ackme 0:ea85c4bb5e1f 100 commandProcessorTimer.start(this, &Wiconnect::commandProcessingTimerHandler, commandProcessingPeriod);
dan_ackme 0:ea85c4bb5e1f 101 }
dan_ackme 0:ea85c4bb5e1f 102
dan_ackme 0:ea85c4bb5e1f 103 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 104 void Wiconnect::setCommandProcessingPeriod(uint32_t periodMs)
dan_ackme 0:ea85c4bb5e1f 105 {
dan_ackme 0:ea85c4bb5e1f 106 commandProcessingPeriod = periodMs;
dan_ackme 0:ea85c4bb5e1f 107 }
dan_ackme 0:ea85c4bb5e1f 108
dan_ackme 0:ea85c4bb5e1f 109 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 110 void Wiconnect::commandProcessingTimerHandler()
dan_ackme 0:ea85c4bb5e1f 111 {
dan_ackme 0:ea85c4bb5e1f 112 checkCurrentCommand();
dan_ackme 0:ea85c4bb5e1f 113 }
dan_ackme 0:ea85c4bb5e1f 114
dan_ackme 0:ea85c4bb5e1f 115 #endif
dan_ackme 0:ea85c4bb5e1f 116