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@16:7f1d6d359787, 2014-08-13 (annotated)

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