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

WiconnectCommand.cpp@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
refactored library layout

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