Merge branch 'feature/improve_config_and_docs_and_loop_message' into 'master'

feat: improve config and docs and loop message

See merge request esp-components/esp-azure!3

I have tested this change in such and such a way and it works as expected.

Author: ustccw

.gitignore

@@ -1,6 +1,7 @@
 .settings
 .project
 .cproject
+.vscode/
 
 build
 sdkconfig

README.md

@@ -1,13 +1,15 @@
 # A MQTT Demo that Connects ESP device to Azure Cloud 
 
 # Table of Contents
+
 - [Introduction](#introduction)
 - [Preparation](#preparation)
 - [Configuring and Building](#configuring-and-building)
 - [Checking Result](#checking-result)
 - [Troubleshooting](#troubleshooting)
 
 ## Introduction
+
 <a name="Introduction"></a>
 
 Espressif offers a wide range of fully-certified Wi-Fi & BT modules powered by our own advanced SoCs. For more details, see [Espressif Modules](https://www.espressif.com/en/products/hardware/modules).
@@ -23,11 +25,14 @@ Main workflow:
 ## Preparation 
 
 <a name="preparation"></a>
+
 ### 1. Hardware
+
 - An **ubuntu environment** should be set up to build your demo;
 - Any **[ESP device](https://www.espressif.com/en/products/hardware/modules)** can be used to run your demo.
 
 ### 2. Azure IoT Hub
+
 - [Get iothub connection string (primary key)](https://www.azure.cn/en-us/pricing/1rmb-trial-full/?form-type=identityauth) from the Azure IoT Hub, which will be used later. An example can be seen below:
 
 ```
@@ -36,6 +41,7 @@ HostName=yourname-ms-lot-hub.azure-devices.cn;SharedAccessKeyName=iothubowner;Sh
 - For step-by-step instructions, please click [here](doc/IoT_Suite.md).
 
 ### 3. iothub-explorer
+
 - Install [Node.js](https://nodejs.org/en/);  
 - Install [iothub-explorer](https://www.npmjs.com/package/iothub-explorer) with command line `npm install -g iothub-explorer`.
   - If failed, please check [here](http://thinglabs.io/workshop/esp8266/setup-azure-iot-hub/) for more information.
@@ -50,6 +56,7 @@ $ iothub-explorer -V
 After that, you should be able to use iothub-explorer to manage your iot-device.
 
 ### 4. Device Connection String
+
 - login with the **iothub connection string (primary key)** you got earlier with command lines;
 - create your device, and get a **device connection string**. An example can be seen:
 
@@ -60,41 +67,58 @@ After that, you should be able to use iothub-explorer to manage your iot-device.
 For detailed instruction, please click [Here](doc/iothub_explorer.md).
 
 ### 5. SDK
+
 - [AZURE-SDK](https://github.com/espressif/esp-azure) can be implemented to connect your ESP devices to Azure, using MQTT protocol.
 - Espressif SDK
   - For ESP32 platform: [ESP-IDF](https://github.com/espressif/esp-idf)  
   - For ESP8266 platform: [ESP8266_RTOS_SDK](https://github.com/espressif/ESP8266_RTOS_SDK)
 
 ### 6. Compiler
+
 - For ESP32 platform: [Here](https://github.com/espressif/esp-idf/blob/master/README.md)
 - For ESP8266 platform: [Here](https://github.com/espressif/ESP8266_RTOS_SDK/blob/master/README.md)
 
 ## Configuring and Building
 
 <a name="Configuring_and_Building"></a>
 
-### 1. Updating variables
-- Replace the `connectionString` variable with your device connection string in [esp-azure/main/iothub_client_sample_mqtt.c](https://github.com/espressif/esp-azure/blob/master/main/iothub_client_sample_mqtt.c).
+### 1. Cloning Git submodules
 
-```
-static const char* connectionString = '[azure connection string]';
-```
-- The azure connection string contains Hostname, DeviceId, and SharedAccessKey in the format:
+This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for its dependancies. To successfully clone these other repositories, after cloning this repo, use the following command in the root:
 
-```
-"HostName=<host_name>;DeviceId=<device_id>;SharedAccessKey=<device_key>"
+``` bash
+git submodule update --init --recursive
 ```
 
-### 2. Configuring your Wi-Fi and serial port
-- Go to `make menuconfig` -> `Example configuration` to  configure your Wi-Fi SSID and Password; 
+### 2. Configuring your Azure IOT Hub Device Connection String, Wi-Fi and serial port
+
+- Go to `make menuconfig` -> `Example configuration` to configure your Azure IOT Hub Device Connection String, Wi-Fi SSID and Password; 
 - Go to `make menuconfig` -> `Serial flasher config` to configure you serial port.
 
 ### 3. Building your demo and flash to ESP device with `$make flash`.
+
 If failed, please:
+
 - make sure your ESP device had connected to PC with serial port;
 - make sure you have selected the corrected serial port;
   - command `> sudo usermod -a -G dialout $USER` can also be used.
 
+To monitor the device output while running, run 
+
+``` bash
+make monitor
+```
+
+To exit the monitor, hit Control-]
+
+You can also run the build and monitor in onte step and run with multiple compiler threads:
+
+``` bash
+make -j4 flash monitor
+```
+
+This will build with four concurrent build processes to take advantage of more cores on your workstation.
+
 ## Checking Result
 
 <a name="Checking_Result"></a>

main/Kconfig.projbuild

@@ -14,4 +14,15 @@ config WIFI_PASSWORD
 
 		Can be left blank if the network has no security set.
 
+config IOTHUB_CONNECTION_STRING
+    string "IOT Hub Device Connection String"
+	default "HostName=<host_name>;DeviceId=<device_id>;SharedAccessKey=<device_key>"
+	help
+		String containing Hostname, Device Id & Device Key in the format:
+		
+		HostName=<host_name>;DeviceId=<device_id>;SharedAccessKey=<device_key>
+		HostName=<host_name>;DeviceId=<device_id>;SharedAccessSignature=<device_sas_token>
+
+		You can get this from the iothub-explorer CLI or the Azure Portal
+
 endmenu

main/iothub_client_sample_mqtt.c

@@ -4,6 +4,8 @@
 #include <stdio.h>
 #include <stdlib.h>
 
+#include "esp_system.h"
+
 #include "iothub_client.h"
 #include "iothub_message.h"
 #include "azure_c_shared_utility/threadapi.h"
@@ -18,13 +20,15 @@
 /*String containing Hostname, Device Id & Device Key in the format:                         */
 /*  "HostName=<host_name>;DeviceId=<device_id>;SharedAccessKey=<device_key>"                */
 /*  "HostName=<host_name>;DeviceId=<device_id>;SharedAccessSignature=<device_sas_token>"    */
-static const char* connectionString = "";
+#define EXAMPLE_IOTHUB_CONNECTION_STRING CONFIG_IOTHUB_CONNECTION_STRING
+static const char* connectionString = EXAMPLE_IOTHUB_CONNECTION_STRING;
 
 static int callbackCounter;
 static char msgText[1024];
 static char propText[1024];
 static bool g_continueRunning;
-#define MESSAGE_COUNT 5
+
+#define MESSAGE_COUNT 0 // Number of telemetry messages to send before exiting, or 0 to keep sending forever
 #define DOWORK_LOOP_NUM     3
 
 
@@ -108,7 +112,7 @@ void iothub_client_sample_mqtt_run(void)
 	printf("\nFile:%s Compile Time:%s %s\n",__FILE__,__DATE__,__TIME__);
     IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle;
 
-    EVENT_INSTANCE messages[MESSAGE_COUNT];
+    EVENT_INSTANCE messages[MESSAGE_COUNT || 1];
 
     g_continueRunning = true;
     srand((unsigned int)time(NULL));
@@ -153,24 +157,26 @@ void iothub_client_sample_mqtt_run(void)
 
                 do
                 {
-                    if (iterator < MESSAGE_COUNT && (iterator<= callbackCounter))
+                    if ((!MESSAGE_COUNT || (iterator < MESSAGE_COUNT)) && (iterator<= callbackCounter))
                     {
+                        EVENT_INSTANCE *thisMessage = &messages[MESSAGE_COUNT ? iterator : 0];
+
                         sprintf_s(msgText, sizeof(msgText), "{\"deviceId\":\"AirConditionDevice_001\",\"windSpeed\":%.2f}", avgWindSpeed + (rand() % 4 + 2));
                         printf("Ready to Send String:%s\n",(const char*)msgText);
-                        if ((messages[iterator].messageHandle = IoTHubMessage_CreateFromByteArray((const unsigned char*)msgText, strlen(msgText))) == NULL)
+                        if ((thisMessage->messageHandle = IoTHubMessage_CreateFromByteArray((const unsigned char*)msgText, strlen(msgText))) == NULL)
                         {
                             (void)printf("ERROR: iotHubMessageHandle is NULL!\r\n");
                         }
                         else
                         {
-                            messages[iterator].messageTrackingId = iterator;
-                            MAP_HANDLE propMap = IoTHubMessage_Properties(messages[iterator].messageHandle);
+                            thisMessage->messageTrackingId = iterator;
+                            MAP_HANDLE propMap = IoTHubMessage_Properties(thisMessage->messageHandle);
                             (void)sprintf_s(propText, sizeof(propText), "PropMsg_%zu", iterator);
                             if (Map_AddOrUpdate(propMap, "PropName", propText) != MAP_OK)
                             {
                                 (void)printf("ERROR: Map_AddOrUpdate Failed!\r\n");
                             }
-                            if (IoTHubClient_LL_SendEventAsync(iotHubClientHandle, messages[iterator].messageHandle, SendConfirmationCallback, &messages[iterator]) != IOTHUB_CLIENT_OK)
+                            if (IoTHubClient_LL_SendEventAsync(iotHubClientHandle, thisMessage->messageHandle, SendConfirmationCallback, thisMessage) != IOTHUB_CLIENT_OK)
                             {
                                 (void)printf("ERROR: IoTHubClient_LL_SendEventAsync..........FAILED!\r\n");
                             }
@@ -182,7 +188,8 @@ void iothub_client_sample_mqtt_run(void)
                         iterator++;
                     }
                     IoTHubClient_LL_DoWork(iotHubClientHandle);
-                    ThreadAPI_Sleep(1);
+                    printf("Sleeping for 5\n");
+                    ThreadAPI_Sleep(5000);
 
                     // if (callbackCounter>=MESSAGE_COUNT){
                     //     printf("done sending...\n");