FreeRTOS · adituc · Mar 24, 2025 · Mar 24, 2025 · Mar 25, 2025 · Mar 25, 2025
diff --git a/.github/.cSpellWords.txt b/.github/.cSpellWords.txt
@@ -52,4 +52,12 @@ Werror
 Wextra
 Wsign
 Wunused
+mqttpropadd
+mqttpropget
+pubsubscriptionid
+mqttpropertybuilder
+MQTTV
+subscribeid
 DCOV
+mqtteventcallback
+
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -92,7 +92,7 @@ jobs:
         uses: FreeRTOS/CI-CD-Github-Actions/complexity@main
         with:
           path: ./
-          horrid_threshold: 12
+          horrid_threshold: 17
 
   doxygen:
     runs-on: ubuntu-latest

diff --git a/CTestTestfile.cmake b/CTestTestfile.cmake
@@ -0,0 +1,7 @@
+# CMake generated Testfile for
+# Source directory: /home/ubuntu/coreMQTT/test
+# Build directory: /home/ubuntu/coreMQTT
+#
+# This file includes the relevant testing commands required for
+# testing this directory and lists subdirectories to be tested as well.
+subdirs("unit-test")
diff --git a/MISRA.md b/MISRA.md
@@ -37,3 +37,8 @@ _Ref 18.2.1_
   to be subtracted from the index. It is manually verified that the index will always be
   within bounds of the array. However, Coverity is flagging this as a deviation. Thus, we
   are suppressing it.
+
+#### Rule 10.5
+
+_Ref 10.5.1_
+- MISRA C-2012 Rule 10.5 states that the value of an expression should not be cast to an inappropriate essential type. In this library, reason codes are input as bytes and processed accordingly. A byte representing the reason code is cast to an enumerated type that is also based on uint8_t. It is verified that the values will always fall within the valid range of the enumeration, and the underlying type of the enumeration is compatible. Thus, this cast is considered safe.
diff --git a/MigrationGuide.md b/MigrationGuide.md
diff --git a/README.md b/README.md
@@ -3,8 +3,7 @@
 **[API Documentation Pages for current and previous releases of this library can be found here](https://freertos.github.io/coreMQTT/)**
 
 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](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html)
+memory footprint.
 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
@@ -21,6 +20,10 @@ library has also undergone both static code analysis from
 safety through the
 [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
 
+-For MQTT v3.1.1 [(MQTTv3 Specification)](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html), use code from tag : [coreMQTT v2.3.1](https://github.com/FreeRTOS/coreMQTT/tree/v2.3.1)
+
+-For MQTT v5.0 [(MQTTv5 Specification)](https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html), use code from tag : [coreMQTT v3.0.0](https://github.com/FreeRTOS/coreMQTT/tree/v3.0.0)
+
 See memory requirements for this library
 [here](./docs/doxygen/include/size_table.md).
 
@@ -109,10 +112,15 @@ connectInfo.userNameLength = USERNAME_STRING_LENGTH;
 mqttStatus = MQTT_Connect( pMqttContext, &connectInfo, NULL, CONNACK_RECV_TIMEOUT_MS, pSessionPresent );
 ```
 
-## Upgrading to v2.0.0 and above
+## Upgrading to v2.x
+
+With coreMQTT versions v2.x, there are breaking changes. Please refer to the
+[coreMQTT version v2.x Migration Guide](MigrationGuide.md).
+
+## Upgrading to v3.0.0 and above
 
-With coreMQTT versions >=v2.0.0, there are breaking changes. Please refer to the
-[coreMQTT version >=v2.0.0 Migration Guide](MigrationGuide.md).
+With coreMQTT versions >=v3.0.0, there are breaking changes. Please refer to the
+[coreMQTT version >=v3.0.0 Migration Guide](MigrationGuide.md)
 
 ## Building the Library
 

diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile
@@ -54,7 +54,7 @@ PROJECT_NUMBER         = v2.3.1+
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "MQTT 3.1.1 Client Library"
+PROJECT_BRIEF          = "MQTT 5.0 Client Library"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55

diff --git a/docs/doxygen/include/size_table.md b/docs/doxygen/include/size_table.md
@@ -9,8 +9,8 @@
     </tr>
     <tr>
         <td>core_mqtt.c</td>
-        <td><center>4.9K</center></td>
-        <td><center>4.2K</center></td>
+        <td><center>7.0K</center></td>
+        <td><center>6.1K</center></td>
     </tr>
     <tr>
         <td>core_mqtt_state.c</td>
@@ -19,12 +19,12 @@
     </tr>
     <tr>
         <td>core_mqtt_serializer.c</td>
-        <td><center>2.9K</center></td>
-        <td><center>2.3K</center></td>
+        <td><center>11.4K</center></td>
+        <td><center>8.1K</center></td>
     </tr>
     <tr>
         <td><b>Total estimates</b></td>
-        <td><b><center>9.5K</center></b></td>
-        <td><b><center>7.8K</center></b></td>
+        <td><b><center>20.1K</center></b></td>
+        <td><b><center>15.5K</center></b></td>
     </tr>
 </table>