FreeRTOS: FreeRTOS Cellular Library v1.4.0
FreeRTOS Cellular Library
 
Loading...
Searching...
No Matches
Functions
cellular_common_api.h File Reference
#include "cellular_types.h"
#include "cellular_common.h"
#include "cellular_comm_interface.h"

Go to the source code of this file.

Functions

CellularError_t Cellular_CommonInit (CellularHandle_t *pCellularHandle, const CellularCommInterface_t *pCommInterface, const CellularTokenTable_t *pTokenTable)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Init in cellular_api.h for definition.
 
CellularError_t Cellular_CommonCleanup (CellularHandle_t cellularHandle)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Cleanup in cellular_api.h for definition.
 
CellularError_t Cellular_CommonRegisterUrcNetworkRegistrationEventCallback (CellularHandle_t cellularHandle, CellularUrcNetworkRegistrationCallback_t networkRegistrationCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RegisterUrcNetworkRegistrationEventCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonRegisterUrcPdnEventCallback (CellularHandle_t cellularHandle, CellularUrcPdnEventCallback_t pdnEventCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RegisterUrcPdnEventCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonRegisterUrcSignalStrengthChangedCallback (CellularHandle_t cellularHandle, CellularUrcSignalStrengthChangedCallback_t signalStrengthChangedCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RegisterUrcSignalStrengthChangedCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonRegisterUrcGenericCallback (CellularHandle_t cellularHandle, CellularUrcGenericCallback_t genericCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RegisterUrcGenericCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonRegisterModemEventCallback (CellularHandle_t cellularHandle, CellularModemEventCallback_t modemEventCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RegisterModemEventCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonATCommandRaw (CellularHandle_t cellularHandle, const char *pATCommandPrefix, const char *pATCommandPayload, CellularATCommandType_t atCommandType, CellularATCommandResponseReceivedCallback_t responseReceivedCallback, void *pData, uint16_t dataLen)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_ATCommandRaw in cellular_api.h for definition.
 
CellularError_t Cellular_CommonCreateSocket (CellularHandle_t cellularHandle, uint8_t pdnContextId, CellularSocketDomain_t socketDomain, CellularSocketType_t socketType, CellularSocketProtocol_t socketProtocol, CellularSocketHandle_t *pSocketHandle)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_CreateSocket in cellular_api.h for definition.
 
CellularError_t Cellular_CommonSocketSetSockOpt (CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketOptionLevel_t optionLevel, CellularSocketOption_t option, const uint8_t *pOptionValue, uint32_t optionValueLength)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_SocketSetSockOpt in cellular_api.h for definition.
 
CellularError_t Cellular_CommonSocketRegisterDataReadyCallback (CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketDataReadyCallback_t dataReadyCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_SocketRegisterDataReadyCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonSocketRegisterSocketOpenCallback (CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketOpenCallback_t socketOpenCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_SocketRegisterSocketOpenCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonSocketRegisterClosedCallback (CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketClosedCallback_t closedCallback, void *pCallbackContext)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_SocketRegisterClosedCallback in cellular_api.h for definition.
 
CellularError_t Cellular_CommonRfOn (CellularHandle_t cellularHandle)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RfOn in cellular_api.h for definition.
 
CellularError_t Cellular_CommonRfOff (CellularHandle_t cellularHandle)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RfOff in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetIPAddress (CellularHandle_t cellularHandle, uint8_t contextId, char *pBuffer, uint32_t bufferLength)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetIPAddress in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetModemInfo (CellularHandle_t cellularHandle, CellularModemInfo_t *pModemInfo)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetModemInfo in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetEidrxSettings (CellularHandle_t cellularHandle, CellularEidrxSettingsList_t *pEidrxSettingsList)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetEidrxSettings in cellular_api.h for definition.
 
CellularError_t Cellular_CommonSetEidrxSettings (CellularHandle_t cellularHandle, const CellularEidrxSettings_t *pEidrxSettings)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_SetEidrxSettings in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetRegisteredNetwork (CellularHandle_t cellularHandle, CellularPlmnInfo_t *pNetworkInfo)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetRegisteredNetwork in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetNetworkTime (CellularHandle_t cellularHandle, CellularTime_t *pNetworkTime)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetNetworkTime in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetServiceStatus (CellularHandle_t cellularHandle, CellularServiceStatus_t *pServiceStatus)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetServiceStatus in cellular_api.h for definition.
 
CellularError_t Cellular_CommonSetPdnConfig (CellularHandle_t cellularHandle, uint8_t contextId, const CellularPdnConfig_t *pPdnConfig)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetServiceStatus in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetPsmSettings (CellularHandle_t cellularHandle, CellularPsmSettings_t *pPsmSettings)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetServiceStatus in cellular_api.h for definition.
 
CellularError_t Cellular_CommonSetPsmSettings (CellularHandle_t cellularHandle, const CellularPsmSettings_t *pPsmSettings)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetServiceStatus in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetSimCardInfo (CellularHandle_t cellularHandle, CellularSimCardInfo_t *pSimCardInfo)
 This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetServiceStatus in cellular_api.h for definition.
 
CellularError_t Cellular_CommonGetSimCardLockStatus (CellularHandle_t cellularHandle, CellularSimCardStatus_t *pSimCardStatus)
 Get SIM card lock status.
 
CellularPktStatus_t Cellular_CommonUrcProcessCereg (CellularContext_t *pContext, char *pInputLine)
 3GPP URC AT+CEREG handler for FreeRTOS Cellular Library.
 
CellularPktStatus_t Cellular_CommonUrcProcessCgreg (CellularContext_t *pContext, char *pInputLine)
 3GPP URC AT+CGREG handler for FreeRTOS Cellular Library.
 
CellularPktStatus_t Cellular_CommonUrcProcessCreg (CellularContext_t *pContext, char *pInputLine)
 3GPP URC AT+CREG handler for FreeRTOS Cellular Library.
 

Function Documentation

◆ Cellular_CommonGetSimCardLockStatus()

CellularError_t Cellular_CommonGetSimCardLockStatus ( CellularHandle_t  cellularHandle,
CellularSimCardStatus_t *  pSimCardStatus 
)

Get SIM card lock status.

Parameters
[in]cellularHandleThe opaque cellular context pointer created by Cellular_Init.
[out]pSimCardStatusOut parameter to provide the SIM card status.
Returns
CELLULAR_SUCCESS if the operation is successful, otherwise an error code indicating the cause of the error.

◆ Cellular_CommonUrcProcessCereg()

CellularPktStatus_t Cellular_CommonUrcProcessCereg ( CellularContext_t *  pContext,
char *  pInputLine 
)

3GPP URC AT+CEREG handler for FreeRTOS Cellular Library.

This function handles the incoming URC and callback function.

Parameters
[in,out]pContextFreeRTOS Cellular Library context created in Cellular_Init.
[in]pInputLinethe input URC string.
Returns
CELLULAR_PKT_STATUS_OK if the operation is successful, otherwise an error code indicating the cause of the error.

◆ Cellular_CommonUrcProcessCgreg()

CellularPktStatus_t Cellular_CommonUrcProcessCgreg ( CellularContext_t *  pContext,
char *  pInputLine 
)

3GPP URC AT+CGREG handler for FreeRTOS Cellular Library.

This function handles the incoming URC and callback function.

Parameters
[in,out]pContextFreeRTOS Cellular Library context created in Cellular_Init.
[in]pInputLinethe input URC string.
Returns
CELLULAR_PKT_STATUS_OK if the operation is successful, otherwise an error code indicating the cause of the error.

◆ Cellular_CommonUrcProcessCreg()

CellularPktStatus_t Cellular_CommonUrcProcessCreg ( CellularContext_t *  pContext,
char *  pInputLine 
)

3GPP URC AT+CREG handler for FreeRTOS Cellular Library.

This function handles the incoming URC and callback function.

Parameters
[in,out]pContextFreeRTOS Cellular Library context created in Cellular_Init.
[in]pInputLinethe input URC string.
Returns
CELLULAR_PKT_STATUS_OK if the operation is successful, otherwise an error code indicating the cause of the error.