Skip to content

Commit b43f933

Browse files
ryanwinterryanwinter
authored
MXCHIP guide update to Central (#189)
* Update readme and azure_config.h * fix broken links * remove localization from web links
1 parent 19d0a2e commit b43f933

26 files changed

+125
-230
lines changed

‎MXChip/AZ3166/app/azure_config.h

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,38 +20,38 @@ typedef enum
2020
#define WIFI_MODE WPA2_PSK_AES
2121

2222
// ----------------------------------------------------------------------------
23-
// Azure IoT Hub Connection Transport
24-
// Define to use the legacy MQTT connection, else Azure RTOS SDK for Azure IoT
23+
// Azure IoT Dynamic Provisioning Service
24+
// Define this to use the DPS service, otherwise direct IoT Hub
2525
// ----------------------------------------------------------------------------
26-
//#define ENABLE_LEGACY_MQTT
26+
#define ENABLE_DPS
2727

2828
// ----------------------------------------------------------------------------
29-
// Azure IoT Dynamic Provisioning Service
30-
// Define this to use the DPS service, otherwise direct IoT Hub
29+
// Azure IoT DPS connection config
30+
// IOT_DPS_ID_SCOPE: The DPS ID Scope
31+
// IOT_DPS_REGISTRATION_ID: The DPS device Registration Id
32+
// ----------------------------------------------------------------------------
33+
#define IOT_DPS_ID_SCOPE ""
34+
#define IOT_DPS_REGISTRATION_ID ""
35+
36+
// ----------------------------------------------------------------------------
37+
// Azure IoT Hub Connection Transport
38+
// Define to use the legacy MQTT connection, else Azure RTOS SDK for Azure IoT
3139
// ----------------------------------------------------------------------------
32-
//#define ENABLE_DPS
40+
//#define ENABLE_LEGACY_MQTT
3341

3442
// ----------------------------------------------------------------------------
3543
// Azure IoT DPS Self-Signed X509Certificate
3644
// Define this to connect to DPS or Iot Hub using a X509 certificate
3745
// ----------------------------------------------------------------------------
38-
// #define ENABLE_X509
46+
//#define ENABLE_X509
3947

4048
// ----------------------------------------------------------------------------
4149
// Azure IoT Hub connection config
4250
// IOT_HUB_HOSTNAME: The Azure IoT Hub hostname
4351
// IOT_HUB_DEVICE_ID: The Azure IoT Hub device id
4452
// ----------------------------------------------------------------------------
45-
#define IOT_HUB_HOSTNAME ""
46-
#define IOT_HUB_DEVICE_ID ""
47-
48-
// ----------------------------------------------------------------------------
49-
// Azure IoT DPS connection config
50-
// IOT_DPS_ID_SCOPE: The DPS ID Scope
51-
// IOT_DPS_REGISTRATION_ID: The DPS device Registration Id
52-
// ----------------------------------------------------------------------------
53-
#define IOT_DPS_ID_SCOPE ""
54-
#define IOT_DPS_REGISTRATION_ID ""
53+
//#define IOT_HUB_HOSTNAME ""
54+
//#define IOT_HUB_DEVICE_ID ""
5555

5656
// ----------------------------------------------------------------------------
5757
// Azure IoT device SAS key

‎MXChip/AZ3166/media/azure-iot-central-device-about.png

72.1 KB
Loading

‎MXChip/AZ3166/media/azure-iot-central-device-telemetry.png

64.4 KB
Loading

‎MXChip/AZ3166/media/azure-iot-central-device-template-migrate.png

8.31 KB
Loading

‎MXChip/AZ3166/media/azure-iot-central-device-view-status.png

18 KB
Loading

‎MXChip/AZ3166/media/azure-iot-central-invoke-method.png

53.2 KB
Loading

‎MXChip/AZ3166/media/azure-iot-explorer-create-connection.png

-70.2 KB
Binary file not shown.

‎MXChip/AZ3166/media/azure-iot-explorer-device-identity.png

-99.6 KB
Binary file not shown.

‎MXChip/AZ3166/media/azure-iot-explorer-device-telemetry.png

-84.1 KB
Binary file not shown.

‎MXChip/AZ3166/media/azure-iot-explorer-invoke-method.png

-67.6 KB
Binary file not shown.

‎MXChip/AZ3166/media/com_port.png

-21.1 KB
Binary file not shown.

‎MXChip/AZ3166/media/iotcentralcreate-custom.png

68.2 KB
Loading

‎MXChip/AZ3166/media/iotcentralcreate-device.png

24.2 KB
Loading

‎MXChip/AZ3166/media/iotcentraldevice-connection-info.png

33.5 KB
Loading

‎MXChip/AZ3166/readme.md

Lines changed: 73 additions & 178 deletions
Large diffs are not rendered by default.

‎NXP/MIMXRT1050-EVKB/readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The cloned repo contains a setup script that installs and configures the require
5959
> * [GCC](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm): Compile
6060
> * [CMake](https://cmake.org): Build
6161
> * [Termite](https://www.compuphase.com/software_termite.htm): Monitor serial port output for connected devices
62-
> * [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/): Manage Azure resources
62+
> * [Azure CLI](https://docs.microsoft.com/cli/azure/): Manage Azure resources
6363
> * [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform utility to monitor and manage Azure IoT resources
6464
6565
To install the tools:
@@ -109,7 +109,7 @@ In this section, you create a new device instance and register it with the IoT h
109109

110110
To register a device:
111111

112-
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.
112+
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.
113113

114114
*YourIotHubName*. Replace this placeholder below with the name you chose for your IoT hub.
115115

@@ -233,7 +233,7 @@ You can use the Azure IoT Explorer to view and manage the properties of your dev
233233

234234
To add a connection to your IoT hub:
235235

236-
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.
236+
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.
237237

238238
```shell
239239
az iot hub show-connection-string --name {YourIoTHubName}
@@ -259,7 +259,7 @@ To view device properties using Azure IoT Explorer:
259259

260260
To use Azure CLI to view device properties:
261261

262-
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.
262+
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.
263263

264264
```shell
265265
az iot hub device-identity show --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -285,7 +285,7 @@ To view telemetry in Azure IoT Explorer:
285285

286286
To use Azure CLI to view device telemetry:
287287

288-
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.
288+
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.
289289

290290
```shell
291291
az iot hub monitor-events --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -322,7 +322,7 @@ To call a method in Azure IoT Explorer:
322322
323323
To use Azure CLI to call a method:
324324
325-
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.
325+
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.
326326
327327
<!-- Inline code tag and CSS to wrap long code lines. -->
328328
<code style="white-space : pre-wrap !important;">

‎NXP/MIMXRT1060-EVK/readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The cloned repo contains a setup script that installs and configures the require
5959
> * [GCC](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm): Compile
6060
> * [CMake](https://cmake.org): Build
6161
> * [Termite](https://www.compuphase.com/software_termite.htm): Monitor serial port output for connected devices
62-
> * [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/): Manage Azure resources
62+
> * [Azure CLI](https://docs.microsoft.com/cli/azure/): Manage Azure resources
6363
> * [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform utility to monitor and manage Azure IoT resources
6464
6565
To install the tools:
@@ -109,7 +109,7 @@ In this section, you create a new device instance and register it with the IoT h
109109

110110
To register a device:
111111

112-
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.
112+
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.
113113

114114
*YourIotHubName*. Replace this placeholder below with the name you chose for your IoT hub.
115115

@@ -233,7 +233,7 @@ You can use the Azure IoT Explorer to view and manage the properties of your dev
233233

234234
To add a connection to your IoT hub:
235235

236-
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.
236+
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.
237237

238238
```shell
239239
az iot hub show-connection-string --name {YourIoTHubName}
@@ -259,7 +259,7 @@ To view device properties using Azure IoT Explorer:
259259

260260
To use Azure CLI to view device properties:
261261

262-
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.
262+
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.
263263

264264
```shell
265265
az iot hub device-identity show --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -285,7 +285,7 @@ To view telemetry in Azure IoT Explorer:
285285

286286
To use Azure CLI to view device telemetry:
287287

288-
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.
288+
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.
289289

290290
```shell
291291
az iot hub monitor-events --device-id MyNXPDevice --hub-name {YourIoTHubName}
@@ -322,7 +322,7 @@ To call a method in Azure IoT Explorer:
322322
323323
To use Azure CLI to call a method:
324324
325-
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.
325+
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.
326326
327327
<!-- Inline code tag and CSS to wrap long code lines. -->
328328
<code style="white-space : pre-wrap !important;">

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
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.
1212

1313
* Refer to [Getting Started with Azure RTOS](https://go.microsoft.com/fwlink/p/?linkid=2129824) for additional information on the guides and Azure RTOS.
14-
* 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.
14+
* Refer to [IoT Plug and Play](https://docs.microsoft.com/azure/iot-pnp) for information on the Iot Plug and Play Preview Refresh.
1515
* Ask questions on the [Azure RTOS Q&A](https://aka.ms/QnA/azure-rtos) site.
1616

1717
## Getting Started Guides

‎Renesas/RSK_RX65N_2MB/readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The cloned repo contains a setup script that installs and configures the require
6161
> * [GCC](http://gcc-renesas.com/downloads/get.php?f=rx/8.3.0.202004-gnurx/gcc-8.3.0.202004-GNURX-ELF.exe): Compile
6262
> * [CMake](https://cmake.org): Build
6363
> * [Termite](https://www.compuphase.com/software_termite.htm): Monitor serial port output for connected devices
64-
> * [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/): Manage Azure resources
64+
> * [Azure CLI](https://docs.microsoft.com/cli/azure/): Manage Azure resources
6565
> * [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform utility to monitor and manage Azure IoT resources
6666
6767
To install the tools:
@@ -121,7 +121,7 @@ In this section, you create a new device instance and register it with the IoT h
121121

122122
To register a device:
123123

124-
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.
124+
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.
125125

126126
*YourIotHubName*. Replace this placeholder below with the name you chose for your IoT hub.
127127

@@ -274,7 +274,7 @@ You can use the Azure IoT Explorer to view and manage the properties of your dev
274274

275275
To add a connection to your IoT hub:
276276

277-
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.
277+
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.
278278

279279
```shell
280280
az iot hub show-connection-string --name {YourIoTHubName}
@@ -300,7 +300,7 @@ To view device properties using Azure IoT Explorer:
300300

301301
To use Azure CLI to view device properties:
302302

303-
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.
303+
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.
304304

305305
```shell
306306
az iot hub device-identity show --device-id MyRenesasDevice --hub-name {YourIoTHubName}
@@ -326,7 +326,7 @@ To view telemetry in Azure IoT Explorer:
326326

327327
To use Azure CLI to view device telemetry:
328328

329-
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.
329+
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.
330330

331331
```shell
332332
az iot hub monitor-events --device-id MyRenesasDevice --hub-name {YourIoTHubName}
@@ -363,7 +363,7 @@ To call a method in Azure IoT Explorer:
363363

364364
To use Azure CLI to call a method:
365365

366-
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.
366+
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.
367367

368368
<!-- Inline code tag and CSS to wrap long code lines. -->
369369
<code style="white-space : pre-wrap !important;">

‎SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
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/).
44

5-
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.
5+
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.
66

77
## Reporting Security Issues
88

99
**Please do not report security vulnerabilities through public GitHub issues.**
1010

1111
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
1212

13-
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). 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).
13+
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). 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).
1414

1515
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).
1616

@@ -32,4 +32,4 @@ We prefer all communications to be in English.
3232

3333
## Policy
3434

35-
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
35+
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/msrc/cvd).

‎STMicroelectronics/STM32L4_L4+/readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ In this tutorial you use Azure RTOS to connect either the STMicroelectronics [B-
1919

2020
You will complete the following tasks:
2121

22-
* Install a set of embedded development tools for programming the STM DevKit in C.
23-
* Build an image and flash it onto the STM DevKit.
24-
* Use Azure IoT Central to create cloud components, view properties, view device telemetry, and call direct commands.
22+
* Install a set of embedded development tools for programming the STM DevKit in C
23+
* Build an image and flash it onto the STM DevKit
24+
* Use Azure IoT Central to create cloud components, view properties, view device telemetry, and call direct commands
2525

2626
## Prerequisites
2727

‎core/src/azure_iot_mqtt/azure_iot_dps_mqtt.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/* Copyright (c) Microsoft Corporation.
22
Licensed under the MIT License. */
33

4-
// https://docs.microsoft.com/en-us/azure/iot-dps/iot-dps-mqtt-support
4+
// https://docs.microsoft.com/azure/iot-dps/iot-dps-mqtt-support
55

66
#include <string.h>
77

0 commit comments

Comments
 (0)