utils.h

00001  /***************************************************************************
00002   * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
00003   *
00004   * Permission is hereby granted, free of charge, to any person obtaining a
00005   * copy of this software and associated documentation files (the "Software"),
00006   * to deal in the Software without restriction, including without limitation
00007   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008   * and/or sell copies of the Software, and to permit persons to whom the
00009   * Software is furnished to do so, subject to the following conditions:
00010   *
00011   * The above copyright notice and this permission notice shall be included
00012   * in all copies or substantial portions of the Software.
00013   *
00014   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017   * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018   * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019   * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020   * OTHER DEALINGS IN THE SOFTWARE.
00021   *
00022   * Except as contained in this notice, the name of Maxim Integrated
00023   * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024   * Products, Inc. Branding Policy.
00025   *
00026   * The mere transfer of this software does not imply any licenses
00027   * of trade secrets, proprietary technology, copyrights, patents,
00028   * trademarks, maskwork rights, or any other form of intellectual
00029   * property whatsoever. Maxim Integrated Products, Inc. retains all
00030   * ownership rights.
00031   ****************************************************************************
00032   */
00033 
00034 
00035 #ifndef __UTILS__H_
00036 #include <mbed.h>
00037 
00038 #ifndef ARRAY_SIZE
00039 #define ARRAY_SIZE(arr)        (sizeof(arr)/sizeof(arr[0]))
00040 #endif
00041 
00042 /*
00043  * @brief Parse DeviceStudio get_reg command 
00044  * @details format is "get_reg <type> <addr>"
00045  *
00046  * @param[in] str - Pointer to start of command
00047  * @param[in] dev_type - device type, ie "ppg"
00048  * @param[in] addr - Parsed address
00049  *
00050  * @return 0 on success, -1 on failure
00051  */
00052 int parse_get_reg_cmd(const char* str, const char* dev_type, uint8_t* addr);
00053 
00054 /*
00055  * @brief Parse DeviceStudio set_reg command 
00056  * @details format is "set_reg <type> <addr> <val>"
00057  *
00058  * @param[in] str - Pointer to start of command
00059  * @param[in] dev_type - device type, ie "ppg"
00060  * @param[in] addr - Parsed address
00061  * @param[in] val - Parsed value
00062  *
00063  * @return 0 on success, -1 on failure
00064  */
00065 int parse_set_reg_cmd(const char* str, const char* dev_type, uint8_t* addr, uint8_t* val);
00066 int parse_set_reg_cmd(const char* str, const char* dev_type, uint8_t* addr, uint16_t* val);
00067 int parse_set_reg_cmd(const char* str, const char* dev_type, uint8_t* addr, uint32_t* val);
00068 
00069 /*
00070  * @brief Parse data values sent by DeviceStudio command
00071  * @details For a command format of "<cmd> <val1> <val2> ... <valN>",
00072  *          This command will parse val1 - valN into vals array
00073  *
00074  * @param[in] str - The full string received
00075  * @param[in] cmd - The command only
00076  * @param[out] vals - The output array of values
00077  * @param[in] vals_sz - The maximum number of values the output array vals can hold
00078  * @param[in] hex - Set to true for hexidecimal values, false for decimal
00079  *
00080  * @return -1 on error, otherwise the number of values parsed
00081  */
00082 int parse_cmd_data(const char* str, const char* cmd, uint8_t *vals, int vals_sz, bool hex);
00083 int parse_cmd_data(const char* str, const char* cmd, uint16_t *vals, int vals_sz, bool hex);
00084 int parse_cmd_data(const char* str, const char* cmd, uint32_t *vals, int vals_sz, bool hex);
00085 
00086 /*
00087  * @brief Determine if str2 is a substring of str1 beginning at idx 0
00088  *
00089  * @param[in] str1 - The parent string
00090  * @param[in] str2 - The substring which should exist starting at index 0 of str1
00091  *
00092  * @return true if str1 starts with str2
00093  *
00094  * Examples:
00095  *  str1 = "An apple", str2 = "An a", returns true
00096  *  str1 = "A dog", str2 = "A a", returns false
00097  *  str1 = "An apple", str2 = "An apple tree", returns false
00098  */
00099 bool starts_with(const char* str1, const char* str2);
00100 
00101 #endif