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

WiconnectSettings.cpp@37:5ee74d72efe4, 2014-11-27 (annotated)

Committer:
dan_ackme
Date:
Thu Nov 27 01:11:12 2014 -0800
Revision:
37:5ee74d72efe4
Parent:
29:b6af04b77a56 
added saveSettings API

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 "Wiconnect.h"
dan_ackme 29:b6af04b77a56 31 #include "internal/common.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 WiconnectResult Wiconnect::setSetting(const char *settingStr, uint32_t value)
dan_ackme 29:b6af04b77a56 37 {
dan_ackme 29:b6af04b77a56 38 WiconnectResult result;
dan_ackme 29:b6af04b77a56 39
dan_ackme 29:b6af04b77a56 40 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 41
dan_ackme 29:b6af04b77a56 42 result = sendCommand("set %s %u", settingStr, value);
dan_ackme 29:b6af04b77a56 43
dan_ackme 29:b6af04b77a56 44 _CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 45
dan_ackme 29:b6af04b77a56 46 return result;
dan_ackme 29:b6af04b77a56 47 }
dan_ackme 29:b6af04b77a56 48
dan_ackme 29:b6af04b77a56 49 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 50 WiconnectResult Wiconnect::setSetting(const char *settingStr, const char *value)
dan_ackme 29:b6af04b77a56 51 {
dan_ackme 29:b6af04b77a56 52 WiconnectResult result;
dan_ackme 29:b6af04b77a56 53
dan_ackme 29:b6af04b77a56 54 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 55
dan_ackme 29:b6af04b77a56 56 result = sendCommand("set %s %s", settingStr, value);
dan_ackme 29:b6af04b77a56 57
dan_ackme 29:b6af04b77a56 58 _CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 59
dan_ackme 29:b6af04b77a56 60 return result;
dan_ackme 29:b6af04b77a56 61 }
dan_ackme 29:b6af04b77a56 62
dan_ackme 29:b6af04b77a56 63 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 64 WiconnectResult Wiconnect::getSetting(const char *settingStr, uint32_t *valuePtr)
dan_ackme 29:b6af04b77a56 65 {
dan_ackme 29:b6af04b77a56 66 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 29:b6af04b77a56 67
dan_ackme 29:b6af04b77a56 68
dan_ackme 29:b6af04b77a56 69 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 70
dan_ackme 29:b6af04b77a56 71 if(WICONNECT_SUCCEEDED(result, sendCommand("get %s", settingStr)))
dan_ackme 29:b6af04b77a56 72 {
dan_ackme 29:b6af04b77a56 73 result = responseToUint32(valuePtr);
dan_ackme 29:b6af04b77a56 74 }
dan_ackme 29:b6af04b77a56 75
dan_ackme 29:b6af04b77a56 76 _CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 77
dan_ackme 29:b6af04b77a56 78 return result;
dan_ackme 29:b6af04b77a56 79 }
dan_ackme 29:b6af04b77a56 80
dan_ackme 29:b6af04b77a56 81 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 82 WiconnectResult Wiconnect::getSetting(const char *settingStr, char **valuePtr)
dan_ackme 29:b6af04b77a56 83 {
dan_ackme 29:b6af04b77a56 84 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 29:b6af04b77a56 85
dan_ackme 29:b6af04b77a56 86
dan_ackme 29:b6af04b77a56 87 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 88
dan_ackme 29:b6af04b77a56 89 if(WICONNECT_SUCCEEDED(result, sendCommand("get %s", settingStr)))
dan_ackme 29:b6af04b77a56 90 {
dan_ackme 29:b6af04b77a56 91 *valuePtr = internalBuffer;
dan_ackme 29:b6af04b77a56 92 }
dan_ackme 29:b6af04b77a56 93
dan_ackme 29:b6af04b77a56 94 _CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 95
dan_ackme 29:b6af04b77a56 96 return result;
dan_ackme 29:b6af04b77a56 97 }
dan_ackme 29:b6af04b77a56 98
dan_ackme 29:b6af04b77a56 99 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 100 WiconnectResult Wiconnect::getSetting(const char *settingStr, char *valueBuffer, uint16_t valueBufferLen)
dan_ackme 29:b6af04b77a56 101 {
dan_ackme 29:b6af04b77a56 102 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 29:b6af04b77a56 103
dan_ackme 29:b6af04b77a56 104
dan_ackme 29:b6af04b77a56 105 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 29:b6af04b77a56 106
dan_ackme 29:b6af04b77a56 107 result = sendCommand(valueBuffer, valueBufferLen, "get %s", settingStr);
dan_ackme 29:b6af04b77a56 108
dan_ackme 29:b6af04b77a56 109 _CHECK_CLEANUP_COMMAND();
dan_ackme 29:b6af04b77a56 110
dan_ackme 29:b6af04b77a56 111 return result;
dan_ackme 29:b6af04b77a56 112 }
dan_ackme 29:b6af04b77a56 113
dan_ackme 37:5ee74d72efe4 114 /*************************************************************************************************/
dan_ackme 37:5ee74d72efe4 115 WiconnectResult Wiconnect::saveSettings()
dan_ackme 37:5ee74d72efe4 116 {
dan_ackme 37:5ee74d72efe4 117 WiconnectResult result = WICONNECT_ERROR;
dan_ackme 37:5ee74d72efe4 118
dan_ackme 37:5ee74d72efe4 119
dan_ackme 37:5ee74d72efe4 120 _CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 37:5ee74d72efe4 121
dan_ackme 37:5ee74d72efe4 122 result = sendCommand("save");
dan_ackme 37:5ee74d72efe4 123
dan_ackme 37:5ee74d72efe4 124 _CHECK_CLEANUP_COMMAND();
dan_ackme 37:5ee74d72efe4 125
dan_ackme 37:5ee74d72efe4 126 return result;
dan_ackme 37:5ee74d72efe4 127 }