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/CommandCommon.h@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
29:b6af04b77a56 
increase ota timeout to be 5 seconds (instead of 1.5 sec)

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 #pragma once
dan_ackme 29:b6af04b77a56 30
dan_ackme 29:b6af04b77a56 31
dan_ackme 29:b6af04b77a56 32 #include <stdio.h>
dan_ackme 29:b6af04b77a56 33 #include <stdarg.h>
dan_ackme 29:b6af04b77a56 34 #include "Wiconnect.h"
dan_ackme 29:b6af04b77a56 35 #include "api/StringUtil.h"
dan_ackme 29:b6af04b77a56 36 #include "internal/common.h"
dan_ackme 29:b6af04b77a56 37
dan_ackme 29:b6af04b77a56 38
dan_ackme 29:b6af04b77a56 39 #define CHECK_NULL_BUFFER(buf) if(buf == NULL) return WICONNECT_NULL_BUFFER
dan_ackme 29:b6af04b77a56 40 #define CHECK_INITIALIZED() if(!initialized) return WICONNECT_NOT_INITIALIZED
dan_ackme 29:b6af04b77a56 41 #define RESET_CMD_HEADER(header) memset(header, 0, sizeof(CommandHeader)); header->bytes_remaining = WICONNECT_HEADER_LENGTH
dan_ackme 29:b6af04b77a56 42
dan_ackme 29:b6af04b77a56 43 #ifdef WICONNECT_ENABLE_DEBUGGING
dan_ackme 29:b6af04b77a56 44 #define DEBUG_CMD_SEND(cmd) debugLog(">> CMD: %s", cmd)
dan_ackme 29:b6af04b77a56 45 #define DEBUG_CMD_LOG(res) debugLog("<< LOG: %s", res)
dan_ackme 29:b6af04b77a56 46 #define DEBUG_CMD_RESPONSE(res) debugLog("<< RES: %s", res)
dan_ackme 29:b6af04b77a56 47 #define DEBUG_CMD_ERROR(code) debugLog("<< ERR:(%d) %s", code, getLastCommandResponseCodeStr())
dan_ackme 29:b6af04b77a56 48 #define DEBUG_ERROR(msg, ...) debugLog(" ERR: " msg, ## __VA_ARGS__)
dan_ackme 29:b6af04b77a56 49 #define DEBUG_INFO(msg, ...) debugLog(" DBG: " msg, ## __VA_ARGS__)
dan_ackme 29:b6af04b77a56 50 #else
dan_ackme 29:b6af04b77a56 51 #define DEBUG_CMD_SEND(cmd)
dan_ackme 29:b6af04b77a56 52 #define DEBUG_CMD_LOG(res)
dan_ackme 29:b6af04b77a56 53 #define DEBUG_CMD_RESPONSE(res)
dan_ackme 29:b6af04b77a56 54 #define DEBUG_CMD_ERROR(code)
dan_ackme 29:b6af04b77a56 55 #define DEBUG_ERROR(msg, ...)
dan_ackme 29:b6af04b77a56 56 #define DEBUG_INFO(msg, ...)
dan_ackme 29:b6af04b77a56 57 #endif
dan_ackme 29:b6af04b77a56 58
dan_ackme 29:b6af04b77a56 59
dan_ackme 29:b6af04b77a56 60 typedef enum
dan_ackme 29:b6af04b77a56 61 {
dan_ackme 29:b6af04b77a56 62 WICONNECT_CMD_TYPE_NULL = 0,
dan_ackme 29:b6af04b77a56 63 WICONNECT_CMD_TYPE_REPLY = 'R',
dan_ackme 29:b6af04b77a56 64 WICONNECT_CMD_TYPE_LOG = 'L',
dan_ackme 29:b6af04b77a56 65 WICONNECT_CMD_TYPE_SAFEMODE = 'S'
dan_ackme 29:b6af04b77a56 66 } ResponseType;
dan_ackme 29:b6af04b77a56 67
dan_ackme 29:b6af04b77a56 68 typedef enum
dan_ackme 29:b6af04b77a56 69 {
dan_ackme 29:b6af04b77a56 70 WICONNECT_CMD_CODE_NULL = 0,
dan_ackme 29:b6af04b77a56 71 WICONNECT_CMD_SUCCESS = 1, // The command was successful
dan_ackme 29:b6af04b77a56 72 WICONNECT_CMD_FAILED = 2, // The command failed, most likely in the firmware
dan_ackme 29:b6af04b77a56 73 WICONNECT_CMD_PARSE_ERROR = 3, // Failed to parse the command
dan_ackme 29:b6af04b77a56 74 WICONNECT_CMD_UNKNOWN = 4, // Unknown command
dan_ackme 29:b6af04b77a56 75 WICONNECT_CMD_TOO_FEW_ARGS = 5, // Not enough command arguments
dan_ackme 29:b6af04b77a56 76 WICONNECT_CMD_TOO_MANY_ARGS = 6, // Too many command arguments
dan_ackme 29:b6af04b77a56 77 WICONNECT_CMD_UNKNOWN_OPTION = 7, // Unknown option (e.g. known 'set' command option)
dan_ackme 29:b6af04b77a56 78 WICONNECT_CMD_BAD_ARGS = 8, // Invalid command arguments
dan_ackme 29:b6af04b77a56 79 } ResponseCode;
dan_ackme 29:b6af04b77a56 80
dan_ackme 29:b6af04b77a56 81 #define WICONNECT_HEADER_LENGTH 9
dan_ackme 29:b6af04b77a56 82 typedef struct
dan_ackme 29:b6af04b77a56 83 {
dan_ackme 29:b6af04b77a56 84 ResponseType response_type;
dan_ackme 29:b6af04b77a56 85 ResponseCode response_code;
dan_ackme 29:b6af04b77a56 86 uint16_t response_len;
dan_ackme 29:b6af04b77a56 87 uint8_t len_buffer[WICONNECT_HEADER_LENGTH];
dan_ackme 29:b6af04b77a56 88 uint8_t *len_buffer_ptr;
dan_ackme 29:b6af04b77a56 89 uint8_t bytes_remaining;
dan_ackme 29:b6af04b77a56 90 } CommandHeader;
dan_ackme 29:b6af04b77a56 91
dan_ackme 29:b6af04b77a56 92 typedef struct
dan_ackme 29:b6af04b77a56 93 {
dan_ackme 29:b6af04b77a56 94 char *responseBuffer;
dan_ackme 29:b6af04b77a56 95 char *responseBufferPtr;
dan_ackme 29:b6af04b77a56 96 int responseBufferLen;
dan_ackme 29:b6af04b77a56 97 ReaderFunc reader;
dan_ackme 29:b6af04b77a56 98 void *user;
dan_ackme 29:b6af04b77a56 99 char *commandPtr;
dan_ackme 29:b6af04b77a56 100 int commandLen;
dan_ackme 29:b6af04b77a56 101 int bytesToWrite;
dan_ackme 29:b6af04b77a56 102 int bytesToRead;
dan_ackme 29:b6af04b77a56 103 TimerTimeout timeoutMs;
dan_ackme 29:b6af04b77a56 104 Callback callback;
dan_ackme 29:b6af04b77a56 105 bool nonBlocking;
dan_ackme 29:b6af04b77a56 106 } CommandContext;
dan_ackme 29:b6af04b77a56 107