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

internal/wiconnect/SendCommand.cpp@17:7268f365676b, 2014-08-23 (annotated)

Committer:
dan_ackme
Date:
Sat Aug 23 05:39:17 2014 -0700
Revision:
17:7268f365676b
Parent:
16:7f1d6d359787
Child:
24:e27e23297f02
Fixes and documentation updates

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
dan_ackme 0:ea85c4bb5e1f 33 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 34 WiconnectResult Wiconnect::sendCommand(const Callback &completeCallback, char *responseBuffer,
dan_ackme 0:ea85c4bb5e1f 35 int responseBufferLen, int timeoutMs, const ReaderFunc &reader, void *user,
dan_ackme 0:ea85c4bb5e1f 36 const char *cmd, va_list vaList)
dan_ackme 0:ea85c4bb5e1f 37 {
dan_ackme 0:ea85c4bb5e1f 38 // preprocessor assertion
dan_ackme 0:ea85c4bb5e1f 39 ct_assert(sizeof(commandContext) >=sizeof(CommandContext));
dan_ackme 0:ea85c4bb5e1f 40 CHECK_INITIALIZED();
dan_ackme 0:ea85c4bb5e1f 41 CHECK_NULL_BUFFER(responseBuffer);
dan_ackme 0:ea85c4bb5e1f 42 if(commandExecuting)
dan_ackme 0:ea85c4bb5e1f 43 {
dan_ackme 0:ea85c4bb5e1f 44 return checkCurrentCommand();
dan_ackme 0:ea85c4bb5e1f 45 }
dan_ackme 0:ea85c4bb5e1f 46
dan_ackme 0:ea85c4bb5e1f 47 CommandContext *context = (CommandContext*)commandContext;
dan_ackme 0:ea85c4bb5e1f 48 CommandHeader *header = (CommandHeader*)commandHeaderBuffer;
dan_ackme 0:ea85c4bb5e1f 49
dan_ackme 0:ea85c4bb5e1f 50 int len = vsnprintf(commandFormatBuffer, sizeof(commandFormatBuffer)-3, cmd, vaList);
dan_ackme 0:ea85c4bb5e1f 51
dan_ackme 0:ea85c4bb5e1f 52 if(len > (int)(sizeof(commandFormatBuffer)-3))
dan_ackme 0:ea85c4bb5e1f 53 {
dan_ackme 0:ea85c4bb5e1f 54 DEBUG_ERROR("Command overflowed: %d > %d", len, sizeof(commandFormatBuffer)-3);
dan_ackme 0:ea85c4bb5e1f 55 return WICONNECT_OVERFLOW;
dan_ackme 0:ea85c4bb5e1f 56 }
dan_ackme 0:ea85c4bb5e1f 57
dan_ackme 0:ea85c4bb5e1f 58 commandFormatBuffer[len++] = '\r';
dan_ackme 0:ea85c4bb5e1f 59 commandFormatBuffer[len++] = '\n';
dan_ackme 0:ea85c4bb5e1f 60 commandFormatBuffer[len] = 0;
dan_ackme 0:ea85c4bb5e1f 61
dan_ackme 0:ea85c4bb5e1f 62 RESET_CMD_HEADER(header);
dan_ackme 0:ea85c4bb5e1f 63
dan_ackme 0:ea85c4bb5e1f 64 memset(context, 0, sizeof(CommandContext));
dan_ackme 0:ea85c4bb5e1f 65 context->responseBuffer = responseBuffer;
dan_ackme 0:ea85c4bb5e1f 66 context->responseBufferPtr = context->responseBuffer;
dan_ackme 0:ea85c4bb5e1f 67 context->responseBufferLen = responseBufferLen;
dan_ackme 0:ea85c4bb5e1f 68 context->commandLen = len;
dan_ackme 0:ea85c4bb5e1f 69 context->commandPtr = commandFormatBuffer;
dan_ackme 0:ea85c4bb5e1f 70 context->reader = reader;
dan_ackme 0:ea85c4bb5e1f 71 context->user = user;
dan_ackme 0:ea85c4bb5e1f 72 context->timeoutMs = timeoutMs;
dan_ackme 0:ea85c4bb5e1f 73 context->callback = completeCallback;
dan_ackme 0:ea85c4bb5e1f 74 context->nonBlocking = nonBlocking;
dan_ackme 0:ea85c4bb5e1f 75
dan_ackme 0:ea85c4bb5e1f 76 DEBUG_CMD_SEND(commandFormatBuffer);
dan_ackme 0:ea85c4bb5e1f 77
dan_ackme 0:ea85c4bb5e1f 78 commandExecuting = true;
dan_ackme 0:ea85c4bb5e1f 79 flush(0);
dan_ackme 0:ea85c4bb5e1f 80 timeoutTimer.reset();
dan_ackme 0:ea85c4bb5e1f 81
dan_ackme 0:ea85c4bb5e1f 82 return checkCurrentCommand();
dan_ackme 0:ea85c4bb5e1f 83 }
dan_ackme 0:ea85c4bb5e1f 84
dan_ackme 0:ea85c4bb5e1f 85
dan_ackme 0:ea85c4bb5e1f 86 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 87 WiconnectResult Wiconnect::sendCommand(char *responseBuffer, int responseBufferLen, int timeoutMs,
dan_ackme 0:ea85c4bb5e1f 88 const ReaderFunc &reader, void *user, const char *cmd, va_list vaList)
dan_ackme 0:ea85c4bb5e1f 89 {
dan_ackme 0:ea85c4bb5e1f 90 return sendCommand(Callback(), responseBuffer, responseBufferLen, timeoutMs, reader, user, cmd, vaList);
dan_ackme 0:ea85c4bb5e1f 91 }
dan_ackme 0:ea85c4bb5e1f 92
dan_ackme 0:ea85c4bb5e1f 93 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 94 WiconnectResult Wiconnect::sendCommand(char *responseBuffer, int responseBufferLen, int timeoutMs,
dan_ackme 0:ea85c4bb5e1f 95 const ReaderFunc &reader, void *user, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 96 {
dan_ackme 0:ea85c4bb5e1f 97 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 98 va_list args;
dan_ackme 0:ea85c4bb5e1f 99 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 100 result = sendCommand(Callback(), responseBuffer, responseBufferLen, timeoutMs, reader, user, cmd, args);
dan_ackme 0:ea85c4bb5e1f 101 va_end(args);
dan_ackme 0:ea85c4bb5e1f 102 return result;
dan_ackme 0:ea85c4bb5e1f 103 }
dan_ackme 0:ea85c4bb5e1f 104
dan_ackme 0:ea85c4bb5e1f 105 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 106 WiconnectResult Wiconnect::sendCommand( int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 107 {
dan_ackme 0:ea85c4bb5e1f 108 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 109 va_list args;
dan_ackme 0:ea85c4bb5e1f 110 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 111 result = sendCommand(Callback(), internalBuffer, internalBufferSize, timeoutMs, reader, user, cmd, args);
dan_ackme 0:ea85c4bb5e1f 112 va_end(args);
dan_ackme 0:ea85c4bb5e1f 113 return result;
dan_ackme 0:ea85c4bb5e1f 114 }
dan_ackme 0:ea85c4bb5e1f 115
dan_ackme 0:ea85c4bb5e1f 116 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 117 WiconnectResult Wiconnect::sendCommand(const ReaderFunc &reader, void *user, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 118 {
dan_ackme 0:ea85c4bb5e1f 119 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 120 va_list args;
dan_ackme 0:ea85c4bb5e1f 121 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 122 result = sendCommand(Callback(), internalBuffer, internalBufferSize, defaultTimeoutMs, reader, user, cmd, args);
dan_ackme 0:ea85c4bb5e1f 123 va_end(args);
dan_ackme 0:ea85c4bb5e1f 124 return result;
dan_ackme 0:ea85c4bb5e1f 125 }
dan_ackme 0:ea85c4bb5e1f 126
dan_ackme 0:ea85c4bb5e1f 127 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 128 WiconnectResult Wiconnect::sendCommand(char *responseBuffer, int responseBufferLen, int timeoutMs, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 129 {
dan_ackme 0:ea85c4bb5e1f 130 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 131 va_list args;
dan_ackme 0:ea85c4bb5e1f 132 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 133 result = sendCommand(Callback(), responseBuffer, responseBufferLen, timeoutMs, ReaderFunc(), NULL, cmd, args);
dan_ackme 0:ea85c4bb5e1f 134 va_end(args);
dan_ackme 0:ea85c4bb5e1f 135 return result;
dan_ackme 0:ea85c4bb5e1f 136 }
dan_ackme 0:ea85c4bb5e1f 137
dan_ackme 0:ea85c4bb5e1f 138 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 139 WiconnectResult Wiconnect::sendCommand(const Callback &completeCallback, char *responseBuffer, int responseBufferLen, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 140 {
dan_ackme 0:ea85c4bb5e1f 141 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 142 va_list args;
dan_ackme 0:ea85c4bb5e1f 143 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 144 result = sendCommand(completeCallback, responseBuffer, responseBufferLen, defaultTimeoutMs, ReaderFunc(), NULL, cmd, args);
dan_ackme 0:ea85c4bb5e1f 145 va_end(args);
dan_ackme 0:ea85c4bb5e1f 146 return result;
dan_ackme 0:ea85c4bb5e1f 147 }
dan_ackme 0:ea85c4bb5e1f 148
dan_ackme 0:ea85c4bb5e1f 149 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 150 WiconnectResult Wiconnect::sendCommand(char *responseBuffer, int responseBufferLen, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 151 {
dan_ackme 0:ea85c4bb5e1f 152 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 153 va_list args;
dan_ackme 0:ea85c4bb5e1f 154 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 155 result = sendCommand(Callback(), responseBuffer, responseBufferLen, defaultTimeoutMs, ReaderFunc(), NULL, cmd, args);
dan_ackme 0:ea85c4bb5e1f 156 va_end(args);
dan_ackme 0:ea85c4bb5e1f 157 return result;
dan_ackme 0:ea85c4bb5e1f 158 }
dan_ackme 0:ea85c4bb5e1f 159
dan_ackme 0:ea85c4bb5e1f 160 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 161 WiconnectResult Wiconnect::sendCommand(const Callback &completeCallback, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 162 {
dan_ackme 0:ea85c4bb5e1f 163 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 164 va_list args;
dan_ackme 0:ea85c4bb5e1f 165 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 166 result = sendCommand(completeCallback, internalBuffer, internalBufferSize, defaultTimeoutMs, ReaderFunc(), NULL, cmd, args);
dan_ackme 0:ea85c4bb5e1f 167 va_end(args);
dan_ackme 0:ea85c4bb5e1f 168 return result;
dan_ackme 0:ea85c4bb5e1f 169 }
dan_ackme 0:ea85c4bb5e1f 170
dan_ackme 0:ea85c4bb5e1f 171 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 172 WiconnectResult Wiconnect::sendCommand(const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 173 {
dan_ackme 0:ea85c4bb5e1f 174 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 175 va_list args;
dan_ackme 0:ea85c4bb5e1f 176 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 177 result = sendCommand(Callback(), internalBuffer, internalBufferSize, defaultTimeoutMs, ReaderFunc(), NULL, cmd, args);
dan_ackme 0:ea85c4bb5e1f 178 va_end(args);
dan_ackme 0:ea85c4bb5e1f 179 return result;
dan_ackme 0:ea85c4bb5e1f 180 }
dan_ackme 0:ea85c4bb5e1f 181
dan_ackme 0:ea85c4bb5e1f 182 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 183 WiconnectResult Wiconnect::sendCommand(const Callback &completeCallback, int timeoutMs, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 184 {
dan_ackme 0:ea85c4bb5e1f 185 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 186 va_list args;
dan_ackme 0:ea85c4bb5e1f 187 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 188 result = sendCommand(completeCallback, internalBuffer, internalBufferSize, timeoutMs, ReaderFunc(), NULL, cmd, args);
dan_ackme 0:ea85c4bb5e1f 189 va_end(args);
dan_ackme 0:ea85c4bb5e1f 190 return result;
dan_ackme 0:ea85c4bb5e1f 191 }
dan_ackme 0:ea85c4bb5e1f 192
dan_ackme 0:ea85c4bb5e1f 193 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 194 WiconnectResult Wiconnect::sendCommand(int timeoutMs, const char *cmd, ...)
dan_ackme 0:ea85c4bb5e1f 195 {
dan_ackme 0:ea85c4bb5e1f 196 WiconnectResult result;
dan_ackme 0:ea85c4bb5e1f 197 va_list args;
dan_ackme 0:ea85c4bb5e1f 198 va_start(args, cmd);
dan_ackme 0:ea85c4bb5e1f 199 result = sendCommand(Callback(), internalBuffer, internalBufferSize, timeoutMs, ReaderFunc(), NULL, cmd, args);
dan_ackme 0:ea85c4bb5e1f 200 va_end(args);
dan_ackme 0:ea85c4bb5e1f 201 return result;
dan_ackme 0:ea85c4bb5e1f 202 }
dan_ackme 0:ea85c4bb5e1f 203
dan_ackme 0:ea85c4bb5e1f 204 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 205 WiconnectResult Wiconnect::sendCommand(const char *cmd, va_list vaList)
dan_ackme 0:ea85c4bb5e1f 206 {
dan_ackme 0:ea85c4bb5e1f 207 return sendCommand(Callback(), internalBuffer, internalBufferSize, defaultTimeoutMs, ReaderFunc(), NULL, cmd, vaList);
dan_ackme 0:ea85c4bb5e1f 208 }
dan_ackme 0:ea85c4bb5e1f 209