MQTTv5 Demo Implementation #1338

adituc · 2025-04-14T06:42:39Z

Upgrading MQTT Demos to support v5 features

Description

This PR adds a demo application to showcase MQTT version 5.0 functionality using the coreMQTT library. It demonstrates establishing a connection with a broker, subscribing to a topic, publishing a message, receiving Incoming publishes, unsubscribing from a topic, and finally disconnecting.
Existing data structures and functions are modified, and some new functions are added.

Test Steps

Checklist:

I have tested my changes. No regression in existing tests.
I have modified and/or added unit-tests to cover the code changes in this Pull Request.

Related Issue

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

DakshitBabbar · 2025-04-14T06:58:11Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

@@ -0,0 +1,1339 @@
+
+
+/*


The v5 demo code should contain a similar licensing information as the previous v3 demo.

DakshitBabbar · 2025-04-14T07:02:13Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+
+/* Demo Specific configs. */
+#include "demo_config.h"
+#include "core_mqtt_config.h"


We do not need to include core_mqtt_config.h explicitly. It will be included through the core_mqtt.h file.

DakshitBabbar · 2025-04-14T07:42:11Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+
+/* MQTT library includes. */
+#include "core_mqtt.h"
+#include "core_mqtt_utils.h"


Once we include core_mqtt_utils.h in the core_mqtt_serializer.h then we do not need to make this extra include here. This will be one less change that the user needs to do while migrating from v3 to v5.

DakshitBabbar · 2025-04-14T07:43:21Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+#define mqttexampleCONNACK_RECV_TIMEOUT_MS                ( 100000U )
+
+/**
+ * @brief The prefix to the topic(s) subscribe(d) to and publish(ed) to in the example.
+ *
+ * The topic name starts with the client identifier to ensure that each demo
+ * interacts with a unique topic name.
+ */
+#define mqttexampleTOPIC_PREFIX                           "test"
+
+/**
+ * @brief The number of topic filters to subscribe.
+ */
+#define mqttexampleTOPIC_COUNT                            ( 2 )
+


Once we are done with the testing, we should change these values back to the original values present in the v3 demo.

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

DakshitBabbar · 2025-04-14T10:20:06Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+    MQTTContext_t xMQTTContext = { 0 };
+    MQTTStatus_t xMQTTStatus;
+    PlaintextTransportStatus_t xNetworkStatus;
+    MQTTConnectProperties_t xProperties;


Given that we have added the MQTTConnectProperties in the Context itself, we do not need this variable here.

Yes, I agree, It has been removed

DakshitBabbar · 2025-04-14T10:21:38Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+    MQTTStatus_t xMQTTStatus;
+    PlaintextTransportStatus_t xNetworkStatus;
+    MQTTConnectProperties_t xProperties;
+    MQTTReasonCodeInfo_t disconnect = { 0 };


Why do we require this MQTTReasonCodeInfo_t disconnect = { 0 }; variable?

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

DakshitBabbar · 2025-04-15T06:05:24Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+    MQTTReasonCodeInfo_t disconnect;
+    PlaintextTransportStatus_t xNetworkStatus;
+    MQTTPublishInfo_t willInfo;
+    MQTTAuthInfo_t auth;


I dont see the disconnect, xNetworkStatus and auth vairables being used in this function. If they are not to be used, we can remove them from here.

DakshitBabbar · 2025-04-15T06:10:05Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+
+
+    MqttPropBuilder_t propBuilder;
+    uint8_t buf[500];


It is a good practice to use macros instead of direct contants, so that the reader of the code (which will be a user in case of a demo) can understand what this macro is for. We should define a macro in this demo file, something like MAX_PROPERTY_BUFFER_LENGTH, and map it to a constant like 500 in this case. The user can change this macro if they wish to.

DakshitBabbar · 2025-04-15T06:15:24Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+
+
+    xResult = MQTTPropAdd_UserProp(&(propBuilder), &xUserProperty);
+    xResult = MQTTPropAdd_ConnSessionExpiry(&(propBuilder), sessionExpiry);


There should be asserts after each of these lines like assert( xResult == MQTTSuccess )

DakshitBabbar · 2025-04-15T06:17:55Z

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

+    //xResult = MQTTPropAdd_ConnAuthMethod(&(propBuilder), "SCRAM-SHA-1 ", 11);
+    //xResult = MQTTPropAdd_ConnAuthData(&(propBuilder), "test", 4);


We should remove all the code that is not needed and is commented out.

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c

…eeRTOS into pooja-main-branch

DakshitBabbar · 2025-06-11T15:28:07Z

The changes in this PR are moved to the PR #1354. Hence closing this PR. Thanks.

Pooja-Toshniwal and others added 16 commits July 18, 2024 14:45

Plain text mqtt version 5 demo

5e23c34

MQTTv5 plain text demo

3c68b44

Point coreMQTT submodule to aditi-fork

89541ae

Add Demo for Subscribe , Unsubscribe , Suback , Unsuback

9565b63

Add demo for Incoming Publish

d2e657b

API change for demo tasks - Connect, Subscribe, Unsubscribe

18d1f34

Demo change for handling ACKs

b963653

ack API changes

74636e7

MQTTV5 Plaintext demo

d5d8fd5

Minor changes

4906102

Add xTopicContext

8115450

Add xTopicContext

9596624

Minor fix

3335993

minor change

d179936

Fix demo according to changed APIs

d669ed7

point to the latest commit

2a04ae8

adituc marked this pull request as draft April 14, 2025 06:44

DakshitBabbar reviewed Apr 14, 2025

View reviewed changes

DakshitBabbar reviewed Apr 15, 2025

View reviewed changes

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c Outdated Show resolved Hide resolved

DakshitBabbar reviewed Apr 15, 2025

View reviewed changes

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c Outdated Show resolved Hide resolved

DakshitBabbar reviewed Apr 15, 2025

View reviewed changes

...OS-Plus/Demo/coreMQTT_Windows_Simulator/MQTTV5_Plain_Text/DemoTasks/PlaintextMQTTExampleV5.c Outdated Show resolved Hide resolved

adituc added 5 commits April 15, 2025 15:17

Minor fix

fbda7d6

Demo refactor

5ba54ec

refactor demos

6ecca0f

basic tls demo

ebea505

keep-alive demo

bb457f0

adituc added 9 commits May 11, 2025 00:24

mutual auth demo

cc00dc1

multitask demo

46b1145

mutual auth with wolfSSL

6222a79

add device defender demo

1caa3c3

add device defender demo

5a26650

Merge branch 'pooja-main-branch' of https://github.com/blipbloping/Fr…

5590a38

…eeRTOS into pooja-main-branch

add fleet provisioning demo

3db1672

add jobs demo

14d07b9

modify device defender demo

10aab18

DakshitBabbar closed this Jun 11, 2025



		xResult = MQTTPropAdd_UserProp(&(propBuilder), &xUserProperty);
		xResult = MQTTPropAdd_ConnSessionExpiry(&(propBuilder), sessionExpiry);

		//xResult = MQTTPropAdd_ConnAuthMethod(&(propBuilder), "SCRAM-SHA-1 ", 11);
		//xResult = MQTTPropAdd_ConnAuthData(&(propBuilder), "test", 4);

MQTTv5 Demo Implementation #1338

MQTTv5 Demo Implementation #1338

Uh oh!

Conversation

adituc commented Apr 14, 2025

Description

Test Steps

Checklist:

Related Issue

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!

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!

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!

Uh oh!

Uh oh!

DakshitBabbar commented Jun 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants