cellular_at_core.h

Go to the documentation of this file.

/*
 * FreeRTOS-Cellular-Interface v1.4.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * https://www.FreeRTOS.org
 * https://github.com/FreeRTOS
 */
 
#ifndef __CELLULAR_AT_CORE_H__
#define __CELLULAR_AT_CORE_H__
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
/* Standard includes */
#include <stdbool.h>
#include <string.h>
 
/* Standard includes. */
#include <stdint.h>
 
/* Cellular includes. */
#ifndef CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
    /* Include custom config file before other headers. */
    #include "cellular_config.h"
#endif
#include "cellular_config_defaults.h"
 
/*-----------------------------------------------------------*/
 
#define ARRAY_SIZE( x )    ( sizeof( x ) / sizeof( x[ 0 ] ) )
 
/*-----------------------------------------------------------*/
 
typedef enum CellularATError
{
    CELLULAR_AT_SUCCESS = 0,   
    CELLULAR_AT_BAD_PARAMETER, 
    CELLULAR_AT_NO_MEMORY,     
    CELLULAR_AT_UNSUPPORTED,   
    CELLULAR_AT_MODEM_ERROR,   
    CELLULAR_AT_ERROR,         
    CELLULAR_AT_UNKNOWN        
} CellularATError_t;
 
/*-----------------------------------------------------------*/
 
CellularATError_t Cellular_ATRemovePrefix( char ** ppString );
 
CellularATError_t Cellular_ATRemoveLeadingWhiteSpaces( char ** ppString );
 
CellularATError_t Cellular_ATRemoveTrailingWhiteSpaces( char * pString );
 
CellularATError_t Cellular_ATRemoveAllWhiteSpaces( char * pString );
 
CellularATError_t Cellular_ATRemoveOutermostDoubleQuote( char ** ppString );
 
CellularATError_t Cellular_ATRemoveAllDoubleQuote( char * pString );
 
CellularATError_t Cellular_ATGetNextTok( char ** ppString,
                                         char ** ppTokOutput );
 
CellularATError_t Cellular_ATGetSpecificNextTok( char ** ppString,
                                                 const char * pDelimiter,
                                                 char ** ppTokOutput );
 
CellularATError_t Cellular_ATHexStrToHex( const char * pString,
                                          uint8_t * pHexData,
                                          uint16_t hexDataLen );
 
CellularATError_t Cellular_ATIsStrDigit( const char * pString,
                                         bool * pResult );
 
CellularATError_t Cellular_ATIsPrefixPresent( const char * pString,
                                              bool * pResult );
 
CellularATError_t Cellular_ATStrDup( char ** ppDst,
                                     const char * pSrc );
 
CellularATError_t Cellular_ATStrStartWith( const char * pString,
                                           const char * pPrefix,
                                           bool * pResult );
 
CellularATError_t Cellular_ATcheckErrorCode( const char * pInputBuf,
                                             const char * const * const ppKeyList,
                                             size_t keyListLen,
                                             bool * pResult );
 
CellularATError_t Cellular_ATStrtoi( const char * pStr,
                                     int32_t base,
                                     int32_t * pResult );
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* __CELLULAR_AT_CORE_H__ */