Upgrade MQTT demos to v5 #1942

adituc · 2025-05-20T07:37:36Z

Upgrading MQTT Library to support v5 features

Description of changes:
This PR updates all demo applications in the repository that use MQTT to use MQTT v5.0 instead of MQTT v3.1.1. The goal is to align the demo code with the newer version of the MQTT protocol.

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

DakshitBabbar · 2025-05-20T09:18:44Z

demos/defender/defender_demo_json/demo_config.h

@@ -97,7 +98,7 @@
 * https://docs.aws.amazon.com/iot/latest/developerguide/client-authentication.html
 *
 * @note This certificate should be PEM-encoded.
- *
+ *m 


We should remove any and all changes made in the demo_config.h files unless it is related to the MQTTv5 upgrade.

DakshitBabbar · 2025-05-20T09:31:17Z

demos/mqtt/mqtt_demo_serializer/CMakeLists.txt

@@ -17,6 +17,8 @@ add_executable(
        ${BACKOFF_ALGORITHM_SOURCES}
 )

+target_sources(${DEMO_NAME} PRIVATE ${ROOT_DIR}/libraries/standard/coreMQTT/source/core_mqtt_utils.c)


Instead of adding this file to the cmake files of all the demos, we should add it to the MQTT_SOURCES cmake variable defined in the coreMQTT repository in the file: /mqttFilePaths.cmake

DakshitBabbar · 2025-05-20T09:32:16Z

demos/mqtt/mqtt_demo_serializer/demo_config.h

@@ -66,7 +66,6 @@
 *
 * In general, port 1883 is for unsecured MQTT connections.
 */
-#define BROKER_PORT    1883


All these demo_config.h files should contain these port numbers by default. Hence we should keep them as they are.

DakshitBabbar · 2025-05-20T09:39:37Z

demos/mqtt/mqtt_demo_subscription_manager/mqtt_demo_subscription_manager.c

 {
    assert( pMqttContext != NULL );
    assert( pPacketInfo != NULL );
    assert( pDeserializedInfo != NULL );
-    assert( pDeserializedInfo->packetIdentifier != MQTT_PACKET_ID_INVALID );
+    // assert( pDeserializedInfo->packetIdentifier != MQTT_PACKET_ID_INVALID );


Why is this assert removed?

DakshitBabbar · 2025-05-20T09:43:19Z

Thanks @adituc for this PR. The changes look good to me. We will merge this PR once the coreMQTT release is made and we update the submodule pointer here to the latest release of coreMQTT.

DakshitBabbar · 2025-06-19T05:32:15Z

demos/defender/defender_demo_json/mqtt_operations.c

@@ -343,7 +343,10 @@ static void cleanupOutgoingPublishWithPacketID( uint16_t packetId );
 */
 static void mqttCallback( MQTTContext_t * pMqttContext,


I am aware that you are making these updates but just putting this here so that we do not miss it. We would need to update the event callback signature to the updated one.

DakshitBabbar · 2025-06-19T05:33:14Z

demos/fleet_provisioning/fleet_provisioning_keys_cert/demo_config.h

@@ -85,6 +85,7 @@
 * @note This path is relative from the demo binary created. Update
 * ROOT_CA_CERT_PATH to the absolute path if this demo is executed from elsewhere.
 */
+


Please revert the changes in the demo_config.h files.

DakshitBabbar · 2025-06-19T05:34:57Z

demos/greengrass/greengrass_demo_local_auth/README.md

@@ -99,7 +99,7 @@ openssl x509 -req \

 Deploy the following components to your Greengrass core:
 - aws.greengrass.clientdevices.Auth
- aws.greengrass.clientdevices.mqtt.Moquette
+- aws.greengrass.clientdevices.mqtt.EMQX


Please add a comment here that this update is made because the Moquette broker does not support MQTTv5.

DakshitBabbar · 2025-06-19T05:54:37Z

demos/mqtt/mqtt_demo_basic_tls/mqtt_demo_basic_tls.c

- * @brief The application callback function for getting the incoming publish
- * and incoming acks reported from MQTT library.
+ * @brief The application callback function for handling MQTT events, including incoming publish
+ * messages and acknowledgments reported from the MQTT library.


We might as well need to update the eventcall back to handle incoming disconnects. This callback is written for the v3 code and it did not have incoming disconnects.

DakshitBabbar · 2025-06-19T05:55:11Z

demos/mqtt/mqtt_demo_mutual_auth/demo_config.h

@@ -86,7 +86,7 @@
 * ROOT_CA_CERT_PATH to the absolute path if this demo is executed from elsewhere.
 */
 #ifndef ROOT_CA_CERT_PATH
-    #define ROOT_CA_CERT_PATH    "certificates/AmazonRootCA1.crt"
+    #define ROOT_CA_CERT_PATH    "build/bin/certificates/AmazonRootCA1.crt"


Please revert the changes done to all demo_config.h files.

DakshitBabbar · 2025-06-19T06:04:28Z

demos/mqtt/mqtt_demo_serializer/mqtt_demo_serializer.c

@@ -516,7 +522,7 @@ static int createMQTTConnectionWithBroker( NetworkContext_t * pNetworkContext,
        Clock_SleepMs( MQTT_RESPONSE_WAIT_TIME_MS );
        /* Since TCP socket has timeout, retry until the data is available */
        result = MQTT_GetIncomingPacketTypeAndLength( Plaintext_Recv, pNetworkContext, &incomingPacket );
-        LogInfo( ( "MQTT_GetIncomingPacketTypeAndLength returned: %d\n", result ) );
+        // LogInfo( ( "MQTT_GetIncomingPacketTypeAndLength returned: %d\n", result ) );


For this log statement, please uncomment if needed or remove if not needed.

DakshitBabbar · 2025-06-19T06:05:44Z

demos/mqtt/mqtt_demo_serializer/mqtt_demo_serializer.c

+    connackProperties.maxPacketSize = MQTT_MAX_PACKET_SIZE;
+
+    MQTTPropBuilder_t propBuffer = {0} ;
+    result = MQTT_DeserializeAck( &incomingPacket, NULL, &sessionPresent, NULL, 0, MQTT_MAX_PACKET_SIZE, NULL, &connackProperties );


The signature of this function has also been updated. Please update it here as well.

DakshitBabbar · 2025-06-19T11:14:51Z

demos/mqtt/mqtt_demo_subscription_manager/demo_config.h

@@ -66,7 +66,6 @@
 *
 * In general, port 8883 is for secured MQTT connections.
 */
-#define BROKER_PORT    ( 8883 )


Please revert this change from the demo_config.h file.

DakshitBabbar · 2025-06-19T11:17:36Z

demos/mqtt/mqtt_demo_serializer/mqtt_demo_serializer.c

-        {
-            globalSubAckStatus = ( result == MQTTSuccess );
-            assert( result == MQTTSuccess || result == MQTTServerRefused );
-        }


Why is this check removed? would we update the globalSubackStatus on receiving a puback as well?

adituc added 21 commits May 17, 2025 02:53

Point coreMQTT submodule to my fork and branch

2a5e674

Temporarily point coreMQTT submodule to upstream main branch

d8a4182

point to mqtt-v5

d3da58c

add plaintext demo

545b1b4

add mutual auth demo

db3fa64

add basic tls demo

295b5bb

Temporarily point coreMQTT submodule to upstream main branch

ba43d5c

add serializer demo

2332de7

add subscription manager demo

d4fa9be

add defender demo

7fc1784

add shadow demo

d16cfe5

minor fix

f9d7ce4

Temporarily point coreMQTT submodule to upstream main branch

634dc47

point to mqtt-v5

a9c031a

point to main

5332e1a

add fleet provisioning keys cert

6e47639

point to mqtt-v5

41ffc2f

add fleet provisioning with csr

e1f718a

add greengrass demo

d7c856a

modify demo config

f709067

Add README changes for greengrass demo

4734136

DakshitBabbar reviewed May 20, 2025

View reviewed changes

DakshitBabbar marked this pull request as ready for review May 20, 2025 09:40

modify cmake of the serializer demo

de993cd

DakshitBabbar marked this pull request as draft May 20, 2025 10:36

adituc marked this pull request as ready for review May 26, 2025 07:13

adituc added 3 commits May 28, 2025 10:23

Point submodule pointer to the latest version of MQTTV5

75acbfd

Update Serializer Demo to support v5 features

50bebc3

Point MQTT submodule pointer to the latest commit

0f6d7de

Update coreMQTT submodule pointer

d5a65ed

DakshitBabbar reviewed Jun 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Upgrade MQTT demos to v5 #1942

Upgrade MQTT demos to v5 #1942

Uh oh!

adituc commented May 20, 2025

Uh oh!

DakshitBabbar May 20, 2025

Uh oh!

DakshitBabbar May 20, 2025

Uh oh!

DakshitBabbar May 20, 2025

Uh oh!

DakshitBabbar May 20, 2025

Uh oh!

DakshitBabbar commented May 20, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

DakshitBabbar Jun 19, 2025

Uh oh!

Uh oh!

		@@ -343,7 +343,10 @@ static void cleanupOutgoingPublishWithPacketID( uint16_t packetId );
		*/
		static void mqttCallback( MQTTContext_t * pMqttContext,

Upgrade MQTT demos to v5 #1942

Are you sure you want to change the base?

Upgrade MQTT demos to v5 #1942

Uh oh!

Conversation

adituc commented May 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DakshitBabbar commented May 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!