FreeRTOS: FreeRTOS Cellular Library v1.1.0
FreeRTOS Cellular Library
Configurations

Configurations of the Cellular Library.

Some configuration settings are C pre-processor constants, and some are function-like macros for logging. They can be set with a #define in the config file (cellular_config.h) or by using a compiler option such as -D in gcc.

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

Mobile country code max size.
Possible values:Any positive integer
Default value (if undefined): 3

CELLULAR_MNC_MAX_SIZE

Mobile network code max size.
Possible values:Any positive integer
Default value (if undefined): 3

CELLULAR_ICCID_MAX_SIZE

Integrate circuit card identity max size.
Possible values:Any positive integer
Default value (if undefined): 20

CELLULAR_IMSI_MAX_SIZE

International Mobile Subscriber Identity max size.
Possible values:Any positive integer
Default value (if undefined): 15

CELLULAR_FW_VERSION_MAX_SIZE

Cellular module firmware version max size.
Possible values:Any positive integer
Default value (if undefined): 32

CELLULAR_HW_VERSION_MAX_SIZE

Cellular module hardware version max size.
Possible values:Any positive integer
Default value (if undefined): 12

CELLULAR_SERIAL_NUM_MAX_SIZE

Cellular module serial number max size.
Possible values:Any positive integer
Default value (if undefined): 12

CELLULAR_IMEI_MAX_SIZE

International Mobile Equipment Identity number max size.
Possible values:Any positive integer
Default value (if undefined): 15

CELLULAR_NETWORK_NAME_MAX_SIZE

Registered network operator name max size.
Possible values:Any positive integer
Default value (if undefined): 32

CELLULAR_APN_MAX_SIZE

Access point name max size.
Possible values:Any positive integer
Default value (if undefined): 32

CELLULAR_PDN_USERNAME_MAX_SIZE

Packet data network username max size.
Possible values:Any positive integer
Default value (if undefined): 32

CELLULAR_PDN_PASSWORD_MAX_SIZE

Packet data network password max size.
Possible values:Any positive integer
Default value (if undefined): 32

CELLULAR_IP_ADDRESS_MAX_SIZE

Cellular data network IP address max size.
Possible values:Any positive integer
Default value (if undefined): 40

CELLULAR_AT_CMD_MAX_SIZE

Cellular AT command max size.
Possible values:Any positive integer
Default value (if undefined): 200

CELLULAR_NUM_SOCKET_MAX

Cellular module number of socket max size.
Possible values:Any positive integer
Default value (if undefined): 12

CELLULAR_MANUFACTURE_ID_MAX_SIZE

Cellular module manufacture ID max size.
Possible values:Any positive integer
Default value (if undefined): 20

CELLULAR_MODEL_ID_MAX_SIZE

Cellular module ID max size.
Possible values:Any positive integer
Default value (if undefined): 10

CELLULAR_EDRX_LIST_MAX_SIZE

Cellular EDRX list max size.
Possible values:Any positive integer
Default value (if undefined): 4

CELLULAR_PDN_CONTEXT_ID_MIN

Cellular PDN context ID min value.
Possible values:Any positive integer
Default value (if undefined): 1

CELLULAR_PDN_CONTEXT_ID_MAX

Cellular PDN context ID max value.
Possible values:Any positive integer
Default value (if undefined): 1

CELLULAR_MAX_RAT_PRIORITY_COUNT

Cellular RAT ( radio access technology ) priority count.
Possible values:Any positive integer
Default value (if undefined): 1

CELLULAR_MAX_SEND_DATA_LEN

Cellular socket max send data length.
Possible values:Any positive integer
Default value (if undefined): 1460

CELLULAR_MAX_RECV_DATA_LEN

Cellular socket max receive data length.
Possible values:Any positive integer
Default value (if undefined): 1500

CELLULAR_SUPPORT_GETHOSTBYNAME

Cellular module support getHostByName.
Possible values:0 or 1
Default value (if undefined): 1

CELLULAR_COMM_IF_SEND_TIMEOUT_MS

Cellular comm interface send timeout in MS.
Possible values:Any positive integer
Default value (if undefined): 1000

CELLULAR_COMM_IF_RECV_TIMEOUT_MS

Cellular comm interface receive timeout in MS.
Possible values:Any positive integer
Default value (if undefined): 1000

CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT

FreeRTOS Cellular Library use static context.
Possible values:0 or 1
Default value (if undefined): 0

CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION

Cellular comm interface use static context.
Possible values:0 or 1
Default value (if undefined): 0

CELLULAR_CONFIG_DEFAULT_RAT

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

Cellular comm interface use static socket context.
Possible values:0 or 1
Default value (if undefined): 0

LogError

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

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

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

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.