MXCHIP guide update to Central (#189)

* Update readme and azure_config.h * fix broken links * remove localization from web links
eclipse-threadx · Feb 4, 2021 · b43f933 · b43f933
1 parent 19d0a2e
commit b43f933
Show file tree

Hide file tree

Showing 26 changed files with 125 additions and 230 deletions.
diff --git a/MXChip/AZ3166/app/azure_config.h b/MXChip/AZ3166/app/azure_config.h
@@ -20,38 +20,38 @@ typedef enum
 #define WIFI_MODE     WPA2_PSK_AES
 
 // ----------------------------------------------------------------------------
-// Azure IoT Hub Connection Transport
-//    Define to use the legacy MQTT connection, else Azure RTOS SDK for Azure IoT
+// Azure IoT Dynamic Provisioning Service
+//    Define this to use the DPS service, otherwise direct IoT Hub
 // ----------------------------------------------------------------------------
-//#define ENABLE_LEGACY_MQTT
+#define ENABLE_DPS
 
 // ----------------------------------------------------------------------------
-// Azure IoT Dynamic Provisioning Service
-//    Define this to use the DPS service, otherwise direct IoT Hub
+// Azure IoT DPS connection config
+//    IOT_DPS_ID_SCOPE:        The DPS ID Scope
+//    IOT_DPS_REGISTRATION_ID: The DPS device Registration Id
+// ----------------------------------------------------------------------------
+#define IOT_DPS_ID_SCOPE        ""
+#define IOT_DPS_REGISTRATION_ID ""
+
+// ----------------------------------------------------------------------------
+// Azure IoT Hub Connection Transport
+//    Define to use the legacy MQTT connection, else Azure RTOS SDK for Azure IoT
 // ----------------------------------------------------------------------------
-//#define ENABLE_DPS
+//#define ENABLE_LEGACY_MQTT
 
 // ----------------------------------------------------------------------------
 // Azure IoT DPS Self-Signed X509Certificate
 //    Define this to connect to DPS or Iot Hub using a X509 certificate
 // ----------------------------------------------------------------------------
-// #define ENABLE_X509
+//#define ENABLE_X509
 
 // ----------------------------------------------------------------------------
 // Azure IoT Hub connection config
 //    IOT_HUB_HOSTNAME:  The Azure IoT Hub hostname
 //    IOT_HUB_DEVICE_ID: The Azure IoT Hub device id
 // ----------------------------------------------------------------------------
-#define IOT_HUB_HOSTNAME  ""
-#define IOT_HUB_DEVICE_ID ""
-
-// ----------------------------------------------------------------------------
-// Azure IoT DPS connection config
-//    IOT_DPS_ID_SCOPE:        The DPS ID Scope
-//    IOT_DPS_REGISTRATION_ID: The DPS device Registration Id
-// ----------------------------------------------------------------------------
-#define IOT_DPS_ID_SCOPE        ""
-#define IOT_DPS_REGISTRATION_ID ""
+//#define IOT_HUB_HOSTNAME  ""
+//#define IOT_HUB_DEVICE_ID ""
 
 // ----------------------------------------------------------------------------
 // Azure IoT device SAS key

diff --git a/MXChip/AZ3166/media/azure-iot-central-device-about.png b/MXChip/AZ3166/media/azure-iot-central-device-about.png
diff --git a/MXChip/AZ3166/media/azure-iot-central-device-telemetry.png b/MXChip/AZ3166/media/azure-iot-central-device-telemetry.png
diff --git a/MXChip/AZ3166/media/azure-iot-central-device-template-migrate.png b/MXChip/AZ3166/media/azure-iot-central-device-template-migrate.png
diff --git a/MXChip/AZ3166/media/azure-iot-central-device-view-status.png b/MXChip/AZ3166/media/azure-iot-central-device-view-status.png
diff --git a/MXChip/AZ3166/media/azure-iot-central-invoke-method.png b/MXChip/AZ3166/media/azure-iot-central-invoke-method.png
diff --git a/MXChip/AZ3166/media/azure-iot-explorer-create-connection.png b/MXChip/AZ3166/media/azure-iot-explorer-create-connection.png
diff --git a/MXChip/AZ3166/media/azure-iot-explorer-device-identity.png b/MXChip/AZ3166/media/azure-iot-explorer-device-identity.png
diff --git a/MXChip/AZ3166/media/azure-iot-explorer-device-telemetry.png b/MXChip/AZ3166/media/azure-iot-explorer-device-telemetry.png
diff --git a/MXChip/AZ3166/media/azure-iot-explorer-invoke-method.png b/MXChip/AZ3166/media/azure-iot-explorer-invoke-method.png
diff --git a/MXChip/AZ3166/media/com_port.png b/MXChip/AZ3166/media/com_port.png
diff --git a/MXChip/AZ3166/media/iotcentralcreate-custom.png b/MXChip/AZ3166/media/iotcentralcreate-custom.png
diff --git a/MXChip/AZ3166/media/iotcentralcreate-device.png b/MXChip/AZ3166/media/iotcentralcreate-device.png
diff --git a/MXChip/AZ3166/media/iotcentraldevice-connection-info.png b/MXChip/AZ3166/media/iotcentraldevice-connection-info.png
diff --git a/MXChip/AZ3166/readme.md b/MXChip/AZ3166/readme.md
diff --git a/NXP/MIMXRT1050-EVKB/readme.md b/NXP/MIMXRT1050-EVKB/readme.md
@@ -59,7 +59,7 @@ The cloned repo contains a setup script that installs and configures the require
 > * [GCC](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm): Compile
 > * [CMake](https://cmake.org): Build
 > * [Termite](https://www.compuphase.com/software_termite.htm): Monitor serial port output for connected devices
-> * [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/): Manage Azure resources
+> * [Azure CLI](https://docs.microsoft.com/cli/azure/): Manage Azure resources
 > * [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform utility to  monitor and manage Azure IoT resources
 
 To install the tools:
@@ -109,7 +109,7 @@ In this section, you create a new device instance and register it with the IoT h
 
 To register a device:
 
-1. In your console, run the [az iot hub device-identity create](https://docs.microsoft.com/cli/azure/ext/azure-cli-iot-ext/iot/hub/device-identity?view=azure-cli-latest#ext-azure-cli-iot-ext-az-iot-hub-device-identity-create) command. This creates the simulated device identity.
+1. In your console, run the [az iot hub device-identity create](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext_azure_iot_az_iot_hub_device_identity_create) command. This creates the simulated device identity.
 
     *YourIotHubName*. Replace this placeholder below with the name you chose for your IoT hub.
 
@@ -233,7 +233,7 @@ You can use the Azure IoT Explorer to view and manage the properties of your dev
 
 To add a connection to your IoT hub:
 
-1. In your console window, run the [az iot hub show-connection-string](https://docs.microsoft.com/en-us/cli/azure/iot/hub?view=azure-cli-latest#az-iot-hub-show-connection-string) command to get the connection string for your IoT hub.
+1. In your console window, run the [az iot hub show-connection-string](https://docs.microsoft.com/cli/azure/iot/hub?view=azure-cli-latest#az_iot_hub_show_connection_string) command to get the connection string for your IoT hub.
 
     ```shell
     az iot hub show-connection-string --name {YourIoTHubName}
@@ -259,7 +259,7 @@ To view device properties using Azure IoT Explorer:
 
 To use Azure CLI to view device properties:
 
-1. Run the [az iot hub device-identity show](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext-azure-iot-az-iot-hub-device-identity-show) command.
+1. Run the [az iot hub device-identity show](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext_azure_iot_az_iot_hub_device_identity_show) command.
 
     ```shell
     az iot hub device-identity show --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -285,7 +285,7 @@ To view telemetry in Azure IoT Explorer:
 
 To use Azure CLI to view device telemetry:
 
-1. In your CLI console, run the [az iot hub monitor-events](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext-azure-iot-az-iot-hub-monitor-events) command. Use the names that you created previously in Azure IoT for your device and IoT hub.
+1. In your CLI console, run the [az iot hub monitor-events](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext_azure_iot_az_iot_hub_monitor_events) command. Use the names that you created previously in Azure IoT for your device and IoT hub.
 
     ```shell
     az iot hub monitor-events --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -322,7 +322,7 @@ To call a method in Azure IoT Explorer:
 
 To use Azure CLI to call a method:
 
-1. Run the [az iot hub invoke-device-method](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext-azure-iot-az-iot-hub-invoke-device-method) command, and specify the method name and payload. For this method, setting `method-payload` to `true` turns the LED on, and setting it to `false` turns it off.
+1. Run the [az iot hub invoke-device-method](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext_azure_iot_az_iot_hub_invoke_device_method) command, and specify the method name and payload. For this method, setting `method-payload` to `true` turns the LED on, and setting it to `false` turns it off.
 
     <!-- Inline code tag and CSS to wrap long code lines. -->
     <code style="white-space : pre-wrap !important;">

diff --git a/NXP/MIMXRT1060-EVK/readme.md b/NXP/MIMXRT1060-EVK/readme.md
@@ -59,7 +59,7 @@ The cloned repo contains a setup script that installs and configures the require
 > * [GCC](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm): Compile
 > * [CMake](https://cmake.org): Build
 > * [Termite](https://www.compuphase.com/software_termite.htm): Monitor serial port output for connected devices
-> * [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/): Manage Azure resources
+> * [Azure CLI](https://docs.microsoft.com/cli/azure/): Manage Azure resources
 > * [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform utility to  monitor and manage Azure IoT resources
 
 To install the tools:
@@ -109,7 +109,7 @@ In this section, you create a new device instance and register it with the IoT h
 
 To register a device:
 
-1. In your console, run the [az iot hub device-identity create](https://docs.microsoft.com/cli/azure/ext/azure-cli-iot-ext/iot/hub/device-identity?view=azure-cli-latest#ext-azure-cli-iot-ext-az-iot-hub-device-identity-create) command. This creates the simulated device identity.
+1. In your console, run the [az iot hub device-identity create](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext_azure_iot_az_iot_hub_device_identity_create) command. This creates the simulated device identity.
 
     *YourIotHubName*. Replace this placeholder below with the name you chose for your IoT hub.
 
@@ -233,7 +233,7 @@ You can use the Azure IoT Explorer to view and manage the properties of your dev
 
 To add a connection to your IoT hub:
 
-1. In your console window, run the [az iot hub show-connection-string](https://docs.microsoft.com/en-us/cli/azure/iot/hub?view=azure-cli-latest#az-iot-hub-show-connection-string) command to get the connection string for your IoT hub.
+1. In your console window, run the [az iot hub show-connection-string](https://docs.microsoft.com/cli/azure/iot/hub?view=azure-cli-latest#az_iot_hub_show_connection_string) command to get the connection string for your IoT hub.
 
     ```shell
     az iot hub show-connection-string --name {YourIoTHubName}
@@ -259,7 +259,7 @@ To view device properties using Azure IoT Explorer:
 
 To use Azure CLI to view device properties:
 
-1. Run the [az iot hub device-identity show](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext-azure-iot-az-iot-hub-device-identity-show) command.
+1. Run the [az iot hub device-identity show](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext_azure_iot_az_iot_hub_device_identity_show) command.
 
     ```shell
     az iot hub device-identity show --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -285,7 +285,7 @@ To view telemetry in Azure IoT Explorer:
 
 To use Azure CLI to view device telemetry:
 
-1. In your CLI console, run the [az iot hub monitor-events](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext-azure-iot-az-iot-hub-monitor-events) command. Use the names that you created previously in Azure IoT for your device and IoT hub.
+1. In your CLI console, run the [az iot hub monitor-events](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext_azure_iot_az_iot_hub_monitor_events) command. Use the names that you created previously in Azure IoT for your device and IoT hub.
 
     ```shell
     az iot hub monitor-events --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -322,7 +322,7 @@ To call a method in Azure IoT Explorer:
 
 To use Azure CLI to call a method:
 
-1. Run the [az iot hub invoke-device-method](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext-azure-iot-az-iot-hub-invoke-device-method) command, and specify the method name and payload. For this method, setting `method-payload` to `true` turns the LED on, and setting it to `false` turns it off.
+1. Run the [az iot hub invoke-device-method](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext_azure_iot_az_iot_hub_invoke_device_method) command, and specify the method name and payload. For this method, setting `method-payload` to `true` turns the LED on, and setting it to `false` turns it off.
 
     <!-- Inline code tag and CSS to wrap long code lines. -->
     <code style="white-space : pre-wrap !important;">

diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 This Getting Started guides shows device developers how to start working with Azure RTOS. Each guide will step through from installation of the required toolchain, to connecting the device to Azure IoT Hub using IoT Plug and Play.
 
 * Refer to [Getting Started with Azure RTOS](https://go.microsoft.com/fwlink/p/?linkid=2129824) for additional information on the guides and Azure RTOS.
-* Refer to [IoT Plug and Play](https://docs.microsoft.com/en-us/azure/iot-pnp) for information on the Iot Plug and Play Preview Refresh.
+* Refer to [IoT Plug and Play](https://docs.microsoft.com/azure/iot-pnp) for information on the Iot Plug and Play Preview Refresh.
 * Ask questions on the [Azure RTOS Q&A](https://aka.ms/QnA/azure-rtos) site.
 
 ## Getting Started Guides

diff --git a/Renesas/RSK_RX65N_2MB/readme.md b/Renesas/RSK_RX65N_2MB/readme.md
@@ -61,7 +61,7 @@ The cloned repo contains a setup script that installs and configures the require
 > * [GCC](http://gcc-renesas.com/downloads/get.php?f=rx/8.3.0.202004-gnurx/gcc-8.3.0.202004-GNURX-ELF.exe): Compile
 > * [CMake](https://cmake.org): Build
 > * [Termite](https://www.compuphase.com/software_termite.htm): Monitor serial port output for connected devices
-> * [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/): Manage Azure resources
+> * [Azure CLI](https://docs.microsoft.com/cli/azure/): Manage Azure resources
 > * [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform utility to  monitor and manage Azure IoT resources
 
 To install the tools:
@@ -121,7 +121,7 @@ In this section, you create a new device instance and register it with the IoT h
 
 To register a device:
 
-1. In your console, run the [az iot hub device-identity create](https://docs.microsoft.com/cli/azure/ext/azure-cli-iot-ext/iot/hub/device-identity?view=azure-cli-latest#ext-azure-cli-iot-ext-az-iot-hub-device-identity-create) command. This creates the simulated device identity.
+1. In your console, run the [az iot hub device-identity create](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext_azure_iot_az_iot_hub_device_identity_create) command. This creates the simulated device identity.
 
     *YourIotHubName*. Replace this placeholder below with the name you chose for your IoT hub.
 
@@ -274,7 +274,7 @@ You can use the Azure IoT Explorer to view and manage the properties of your dev
 
 To add a connection to your IoT hub:
 
-1. In your console window, run the [az iot hub show-connection-string](https://docs.microsoft.com/en-us/cli/azure/iot/hub?view=azure-cli-latest#az-iot-hub-show-connection-string) command to get the connection string for your IoT hub.
+1. In your console window, run the [az iot hub show-connection-string](https://docs.microsoft.com/cli/azure/iot/hub?view=azure-cli-latest#az_iot_hub_show_connection_string) command to get the connection string for your IoT hub.
 
     ```shell
     az iot hub show-connection-string --name {YourIoTHubName}
@@ -300,7 +300,7 @@ To view device properties using Azure IoT Explorer:
 
 To use Azure CLI to view device properties:
 
-1. Run the [az iot hub device-identity show](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext-azure-iot-az-iot-hub-device-identity-show) command.
+1. Run the [az iot hub device-identity show](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub/device-identity?view=azure-cli-latest#ext_azure_iot_az_iot_hub_device_identity_show) command.
 
     ```shell
     az iot hub device-identity show --device-id MyRenesasDevice --hub-name {YourIoTHubName}
@@ -326,7 +326,7 @@ To view telemetry in Azure IoT Explorer:
 
 To use Azure CLI to view device telemetry:
 
-1. In your CLI console, run the [az iot hub monitor-events](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext-azure-iot-az-iot-hub-monitor-events) command. Use the names that you created previously in Azure IoT for your device and IoT hub.
+1. In your CLI console, run the [az iot hub monitor-events](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext_azure_iot_az_iot_hub_monitor_events) command. Use the names that you created previously in Azure IoT for your device and IoT hub.
 
     ```shell
     az iot hub monitor-events --device-id MyRenesasDevice --hub-name {YourIoTHubName}
@@ -363,7 +363,7 @@ To call a method in Azure IoT Explorer:
 
 To use Azure CLI to call a method:
 
-1. Run the [az iot hub invoke-device-method](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext-azure-iot-az-iot-hub-invoke-device-method) command, and specify the method name and payload. For this method, setting `method-payload` to `true` turns the LEDs on, and setting it to `false` turns them off.
+1. Run the [az iot hub invoke-device-method](https://docs.microsoft.com/cli/azure/ext/azure-iot/iot/hub?view=azure-cli-latest#ext_azure_iot_az_iot_hub_invoke_device_method) command, and specify the method name and payload. For this method, setting `method-payload` to `true` turns the LEDs on, and setting it to `false` turns them off.
 
     <!-- Inline code tag and CSS to wrap long code lines. -->
     <code style="white-space : pre-wrap !important;">

diff --git a/SECURITY.md b/SECURITY.md
@@ -2,15 +2,15 @@
 
 Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
 
-If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
 
 ## Reporting Security Issues
 
 **Please do not report security vulnerabilities through public GitHub issues.**
 
 Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
 
-If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]).  If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]).  If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/msrc/pgp-key-msrc).
 
 You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
 
@@ -32,4 +32,4 @@ We prefer all communications to be in English.
 
 ## Policy
 
-Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/msrc/cvd).
diff --git a/STMicroelectronics/STM32L4_L4+/readme.md b/STMicroelectronics/STM32L4_L4+/readme.md
@@ -19,9 +19,9 @@ In this tutorial you use Azure RTOS to connect either the STMicroelectronics [B-
 
 You will complete the following tasks:
 
-* Install a set of embedded development tools for programming the STM DevKit in C.
-* Build an image and flash it onto the STM DevKit.
-* Use Azure IoT Central to create cloud components, view properties, view device telemetry, and call direct commands.
+* Install a set of embedded development tools for programming the STM DevKit in C
+* Build an image and flash it onto the STM DevKit
+* Use Azure IoT Central to create cloud components, view properties, view device telemetry, and call direct commands
 
 ## Prerequisites
 

diff --git a/core/src/azure_iot_mqtt/azure_iot_dps_mqtt.c b/core/src/azure_iot_mqtt/azure_iot_dps_mqtt.c
@@ -1,7 +1,7 @@
 /* Copyright (c) Microsoft Corporation.
    Licensed under the MIT License. */
 
-// https://docs.microsoft.com/en-us/azure/iot-dps/iot-dps-mqtt-support
+// https://docs.microsoft.com/azure/iot-dps/iot-dps-mqtt-support
 
 #include <string.h>