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/WiconnectSettings.cpp@24:e27e23297f02, 2014-09-06 (annotated)

Committer:
dan_ackme
Date:
Sat Sep 06 20:34:01 2014 -0700
Revision:
24:e27e23297f02
Child:
27:b63f5a9cdefa
add api to get/set module settings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 24:e27e23297f02 1 /**
dan_ackme 24:e27e23297f02 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 24:e27e23297f02 3 *
dan_ackme 24:e27e23297f02 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 24:e27e23297f02 5 * All rights reserved.
dan_ackme 24:e27e23297f02 6 *
dan_ackme 24:e27e23297f02 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 24:e27e23297f02 8 * are permitted provided that the following conditions are met:
dan_ackme 24:e27e23297f02 9 *
dan_ackme 24:e27e23297f02 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 24:e27e23297f02 11 * this list of conditions and the following disclaimer.
dan_ackme 24:e27e23297f02 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 24:e27e23297f02 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 24:e27e23297f02 14 * and/or other materials provided with the distribution.
dan_ackme 24:e27e23297f02 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 24:e27e23297f02 16 * derived from this software without specific prior written permission.
dan_ackme 24:e27e23297f02 17 *
dan_ackme 24:e27e23297f02 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 24:e27e23297f02 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 24:e27e23297f02 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 24:e27e23297f02 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 24:e27e23297f02 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 24:e27e23297f02 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 24:e27e23297f02 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 24:e27e23297f02 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 24:e27e23297f02 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 24:e27e23297f02 27 * OF SUCH DAMAGE.
dan_ackme 24:e27e23297f02 28 */
dan_ackme 24:e27e23297f02 29
dan_ackme 24:e27e23297f02 30 #include "Wiconnect.h"
dan_ackme 24:e27e23297f02 31 #include "internal/common.h"
dan_ackme 24:e27e23297f02 32
dan_ackme 24:e27e23297f02 33
dan_ackme 24:e27e23297f02 34 #define _CHECK_CLEANUP_COMMAND() \
dan_ackme 24:e27e23297f02 35 if(result != WICONNECT_PROCESSING) \
dan_ackme 24:e27e23297f02 36 { \
dan_ackme 24:e27e23297f02 37 internalProcessingState = 0; \
dan_ackme 24:e27e23297f02 38 currentCommandId = NULL; \
dan_ackme 24:e27e23297f02 39 }
dan_ackme 24:e27e23297f02 40
dan_ackme 24:e27e23297f02 41 #define _CHECK_OTHER_COMMAND_EXECUTING() \
dan_ackme 24:e27e23297f02 42 { \
dan_ackme 24:e27e23297f02 43 static const volatile uint8_t __funcId = 0; \
dan_ackme 24:e27e23297f02 44 if(currentCommandId == NULL) \
dan_ackme 24:e27e23297f02 45 { \
dan_ackme 24:e27e23297f02 46 currentCommandId = (void*)&__funcId; \
dan_ackme 24:e27e23297f02 47 } \
dan_ackme 24:e27e23297f02 48 else if(currentCommandId != (void*)&__funcId) \
dan_ackme 24:e27e23297f02 49 { \
dan_ackme 24:e27e23297f02 50 return WICONNECT_ANOTHER_CMD_EXECUTING; \
dan_ackme 24:e27e23297f02 51 } \
dan_ackme 24:e27e23297f02 52 }
dan_ackme 24:e27e23297f02 53
dan_ackme 24:e27e23297f02 54
dan_ackme 24:e27e23297f02 55 static const char* const wiconnectSettingsMap[] = {
dan_ackme 24:e27e23297f02 56 "wl s m" // SETTING_WLAN_CHANNEL_MASK
dan_ackme 24:e27e23297f02 57 };
dan_ackme 24:e27e23297f02 58
dan_ackme 24:e27e23297f02 59
dan_ackme 24:e27e23297f02 60 /*************************************************************************************************/
dan_ackme 24:e27e23297f02 61 WiconnectResult Wiconnect::setSetting(WiconnectSetting setting, uint32_t value)
dan_ackme 24:e27e23297f02 62 {
dan_ackme 24:e27e23297f02 63 WiconnectResult result;
dan_ackme 24:e27e23297f02 64
dan_ackme 24:e27e23297f02 65 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 24:e27e23297f02 66
dan_ackme 24:e27e23297f02 67 result = sendCommand("set %s %u", wiconnectSettingsMap[setting], value);
dan_ackme 24:e27e23297f02 68
dan_ackme 24:e27e23297f02 69 _CHECK_CLEANUP_COMMAND();
dan_ackme 24:e27e23297f02 70
dan_ackme 24:e27e23297f02 71 return result;
dan_ackme 24:e27e23297f02 72 }
dan_ackme 24:e27e23297f02 73
dan_ackme 24:e27e23297f02 74 /*************************************************************************************************/
dan_ackme 24:e27e23297f02 75 WiconnectResult Wiconnect::setSetting(WiconnectSetting setting, const char *value)
dan_ackme 24:e27e23297f02 76 {
dan_ackme 24:e27e23297f02 77 WiconnectResult result;
dan_ackme 24:e27e23297f02 78
dan_ackme 24:e27e23297f02 79 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 24:e27e23297f02 80
dan_ackme 24:e27e23297f02 81 result = sendCommand("set %s %s", wiconnectSettingsMap[setting], value);
dan_ackme 24:e27e23297f02 82
dan_ackme 24:e27e23297f02 83 _CHECK_CLEANUP_COMMAND();
dan_ackme 24:e27e23297f02 84
dan_ackme 24:e27e23297f02 85 return result;
dan_ackme 24:e27e23297f02 86 }
dan_ackme 24:e27e23297f02 87
dan_ackme 24:e27e23297f02 88 /*************************************************************************************************/
dan_ackme 24:e27e23297f02 89 WiconnectResult Wiconnect::getSetting(WiconnectSetting setting, uint32_t *valuePtr)
dan_ackme 24:e27e23297f02 90 {
dan_ackme 24:e27e23297f02 91 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 24:e27e23297f02 92
dan_ackme 24:e27e23297f02 93
dan_ackme 24:e27e23297f02 94 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 24:e27e23297f02 95
dan_ackme 24:e27e23297f02 96 if(WICONNECT_SUCCEEDED(result, sendCommand("get %s", wiconnectSettingsMap[setting])))
dan_ackme 24:e27e23297f02 97 {
dan_ackme 24:e27e23297f02 98 result = responseToUint32(valuePtr);
dan_ackme 24:e27e23297f02 99 }
dan_ackme 24:e27e23297f02 100
dan_ackme 24:e27e23297f02 101 _CHECK_CLEANUP_COMMAND();
dan_ackme 24:e27e23297f02 102
dan_ackme 24:e27e23297f02 103 return result;
dan_ackme 24:e27e23297f02 104 }
dan_ackme 24:e27e23297f02 105
dan_ackme 24:e27e23297f02 106 /*************************************************************************************************/
dan_ackme 24:e27e23297f02 107 WiconnectResult Wiconnect::getSetting(WiconnectSetting setting, char **valuePtr)
dan_ackme 24:e27e23297f02 108 {
dan_ackme 24:e27e23297f02 109 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 24:e27e23297f02 110
dan_ackme 24:e27e23297f02 111
dan_ackme 24:e27e23297f02 112 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 24:e27e23297f02 113
dan_ackme 24:e27e23297f02 114 if(WICONNECT_SUCCEEDED(result, sendCommand("get %s", wiconnectSettingsMap[setting])))
dan_ackme 24:e27e23297f02 115 {
dan_ackme 24:e27e23297f02 116 *valuePtr = internalBuffer;
dan_ackme 24:e27e23297f02 117 }
dan_ackme 24:e27e23297f02 118
dan_ackme 24:e27e23297f02 119 _CHECK_CLEANUP_COMMAND();
dan_ackme 24:e27e23297f02 120
dan_ackme 24:e27e23297f02 121 return result;
dan_ackme 24:e27e23297f02 122 }
dan_ackme 24:e27e23297f02 123
dan_ackme 24:e27e23297f02 124 /*************************************************************************************************/
dan_ackme 24:e27e23297f02 125 WiconnectResult Wiconnect::getSetting(WiconnectSetting setting, char *valueBuffer, uint16_t valueBufferLen)
dan_ackme 24:e27e23297f02 126 {
dan_ackme 24:e27e23297f02 127 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 24:e27e23297f02 128
dan_ackme 24:e27e23297f02 129
dan_ackme 24:e27e23297f02 130 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 24:e27e23297f02 131
dan_ackme 24:e27e23297f02 132 result = sendCommand(valueBuffer, valueBufferLen, "get %s", wiconnectSettingsMap[setting]);
dan_ackme 24:e27e23297f02 133
dan_ackme 24:e27e23297f02 134 _CHECK_CLEANUP_COMMAND();
dan_ackme 24:e27e23297f02 135
dan_ackme 24:e27e23297f02 136 return result;
dan_ackme 24:e27e23297f02 137 }