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/WiconnectCommand.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:
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 #include "StringUtil.h"
dan_ackme 0:ea85c4bb5e1f 32
dan_ackme 0:ea85c4bb5e1f 33
dan_ackme 0:ea85c4bb5e1f 34
dan_ackme 0:ea85c4bb5e1f 35 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 36 void Wiconnect::setCommandDefaultTimeout(int timeoutMs)
dan_ackme 0:ea85c4bb5e1f 37 {
dan_ackme 0:ea85c4bb5e1f 38 defaultTimeoutMs = timeoutMs;
dan_ackme 0:ea85c4bb5e1f 39 }
dan_ackme 0:ea85c4bb5e1f 40
dan_ackme 0:ea85c4bb5e1f 41 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 42 int Wiconnect::getCommandDefaultTimeout()
dan_ackme 0:ea85c4bb5e1f 43 {
dan_ackme 0:ea85c4bb5e1f 44 return defaultTimeoutMs;
dan_ackme 0:ea85c4bb5e1f 45 }
dan_ackme 0:ea85c4bb5e1f 46
dan_ackme 0:ea85c4bb5e1f 47 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 48 char* Wiconnect::getResponseBuffer()
dan_ackme 0:ea85c4bb5e1f 49 {
dan_ackme 0:ea85c4bb5e1f 50 return internalBuffer;
dan_ackme 0:ea85c4bb5e1f 51 }
dan_ackme 0:ea85c4bb5e1f 52
dan_ackme 0:ea85c4bb5e1f 53 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 54 uint16_t Wiconnect::getLastCommandResponseLength()
dan_ackme 0:ea85c4bb5e1f 55 {
dan_ackme 0:ea85c4bb5e1f 56 CommandHeader *header = (CommandHeader*)commandHeaderBuffer;
dan_ackme 0:ea85c4bb5e1f 57 return header->response_len;
dan_ackme 0:ea85c4bb5e1f 58 }
dan_ackme 0:ea85c4bb5e1f 59
dan_ackme 0:ea85c4bb5e1f 60 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 61 const char* Wiconnect::getLastCommandResponseCodeStr()
dan_ackme 0:ea85c4bb5e1f 62 {
dan_ackme 0:ea85c4bb5e1f 63 if(!initialized)
dan_ackme 0:ea85c4bb5e1f 64 {
dan_ackme 0:ea85c4bb5e1f 65 return NULL;
dan_ackme 0:ea85c4bb5e1f 66 }
dan_ackme 0:ea85c4bb5e1f 67 static const char* const response_error_strings[] ={
dan_ackme 0:ea85c4bb5e1f 68 "Null",
dan_ackme 0:ea85c4bb5e1f 69 "Success",
dan_ackme 0:ea85c4bb5e1f 70 "Failed",
dan_ackme 0:ea85c4bb5e1f 71 "Parse error",
dan_ackme 0:ea85c4bb5e1f 72 "Unknown command",
dan_ackme 0:ea85c4bb5e1f 73 "Too few arguments",
dan_ackme 0:ea85c4bb5e1f 74 "Too many arguments",
dan_ackme 0:ea85c4bb5e1f 75 "Unknown command option",
dan_ackme 0:ea85c4bb5e1f 76 "Bad command arguments"
dan_ackme 0:ea85c4bb5e1f 77 };
dan_ackme 0:ea85c4bb5e1f 78 CommandHeader *header = (CommandHeader*)commandHeaderBuffer;
dan_ackme 0:ea85c4bb5e1f 79
dan_ackme 0:ea85c4bb5e1f 80 return response_error_strings[header->response_code];
dan_ackme 0:ea85c4bb5e1f 81 }
dan_ackme 0:ea85c4bb5e1f 82
dan_ackme 0:ea85c4bb5e1f 83
dan_ackme 0:ea85c4bb5e1f 84 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 85 WiconnectResult Wiconnect::responseToUint32(uint32_t *uint32Ptr)
dan_ackme 0:ea85c4bb5e1f 86 {
dan_ackme 0:ea85c4bb5e1f 87 CHECK_INITIALIZED();
dan_ackme 0:ea85c4bb5e1f 88 return StringUtil::strToUint32(internalBuffer, uint32Ptr) ? WICONNECT_SUCCESS : WICONNECT_RESPONSE_PARSE_ERROR;
dan_ackme 0:ea85c4bb5e1f 89 }
dan_ackme 0:ea85c4bb5e1f 90
dan_ackme 0:ea85c4bb5e1f 91
dan_ackme 0:ea85c4bb5e1f 92 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 93 WiconnectResult Wiconnect::responseToInt32(int32_t *int32Ptr)
dan_ackme 0:ea85c4bb5e1f 94 {
dan_ackme 0:ea85c4bb5e1f 95 CHECK_INITIALIZED();
dan_ackme 0:ea85c4bb5e1f 96 return StringUtil::strToInt32(internalBuffer, int32Ptr) ? WICONNECT_SUCCESS : WICONNECT_RESPONSE_PARSE_ERROR;
dan_ackme 0:ea85c4bb5e1f 97 }
dan_ackme 0:ea85c4bb5e1f 98
dan_ackme 0:ea85c4bb5e1f 99