This repository contains the coreMQTT library that has been optimized for a low memory footprint. The coreMQTT library is compliant with the MQTT 3.1.1 standard. It has no dependencies on any additional libraries other than the standard C library, a customer-implemented network transport interface, and optionally a user-implemented platform time function. This library is distributed under the MIT Open Source License.
This library has gone through code quality checks including verification that no function has a GNU Complexity score over 8, and checks against deviations from mandatory rules in the MISRA coding standard. Deviations from the MISRA C:2012 guidelines are documented under MISRA Deviations. This library has also undergone both static code analysis from Coverity static analysis, and validation of memory safety through the CBMC automated reasoning tool.
See memory requirements for this library here.
coreMQTT v2.1.1 source code is part of the FreeRTOS 202210.01 LTS release.
The MQTT client library exposes build configuration macros that are required for building the library.
A list of all the configurations and their default values are defined in core_mqtt_config_defaults.h.
To provide custom values for the configuration macros, a custom config file named core_mqtt_config.h can be
provided by the application to the library.
By default, a core_mqtt_config.h custom config is required to build the library. To disable this requirement
and build the library with default configuration values, provide MQTT_DO_NOT_USE_CUSTOM_CONFIG as a compile time preprocessor macro.
Thus, the MQTT library can be built by either:
* Defining a core_mqtt_config.h file in the application, and adding it to the include directories list of the library
OR
* Defining the MQTT_DO_NOT_USE_CUSTOM_CONFIG preprocessor macro for the library build.
For pre-generated documentation, please see the documentation linked in the locations below:
| Location |
|---|
| FreeRTOS.org |
Note that the latest included version of coreMQTT may differ across repositories.
