FreeRTOS: FreeRTOS Cellular Library v1.1.0
FreeRTOS Cellular Library
cellular_config_defaults.h File Reference

This represents the default values for the configuration macros for the Cellular library. More...

Go to the source code of this file.

Macros

#define CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
 Define this macro to build the Cellular library without the custom config file cellular_config.h. More...
 
#define CELLULAR_MCC_MAX_SIZE   ( 3U )
 Mobile country code max size.
More...
 
#define CELLULAR_MNC_MAX_SIZE   ( 3U )
 Mobile network code max size.
More...
 
#define CELLULAR_ICCID_MAX_SIZE   ( 20U )
 Integrate circuit card identity max size.
More...
 
#define CELLULAR_IMSI_MAX_SIZE   ( 15U )
 International Mobile Subscriber Identity max size.
More...
 
#define CELLULAR_FW_VERSION_MAX_SIZE   ( 32U )
 Cellular module firmware version max size.
More...
 
#define CELLULAR_HW_VERSION_MAX_SIZE   ( 12U )
 Cellular module hardware version max size.
More...
 
#define CELLULAR_SERIAL_NUM_MAX_SIZE   ( 12U )
 Cellular module serial number max size.
More...
 
#define CELLULAR_IMEI_MAX_SIZE   ( 15U )
 International Mobile Equipment Identity number max size.
More...
 
#define CELLULAR_NETWORK_NAME_MAX_SIZE   ( 32U )
 Registered network operator name max size.
More...
 
#define CELLULAR_APN_MAX_SIZE   ( 64U )
 Access point name max size.
More...
 
#define CELLULAR_PDN_USERNAME_MAX_SIZE   ( 32U )
 Packet data network username max size.
More...
 
#define CELLULAR_PDN_PASSWORD_MAX_SIZE   ( 32u )
 Packet data network password max size.
More...
 
#define CELLULAR_IP_ADDRESS_MAX_SIZE   ( 40U )
 Cellular data network IP address max size.
More...
 
#define CELLULAR_AT_CMD_MAX_SIZE   ( 200U )
 Cellular AT command max size.
More...
 
#define CELLULAR_NUM_SOCKET_MAX   ( 12U )
 Cellular module number of socket max size.
More...
 
#define CELLULAR_MANUFACTURE_ID_MAX_SIZE   ( 20U )
 Cellular module manufacture ID max size.
More...
 
#define CELLULAR_MODEL_ID_MAX_SIZE   ( 10U )
 Cellular module ID max size.
More...
 
#define CELLULAR_EDRX_LIST_MAX_SIZE   ( 4U )
 Cellular EDRX list max size.
More...
 
#define CELLULAR_PDN_CONTEXT_ID_MIN   ( 1U )
 Cellular PDN context ID min value.
More...
 
#define CELLULAR_PDN_CONTEXT_ID_MAX   ( 16U )
 Cellular PDN context ID max value.
More...
 
#define CELLULAR_MAX_RAT_PRIORITY_COUNT   ( 3U )
 Cellular RAT ( radio access technology ) priority count.
More...
 
#define CELLULAR_MAX_SEND_DATA_LEN   ( 1460U )
 Cellular socket max send data length.
More...
 
#define CELLULAR_MAX_RECV_DATA_LEN   ( 1500U )
 Cellular socket max receive data length.
More...
 
#define CELLULAR_SUPPORT_GETHOSTBYNAME   ( 1U )
 Cellular module support getHostByName.
More...
 
#define CELLULAR_COMM_IF_SEND_TIMEOUT_MS   ( 1000U )
 Cellular comm interface send timeout in MS.
More...
 
#define CELLULAR_COMM_IF_RECV_TIMEOUT_MS   ( 1000U )
 Cellular comm interface receive timeout in MS.
More...
 
#define CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT   ( 0U )
 FreeRTOS Cellular Library use static context.
More...
 
#define CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION   ( 0U )
 Cellular comm interface use static context.
More...
 
#define CELLULAR_CONFIG_DEFAULT_RAT   ( 8 ) /* Set default RAT to CELLULAR_RAT_CATM1 @ref CellularRat_t. */
 Default radio access technoloyg.
More...
 
#define CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION   ( 0 )
 Cellular comm interface use static socket context.
More...
 
#define LogError(message)
 Macro that is called in the cellular library for logging "Error" level messages. More...
 
#define LogWarn(message)
 Macro that is called in the cellular library for logging "Warning" level messages. More...
 
#define LogInfo(message)
 Macro that is called in the cellular library for logging "Info" level messages. More...
 
#define LogDebug(message)
 Macro that is called in the cellular library for logging "Debug" level messages. More...
 

Detailed Description

This represents the default values for the configuration macros for the Cellular library.

Note
This file SHOULD NOT be modified. If custom values are needed for any configuration macro, a cellular_config.h file should be provided to the Cellular library to override the default values defined in this file. To use the custom config file, the CELLULAR_DO_NOT_USE_CUSTOM_CONFIG preprocessor macro SHOULD NOT be set.

Macro Definition Documentation

◆ CELLULAR_DO_NOT_USE_CUSTOM_CONFIG

#define CELLULAR_DO_NOT_USE_CUSTOM_CONFIG

Define this macro to build the Cellular library without the custom config file cellular_config.h.

Without the custom config, the Cellular library builds with default values of config macros defined in cellular_config_defaults.h file.

If a custom config is provided, then CELLULAR_DO_NOT_USE_CUSTOM_CONFIG should not be defined.

◆ CELLULAR_MCC_MAX_SIZE

#define CELLULAR_MCC_MAX_SIZE   ( 3U )

Mobile country code max size.

Possible values:Any positive integer
Default value (if undefined): 3

◆ CELLULAR_MNC_MAX_SIZE

#define CELLULAR_MNC_MAX_SIZE   ( 3U )

Mobile network code max size.

Possible values:Any positive integer
Default value (if undefined): 3

◆ CELLULAR_ICCID_MAX_SIZE

#define CELLULAR_ICCID_MAX_SIZE   ( 20U )

Integrate circuit card identity max size.

Possible values:Any positive integer
Default value (if undefined): 20

◆ CELLULAR_IMSI_MAX_SIZE

#define CELLULAR_IMSI_MAX_SIZE   ( 15U )

International Mobile Subscriber Identity max size.

Possible values:Any positive integer
Default value (if undefined): 15

◆ CELLULAR_FW_VERSION_MAX_SIZE

#define CELLULAR_FW_VERSION_MAX_SIZE   ( 32U )

Cellular module firmware version max size.

Possible values:Any positive integer
Default value (if undefined): 32

◆ CELLULAR_HW_VERSION_MAX_SIZE

#define CELLULAR_HW_VERSION_MAX_SIZE   ( 12U )

Cellular module hardware version max size.

Possible values:Any positive integer
Default value (if undefined): 12

◆ CELLULAR_SERIAL_NUM_MAX_SIZE

#define CELLULAR_SERIAL_NUM_MAX_SIZE   ( 12U )

Cellular module serial number max size.

Possible values:Any positive integer
Default value (if undefined): 12

◆ CELLULAR_IMEI_MAX_SIZE

#define CELLULAR_IMEI_MAX_SIZE   ( 15U )

International Mobile Equipment Identity number max size.

Possible values:Any positive integer
Default value (if undefined): 15

◆ CELLULAR_NETWORK_NAME_MAX_SIZE

#define CELLULAR_NETWORK_NAME_MAX_SIZE   ( 32U )

Registered network operator name max size.

Possible values:Any positive integer
Default value (if undefined): 32

◆ CELLULAR_APN_MAX_SIZE

#define CELLULAR_APN_MAX_SIZE   ( 64U )

Access point name max size.

Possible values:Any positive integer
Default value (if undefined): 32

◆ CELLULAR_PDN_USERNAME_MAX_SIZE

#define CELLULAR_PDN_USERNAME_MAX_SIZE   ( 32U )

Packet data network username max size.

Possible values:Any positive integer
Default value (if undefined): 32

◆ CELLULAR_PDN_PASSWORD_MAX_SIZE

#define CELLULAR_PDN_PASSWORD_MAX_SIZE   ( 32u )

Packet data network password max size.

Possible values:Any positive integer
Default value (if undefined): 32

◆ CELLULAR_IP_ADDRESS_MAX_SIZE

#define CELLULAR_IP_ADDRESS_MAX_SIZE   ( 40U )

Cellular data network IP address max size.

Possible values:Any positive integer
Default value (if undefined): 40

◆ CELLULAR_AT_CMD_MAX_SIZE

#define CELLULAR_AT_CMD_MAX_SIZE   ( 200U )

Cellular AT command max size.

Possible values:Any positive integer
Default value (if undefined): 200

◆ CELLULAR_NUM_SOCKET_MAX

#define CELLULAR_NUM_SOCKET_MAX   ( 12U )

Cellular module number of socket max size.

Possible values:Any positive integer
Default value (if undefined): 12

◆ CELLULAR_MANUFACTURE_ID_MAX_SIZE

#define CELLULAR_MANUFACTURE_ID_MAX_SIZE   ( 20U )

Cellular module manufacture ID max size.

Possible values:Any positive integer
Default value (if undefined): 20

◆ CELLULAR_MODEL_ID_MAX_SIZE

#define CELLULAR_MODEL_ID_MAX_SIZE   ( 10U )

Cellular module ID max size.

Possible values:Any positive integer
Default value (if undefined): 10

◆ CELLULAR_EDRX_LIST_MAX_SIZE

#define CELLULAR_EDRX_LIST_MAX_SIZE   ( 4U )

Cellular EDRX list max size.

Possible values:Any positive integer
Default value (if undefined): 4

◆ CELLULAR_PDN_CONTEXT_ID_MIN

#define CELLULAR_PDN_CONTEXT_ID_MIN   ( 1U )

Cellular PDN context ID min value.

Possible values:Any positive integer
Default value (if undefined): 1

◆ CELLULAR_PDN_CONTEXT_ID_MAX

#define CELLULAR_PDN_CONTEXT_ID_MAX   ( 16U )

Cellular PDN context ID max value.

Possible values:Any positive integer
Default value (if undefined): 1

◆ CELLULAR_MAX_RAT_PRIORITY_COUNT

#define CELLULAR_MAX_RAT_PRIORITY_COUNT   ( 3U )

Cellular RAT ( radio access technology ) priority count.

Possible values:Any positive integer
Default value (if undefined): 1

◆ CELLULAR_MAX_SEND_DATA_LEN

#define CELLULAR_MAX_SEND_DATA_LEN   ( 1460U )

Cellular socket max send data length.

Possible values:Any positive integer
Default value (if undefined): 1460

◆ CELLULAR_MAX_RECV_DATA_LEN

#define CELLULAR_MAX_RECV_DATA_LEN   ( 1500U )

Cellular socket max receive data length.

Possible values:Any positive integer
Default value (if undefined): 1500

◆ CELLULAR_SUPPORT_GETHOSTBYNAME

#define CELLULAR_SUPPORT_GETHOSTBYNAME   ( 1U )

Cellular module support getHostByName.

Possible values:0 or 1
Default value (if undefined): 1

◆ CELLULAR_COMM_IF_SEND_TIMEOUT_MS

#define CELLULAR_COMM_IF_SEND_TIMEOUT_MS   ( 1000U )

Cellular comm interface send timeout in MS.

Possible values:Any positive integer
Default value (if undefined): 1000

◆ CELLULAR_COMM_IF_RECV_TIMEOUT_MS

#define CELLULAR_COMM_IF_RECV_TIMEOUT_MS   ( 1000U )

Cellular comm interface receive timeout in MS.

Possible values:Any positive integer
Default value (if undefined): 1000

◆ CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT

#define CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT   ( 0U )

FreeRTOS Cellular Library use static context.

Possible values:0 or 1
Default value (if undefined): 0

◆ CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION

#define CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION   ( 0U )

Cellular comm interface use static context.

Possible values:0 or 1
Default value (if undefined): 0

◆ CELLULAR_CONFIG_DEFAULT_RAT

#define CELLULAR_CONFIG_DEFAULT_RAT   ( 8 ) /* Set default RAT to CELLULAR_RAT_CATM1 @ref CellularRat_t. */

Default radio access technoloyg.

Possible values:Any value before CELLULAR_RAT_MAX ( Reference : CellularRat_t )
Default value (if undefined): CELLULAR_RAT_CATM1

◆ CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION

#define CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION   ( 0 )

Cellular comm interface use static socket context.

Possible values:0 or 1
Default value (if undefined): 0

◆ LogError

#define LogError (   message)

Macro that is called in the cellular library for logging "Error" level messages.

To enable error level logging in the cellular library, this macro should be mapped to the application-specific logging implementation that supports error logging.

Note
This logging macro is called in the cellular library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to cellular_config.h files.

Default value: Error logging is turned off, and no code is generated for calls to the macro in the cellular library on compilation.

◆ LogWarn

#define LogWarn (   message)

Macro that is called in the cellular library for logging "Warning" level messages.

To enable warning level logging in the cellular library, this macro should be mapped to the application-specific logging implementation that supports warning logging.

Note
This logging macro is called in the cellular library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to cellular_config.h files.

Default value: Warning logs are turned off, and no code is generated for calls to the macro in the cellular library on compilation.

◆ LogInfo

#define LogInfo (   message)

Macro that is called in the cellular library for logging "Info" level messages.

To enable info level logging in the cellular library, this macro should be mapped to the application-specific logging implementation that supports info logging.

Note
This logging macro is called in the cellular library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to cellular_config.h files.

Default value: Info logging is turned off, and no code is generated for calls to the macro in the cellular library on compilation.

◆ LogDebug

#define LogDebug (   message)

Macro that is called in the cellular library for logging "Debug" level messages.

To enable debug level logging from cellular library, this macro should be mapped to the application-specific logging implementation that supports debug logging.

Note
This logging macro is called in the cellular library with parameters wrapped in double parentheses to be ISO C89/C90 standard compliant. For a reference POSIX implementation of the logging macros, refer to cellular_config.h files.

Default value: Debug logging is turned off, and no code is generated for calls to the macro in the cellular library on compilation.