simplified Quick Connect demo by removing semaphores and adding temperature sensors

Author: rauthsuj

GettingStartedGuide.md

@@ -16,6 +16,7 @@ Once completed, one can progress to the
 &emsp;[2.1 Setup AWS IoT Core](#21-setup-aws-iot-core)<br>
 &emsp;[2.2 Configure the project with the AWS IoT Thing Name and AWS device Endpoint](#22-configure-the-project-with-the-aws-iot-thing-name-and-aws-device-endpoint)<br>
 &emsp;[2.3 Provision the ESP32-C3 with the private key, device certificate and CA certificate in Development Mode](#23-provision-the-esp32-c3-with-the-private-key-device-certificate-and-ca-certificate-in-development-mode)<br>
+&emsp;[2.4 Quick Connect demo](#24-quick-connect-demo)<br>
 
 [3 Build and flash the demo project](#3-build-and-flash-the-demo-project)<br>
 
@@ -154,6 +155,11 @@ python managed_components/espressif__esp_secure_cert_mgr/tools/configure_esp_sec
 
 > **NOTE:** For convenience sake, you could place your key and certificate files under the `main/certs` directory.
 
+### 2.4 Quick Connect demo
+
+The Quick Connect demo differs from other demos as it does not require an AWS account. Refer to the [Getting Started Guide](./main/demo_tasks/quickconnect_v2_demo/GettingStarted.md)
+
+
 ## 3 Build and flash the demo project
 
 Before you build and flash the demo project, if you are setting up the ESP32-C3

main/CMakeLists.txt

@@ -17,7 +17,6 @@ endif()
 if(CONFIG_GRI_ENABLE_QUICKCONNECT_V2_DEMO)
     list(APPEND MAIN_SRCS 
         "demo_tasks/quickconnect_v2_demo/quickconnect_v2_demo.c"
-        "demo_tasks/temp_sub_pub_and_led_control_demo/hardware_drivers/app_driver.c"
     )
 endif()
 
@@ -65,6 +64,7 @@ set(MAIN_REQUIRES
     FreeRTOS-Libraries-Integration-Tests
     unity
     driver
+    esp_driver_tsens
 )
 
 idf_component_register(

main/Kconfig.projbuild

@@ -258,6 +258,35 @@ menu "Featured FreeRTOS IoT Integration"
         depends on !GRI_RUN_QUALIFICATION_TEST
         default n
 
+    menu "Quick connect V2 demo configurations"
+        depends on GRI_ENABLE_QUICKCONNECT_V2_DEMO
+
+        config GRI_QUICKCONNECT_V2_DEMO_STRING_BUFFER_LENGTH
+            int "Topic name and payload buffer length"
+            default 700
+            help
+                Size of statically allocated buffers for holding topic names and payloads.
+
+        config GRI_QUICKCONNECT_V2_DEMO_DELAY_BETWEEN_PUB_LOOPS_MS
+            int "Delay between publish loops in milliseconds"
+            default 1000
+            help
+                Delay for each task between publish loops.
+
+        config GRI_QUICKCONNECT_V2_DEMO_MAX_COMMAND_SEND_BLOCK_TIME_MS
+            int "coreMQTT-Agent command post block time in milliseconds."
+            default 500
+            help
+                The maximum amount of time in milliseconds to wait for the commands to be posted to the MQTT agent should the MQTT agent's command queue be full. Tasks wait in the Blocked state, so don't use any CPU time.
+
+        config GRI_QUICKCONNECT_V2_DEMO_TASK_STACK_SIZE
+            int "Quick connect task stack size."
+            default 3072
+            help
+                The task stack size for each of the Quick Connect tasks.
+
+    endmenu # Quick connect V2 demo configurations
+
     config GRI_ENABLE_SUB_PUB_UNSUB_DEMO
         bool "Enable pub sub unsub demo"
         depends on !GRI_RUN_QUALIFICATION_TEST && !GRI_ENABLE_QUICKCONNECT_V2_DEMO

main/demo_tasks/quickconnect_v2_demo/GettingStartedWithQuickConnect.md renamed to main/demo_tasks/quickconnect_v2_demo/GettingStarted.md

@@ -24,11 +24,11 @@ For hardware and software requirements, refer to sections [1.1 Hardware Requirem
 
 ### 2.1 Get credentials from Quick Connect V2
 
-To get credentials for your device (Thing), visit [Quick Connect Credentials](https://quickconnect.iot.aws.dev/credentials) page and enter a desired device name (Thing Name) in the `Vend Credentials` section, and click the Vend button. Download both the `.crt` and `.key` files. These are your **PEM-encoded device certificate** and **PEM-encoded private key**. (An explanation of these entities is given in the [AWS IoT Core Setup Guide](AWSSetup.md).)
+To get credentials for your device (Thing), visit [Quick Connect Credentials](https://quickconnect.freertos.aws.com/credentials) page and enter a desired device name (Thing Name) in the `Vend Credentials` section, and click the Vend button. Download both the `.crt` and `.key` files. These are your **PEM-encoded device certificate** and **PEM-encoded private key**. (An explanation of these entities is given in the [AWS IoT Core Setup Guide](AWSSetup.md).)
 
 ### 2.2 Configure the project with the AWS IoT Thing Name and AWS device Endpoint
 
-The **AWS device Endpoint** is provided on the [Quick Connect Examples](https://quickconnect.iot.aws.dev) page.
+The **AWS device Endpoint** is provided on the [Quick Connect Examples](https://quickconnect.freertos.aws.com/examples) page.
 
 Follow the [2.2 Configure the project](../../../GettingStartedGuide.md#22-configure-the-project-with-the-aws-iot-thing-name-and-aws-device-endpoint) section in the [Getting Started Guide](../../../GettingStartedGuide.md) to configure your project.
 
@@ -49,6 +49,9 @@ For complete provisioning instructions, follow the [2.3 Provision the ESP32-C3](
 
 For build and flash instructions, follow [3 Build and flash](../../../GettingStartedGuide.md#3-build-and-flash-the-demo-project) section of the [Getting Started Guide](../../../GettingStartedGuide.md).
 
+**NOTE:** If you encounter a ***stack overflow in task CoreMqttAgentCo has been detected*** <br>
+run `idf.py menuconfig`. navigate to Featured FreeRTOS IoT Integration → coreMQTT-Agent Manager Configurations, and increse the `coreMQTT-Agent task stack size` and `Connection handling task stack size` from their default values.
+
 ## 4 Monitoring the demo
 
 1. On the serial terminal console, confirm that the TLS connection was
@@ -72,6 +75,6 @@ I (5175) coreMQTT: State record updated. New state=MQTTPublishDone.
 
 ```
 
-2. On the [Quick Connect Visualizer](https://quickconnect.iot.aws.dev/visualizer) page, enter your device name (Thing name) in the `Visualizing device data` section, then confirm that the MQTT messages from the device are being received and a graph is being displayed.
+2. On the [Quick Connect Visualizer](https://quickconnect.freertos.aws.com/visualizer) page, enter your device name (Thing name) in the `Visualizing device data` section, then confirm that the MQTT messages from the device are being received and a graph is being displayed.
 
-**Note**: This demo sends data in line graph format only. For other data visualization formats, refer to the [Quick Connect](https://quickconnect.iot.aws.dev/) documentation.
+**Note**: This demo sends data in line graph format only. For other data visualization formats, refer to the [Quick Connect](https://quickconnect.freertos.aws.com/examples) documentation.

main/demo_tasks/quickconnect_v2_demo/quickconnect_v2_demo.c

@@ -79,6 +79,7 @@
 
 /* Hardware drivers include. */
 #include "app_driver.h"
+#include "driver/temperature_sensor.h"
 
 /* coreMQTT-Agent manager configurations include. */
 #include "core_mqtt_agent_manager_config.h"
@@ -126,27 +127,26 @@ static const char * TAG = "quickconnect_v2_demo";
 extern MQTTAgentContext_t xGlobalMqttAgentContext;
 
 /**
- * @brief The buffer to hold the topic filter. The topic is generated at runtime
- * by adding the task names.
+ * @brief The buffer to hold the topic filter. 
+ Topic filter value will be the Thing-Name. 
  *
  */
-static char topicBuf[ quickconnectv2configNUM_TASKS_TO_CREATE ][ quickconnectv2configSTRING_BUFFER_LENGTH ];
+static char topicBuf[ 1 ][ quickconnectv2configSTRING_BUFFER_LENGTH ];
 
 /**
  * @brief The event group used to manage coreMQTT-Agent events.
  */
 static EventGroupHandle_t xNetworkEventGroup;
 
 /**
- * @brief The semaphore used to lock access to ulMessageID to eliminate a race
- * condition in which multiple tasks try to increment/get ulMessageID.
+ * @brief The message ID for the next message sent by this demo.
  */
-static SemaphoreHandle_t xMessageIdSemaphore;
+static uint32_t ulMessageId = 0;
 
 /**
- * @brief The message ID for the next message sent by this demo.
+ * @brief Temperature sensor handle.
  */
-static uint32_t ulMessageId = 0;
+static temperature_sensor_handle_t temp_sensor = NULL;
 
 /* Static function declarations ***********************************************/
 
@@ -264,8 +264,6 @@ static void prvPublishToTopic( MQTTQoS_t xQoS,
                                char * pcPayload,
                                EventGroupHandle_t xMqttEventGroup )
 {
-    uint32_t ulPublishMessageId = 0;
-
     MQTTStatus_t xCommandAdded;
     EventBits_t xReceivedEvent = 0;
 
@@ -276,18 +274,8 @@ static void prvPublishToTopic( MQTTQoS_t xQoS,
 
     xTaskNotifyStateClear( NULL );
 
-    /* Create a unique number for the publish that is about to be sent.
-     * This number is used in the command context and is sent back to this task
-     * as a notification in the callback that's executed upon receipt of the
-     * publish from coreMQTT-Agent.
-     * That way this task can match an acknowledgment to the message being sent.
-     */
-    xSemaphoreTake( xMessageIdSemaphore, portMAX_DELAY );
-    {
-        ++ulMessageId;
-        ulPublishMessageId = ulMessageId;
-    }
-    xSemaphoreGive( xMessageIdSemaphore );
+    /* Increment Message Id */
+    ++ulMessageId;
 
     /* Configure the publish operation. The topic name string must persist for
      * duration of publish! */
@@ -321,7 +309,7 @@ static void prvPublishToTopic( MQTTQoS_t xQoS,
                   pcTaskGetName( NULL ),
                   pcPayload,
                   pcTopicName,
-                  ulPublishMessageId );
+                  ulMessageId );
 
         xCommandAdded = MQTTAgent_Publish( &xGlobalMqttAgentContext,
                                            &xPublishInfo,
@@ -334,7 +322,7 @@ static void prvPublishToTopic( MQTTQoS_t xQoS,
             ESP_LOGI( TAG,
                       "Task \"%s\" waiting for publish %" PRIu32 " to complete.",
                       pcTaskGetName( NULL ),
-                      ulPublishMessageId );
+                      ulMessageId );
 
             xReceivedEvent = prvWaitForEvent( xMqttEventGroup,
                                               MQTT_PUBLISH_COMMAND_COMPLETED_BIT );
@@ -353,13 +341,13 @@ static void prvPublishToTopic( MQTTQoS_t xQoS,
         {
             ESP_LOGW( TAG,
                       "Error or timed out waiting for ack for publish message %" PRIu32 ". Re-attempting publish.",
-                      ulPublishMessageId );
+                      ulMessageId );
         }
         else
         {
             ESP_LOGI( TAG,
                       "Publish %" PRIu32 " succeeded for task \"%s\".",
-                      ulPublishMessageId,
+                      ulMessageId,
                       pcTaskGetName( NULL ) );
         }
     } while( ( xReceivedEvent & MQTT_PUBLISH_COMMAND_COMPLETED_BIT ) == 0 ||
@@ -380,22 +368,32 @@ static void prvQuickConnectV2Task( void * pvParameters )
 
     xMqttEventGroup = xEventGroupCreate();
 
-    xQoS = ( MQTTQoS_t ) quickconnectv2configQOS_LEVEL;
+    /* The MQTT QoS value is set to 1 */
+    xQoS = ( MQTTQoS_t ) 1;
 
     /* Take the topic name from thing name. */
     snprintf( pcTopicBuffer,
               quickconnectv2configSTRING_BUFFER_LENGTH,
               "%s",
               configCLIENT_IDENTIFIER );
 
+    /* Initialize temperature sensor */
+    temperature_sensor_config_t temp_sensor_config = TEMPERATURE_SENSOR_CONFIG_DEFAULT(-10, 80);
+    ESP_ERROR_CHECK(temperature_sensor_install(&temp_sensor_config, &temp_sensor));
+    ESP_ERROR_CHECK(temperature_sensor_enable(temp_sensor));
+
     while( 1 )
     {
-        temperatureValue = app_driver_temp_sensor_read_celsius();
+        esp_err_t ret = temperature_sensor_get_celsius(temp_sensor, &temperatureValue);
+        if (ret != ESP_OK) {
+            ESP_LOGE(TAG, "Failed to read temperature: %s", esp_err_to_name(ret));
+            temperatureValue = 25.0; /* Default fallback value */ 
+        }
 
         /* Create Payload in an Array format */
         snprintf( pcPayload,
                   quickconnectv2configSTRING_BUFFER_LENGTH,
-                  "[{\"label\":\"ESP32-S3 MCU Temperature\",\"display_type\":\"line_graph\",\"unit\":\"C\",\"values\":[{\"value\":%.1f,\"label\":\"temp\"}]}]",
+                  "[{\"label\":\"ESP32 MCU Temperature\",\"display_type\":\"line_graph\",\"unit\":\"C\",\"values\":[{\"value\":%.1f,\"label\":\"temp\"}]}]",
                   temperatureValue );
 
         prvPublishToTopic( xQoS,
@@ -422,12 +420,11 @@ static void prvQuickConnectV2Task( void * pvParameters )
 /* Public function definitions ************************************************/
 
 void vStartQuickConnectV2Demo( void )
-{
-    static struct DemoParams pxParams[ quickconnectv2configNUM_TASKS_TO_CREATE ];
-    char pcTaskNameBuf[ 30 ];
+{   /* This is a single task demo*/
+    static struct DemoParams pxParams[ 1 ];
+    char pcTaskNameBuf[ 15 ];
     uint32_t ulTaskNumber;
 
-    xMessageIdSemaphore = xSemaphoreCreateMutex();
     xNetworkEventGroup = xEventGroupCreate();
     xCoreMqttAgentManagerRegisterHandler( prvCoreMqttAgentEventHandler );
 
@@ -439,14 +436,14 @@ void vStartQuickConnectV2Demo( void )
      * name and topic filter for itself from the number passed in as the task
      * parameter. */
     /* Create a few instances of prvQuickConnectV2Task(). */
-    for( ulTaskNumber = 0; ulTaskNumber < quickconnectv2configNUM_TASKS_TO_CREATE; ulTaskNumber++ )
+    for( ulTaskNumber = 0; ulTaskNumber < 1; ulTaskNumber++ )
     {
         memset( pcTaskNameBuf,
                 0x00,
                 sizeof( pcTaskNameBuf ) );
 
         snprintf( pcTaskNameBuf,
-                  30,
+                  10,
                   "DemoTask");
 
         pxParams[ ulTaskNumber ].ulTaskNumber = ulTaskNumber;
@@ -455,7 +452,7 @@ void vStartQuickConnectV2Demo( void )
                      pcTaskNameBuf,
                      quickconnectv2configTASK_STACK_SIZE,
                      ( void * ) &pxParams[ ulTaskNumber ],
-                     quickconnectv2configTASK_PRIORITY,
+                     1, /* Task Priority */
                      NULL );
     }
 }

main/demo_tasks/quickconnect_v2_demo/quickconnect_v2_demo_config.h

@@ -30,10 +30,6 @@
 /* ESP-IDF sdkconfig include. */
 #include <sdkconfig.h>
 
-#if CONFIG_GRI_RUN_QUALIFICATION_TEST
-    #include "qualification_wrapper_config.h"
-#endif /* CONFIG_GRI_RUN_QUALIFICATION_TEST */
-
 /* *INDENT-OFF* */
     #ifdef __cplusplus
         extern "C" {
@@ -44,41 +40,24 @@
  * @brief Size of statically allocated buffers for holding topic names and
  * payloads.
  */
-#define quickconnectv2configSTRING_BUFFER_LENGTH                    ( ( unsigned int ) ( CONFIG_GRI_SUB_PUB_UNSUB_DEMO_STRING_BUFFER_LENGTH ) )
+#define quickconnectv2configSTRING_BUFFER_LENGTH                    ( ( unsigned int ) ( CONFIG_GRI_QUICKCONNECT_V2_DEMO_STRING_BUFFER_LENGTH ) )
 
 /**
  * @brief Delay for each task between each publish.
  */
-#define quickconnectv2configDELAY_BETWEEN_LOOPS_MS    ( ( unsigned int ) ( CONFIG_GRI_SUB_PUB_UNSUB_DEMO_DELAY_BETWEEN_SUB_PUB_UNSUB_LOOPS_MS ) )
+#define quickconnectv2configDELAY_BETWEEN_LOOPS_MS    ( ( unsigned int ) ( CONFIG_GRI_QUICKCONNECT_V2_DEMO_DELAY_BETWEEN_PUB_LOOPS_MS ) )
 
 /**
  * @brief The maximum amount of time in milliseconds to wait for the commands
  * to be posted to the MQTT agent should the MQTT agent's command queue be full.
  * Tasks wait in the Blocked state, so don't use any CPU time.
  */
-#define quickconnectv2configMAX_COMMAND_SEND_BLOCK_TIME_MS          ( ( unsigned int ) ( CONFIG_GRI_SUB_PUB_UNSUB_DEMO_MAX_COMMAND_SEND_BLOCK_TIME_MS ) )
-
-/**
- * @brief The QoS level of MQTT messages sent by this demo. This must be 0 or 1
- * if using AWS as AWS only supports levels 0 or 1. If using another MQTT broker
- * that supports QoS level 2, this can be set to 2.
- */
-#define quickconnectv2configQOS_LEVEL                               ( ( unsigned long ) ( CONFIG_GRI_SUB_PUB_UNSUB_DEMO_QOS_LEVEL ) )
-
-/**
- * @brief The number of Quick Connect Demo tasks to create for this demo.
- */
-#define quickconnectv2configNUM_TASKS_TO_CREATE                     ( ( unsigned long ) ( CONFIG_GRI_SUB_PUB_UNSUB_DEMO_NUM_TASKS_TO_CREATE ) )
-
-/**
- * @brief The task priority of each of the Quick Connect Demo tasks.
- */
-#define quickconnectv2configTASK_PRIORITY                           ( ( unsigned int ) ( CONFIG_GRI_SUB_PUB_UNSUB_DEMO_TASK_PRIORITY ) )
+#define quickconnectv2configMAX_COMMAND_SEND_BLOCK_TIME_MS          ( ( unsigned int ) ( CONFIG_GRI_QUICKCONNECT_V2_DEMO_MAX_COMMAND_SEND_BLOCK_TIME_MS ) )
 
 /**
  * @brief The task stack size for each of the Quick Connect Demo tasks.
  */
-#define quickconnectv2configTASK_STACK_SIZE                         ( ( unsigned int ) ( CONFIG_GRI_SUB_PUB_UNSUB_DEMO_TASK_STACK_SIZE ) )
+#define quickconnectv2configTASK_STACK_SIZE                         ( ( unsigned int ) ( CONFIG_GRI_QUICKCONNECT_V2_DEMO_TASK_STACK_SIZE ) )
 
 /* *INDENT-OFF* */
     #ifdef __cplusplus