Merge pull request #174971 from JimacoMS4/add-linux-pi-to-charp-device-qs

Court72 · web-flow · commit 2f4c54c36ba4 · 2021-10-11T13:29:07.000-07:00
Convert C# QS articles to dotnet and add Linux and Raspberry Pi support
diff --git a/includes/iot-develop-send-telemetry-central-csharp.md b/includes/iot-develop-send-telemetry-central-csharp.md
@@ -4,7 +4,7 @@
  author: timlt
  ms.service: iot-develop
  ms.topic: include
- ms.date: 04/28/2021
+ ms.date: 10/08/2021
  ms.author: timlt
  ms.custom: include file
 ---
@@ -14,59 +14,129 @@
 In this quickstart, you learn a basic Azure IoT application development workflow. First you create an Azure IoT Central application for hosting devices. Then you use an Azure IoT device SDK sample to run a simulated temperature controller, connect it securely to IoT Central, and send telemetry.
 
 ## Prerequisites
-- [Visual Studio (Community, Professional, or Enterprise) 2019](https://visualstudio.microsoft.com/downloads/).
-- A local copy of the [Microsoft Azure IoT Samples for C# (.NET)](https://github.com/Azure-Samples/azure-iot-samples-csharp) GitHub repository. Download a copy of the repository and extract it: [Download ZIP](https://github.com/Azure-Samples/azure-iot-samples-csharp/archive/main.zip).
+
+This quickstart runs on Windows, Linux, and Raspberry Pi. It's been tested on the following OS and device versions:
+
+- Windows 10
+- Ubuntu 20.04 LTS running on Windows Subsystem for Linux (WSL)
+- Raspberry Pi OS version 10 (Raspian) running on a Raspberry Pi 3 Model B+
+
+Install the following prerequisites on your development machine:
+
+- If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
+- [Git](https://git-scm.com/downloads).
+- .NET Core SDK 3.1. Be sure to install the .NET SDK, not just the runtime. To check the version of the .NET SDK and runtime installed on your machine, run `dotnet --info`.
+
+  - For Windows and Linux (except Raspberry Pi), follow the instructions to [install the .NET Core SDK 3.1](/dotnet/core/install/) on your platform.
+  - For Raspberry Pi, you'll need to follow the instructions to [manually install the SDK](/dotnet/core/install/linux-scripted-manual#manual-install). This is because on Debian, package manager installs of the .NET SDK are only supported for the x64 architecture.
 
 [!INCLUDE [iot-develop-create-central-app-with-device](iot-develop-create-central-app-with-device.md)]
 
 ## Run a simulated device
-In this section, you configure your local environment, and run a sample that creates a simulated temperature controller.
+In this section, you configure your local environment, install the Azure IoT C# samples, and run a sample that creates a simulated temperature controller.
+
+### Configure your environment
+
+1. Open a console such as Windows CMD, PowerShell, or Bash.
+
+1. Set the following environment variables, using the appropriate commands for your console. The simulated device uses these values to connect to IoT Central. For `IOTHUB_DEVICE_DPS_ID_SCOPE`, `IOTHUB_DEVICE_DPS_DEVICE_KEY`, and `IOTHUB_DEVICE_DPS_DEVICE_ID`, use the device connection values that you saved previously.
+
+    **CMD (Windows)**
+
+    ```console
+    set IOTHUB_DEVICE_SECURITY_TYPE=DPS
+    set IOTHUB_DEVICE_DPS_ID_SCOPE=<application ID scope>
+    set IOTHUB_DEVICE_DPS_DEVICE_KEY=<device primary key>
+    set IOTHUB_DEVICE_DPS_DEVICE_ID=<your device ID>
+    set IOTHUB_DEVICE_DPS_ENDPOINT=global.azure-devices-provisioning.net
+    ```
+
+    > [!NOTE]
+    > For Windows CMD there are no quotation marks surrounding the variable values.
+
+    **PowerShell**
+
+    ```azurepowershell
+    $env:IOTHUB_DEVICE_SECURITY_TYPE='DPS'
+    $env:IOTHUB_DEVICE_DPS_ID_SCOPE='<application ID scope>'
+    $env:IOTHUB_DEVICE_DPS_DEVICE_KEY='<device primary key>'
+    $env:IOTHUB_DEVICE_DPS_DEVICE_ID='<your device ID>'
+    $env:IOTHUB_DEVICE_DPS_ENDPOINT='global.azure-devices-provisioning.net'
+    ```
+
+    **Bash**
+
+    ```bash
+    export IOTHUB_DEVICE_SECURITY_TYPE='DPS'
+    export IOTHUB_DEVICE_DPS_ID_SCOPE='<application ID scope>'
+    export IOTHUB_DEVICE_DPS_DEVICE_KEY='<device primary key>'
+    export IOTHUB_DEVICE_DPS_DEVICE_ID='<your device ID>'
+    export IOTHUB_DEVICE_DPS_ENDPOINT='global.azure-devices-provisioning.net' 
+    ```
+
+### Install the SDK and samples
+
+1. Clone the [Microsoft Azure IoT Samples for C# (.NET)](https://github.com/Azure-Samples/azure-iot-samples-csharp) to your local machine.
+
+    ```console
+    git clone https://github.com/Azure-Samples/azure-iot-samples-csharp.git
+    ```
+
+1. Navigate to the sample directory.
+
+    **Windows**
+
+    ```console
+    cd azure-iot-samples-csharp\iot-hub\Samples\device\PnpDeviceSamples\TemperatureController
+    ```
+
+    **Linux or Raspberry Pi OS**
+
+    ```console
+    cd azure-iot-samples-csharp/iot-hub/Samples/device/PnpDeviceSamples/TemperatureController
+    ```
 
-To run the sample application in Visual Studio:
+1. Install the Azure IoT C# SDK and necessary dependencies:
 
-1. In the folder where you unzipped the Azure IoT Samples for C#, open the *azure-iot-samples-csharp-main\iot-hub\Samples\device\IoTHubDeviceSamples.sln"* solution file in Visual Studio. 
+    ```console
+    dotnet restore
+    ```
 
-1. In **Solution Explorer**, select the **PnpDeviceSamples > TemperatureController** project file, right-click it, and select **Set as Startup Project**.
+    This command installs the proper dependencies as specified in the *TemperatureController.csproj* file.
 
-1. Right-click the **TemperatureController** project, select **Properties**, select the **Debug** tab, and add the following environment variables to the project:
+### Run the code
 
-    | Name | Value |
-    | ---- | ----- |
-    | IOTHUB_DEVICE_SECURITY_TYPE | DPS |
-    | IOTHUB_DEVICE_DPS_ENDPOINT | global.azure-devices-provisioning.net |
-    | IOTHUB_DEVICE_DPS_ID_SCOPE | The ID scope value you made a note of previously. |
-    | IOTHUB_DEVICE_DPS_DEVICE_ID | sample-device-01 |
-    | IOTHUB_DEVICE_DPS_DEVICE_KEY | The generated device key value you made a note of previously. |
+1. In your console, run the code sample. The sample creates a simulated temperature controller with thermostat sensors.
 
-1. Save the updated **TemperatureController** project file.
+    ```console
+    dotnet run
+    ```
 
-1. Press CTRL + F5 to run the sample.
+    After your simulated device connects to your IoT Central application, it connects to the device instance you created in the application and begins to send telemetry. The connection details and telemetry output are shown in your console:
 
-    After your simulated device connects to your IoT Central application, it begins to send telemetry. The connection details and telemetry output appear in the console: 
-    
     ```output
-        [05/04/2021 11:53:50]info: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Press Control+C to quit the sample.
-        [05/04/2021 11:53:50]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Set up the device client.
-        [05/04/2021 11:53:50]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Initializing via DPS
-        [05/04/2021 11:53:56]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Set handler for 'reboot' command.
-        [05/04/2021 11:53:57]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Connection status change registered - status=Connected, reason=Connection_Ok.
-        [05/04/2021 11:53:57]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Set handler for "getMaxMinReport" command.
-        [05/04/2021 11:53:57]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Set handler to receive 'targetTemperature' updates.
-        [05/04/2021 11:53:57]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Property: Update - component = 'deviceInformation', properties update is complete.
-        [05/04/2021 11:53:58]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Property: Update - { "serialNumber": "SR-123456" } is complete.
-        [05/04/2021 11:53:58]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Telemetry: Sent - component="thermostat1", { "temperature": 44.9 } in °C.
-        [05/04/2021 11:53:58]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Property: Update - component="thermostat1", { "maxTempSinceLastReboot": 44.9 } in °C is complete.
-        [05/04/2021 11:53:58]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
-              Telemetry: Sent - component="thermostat2", { "temperature": 40.8 } in °C.
+    [10/09/2021 00:29:18]info: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Press Control+C to quit the sample.
+    [10/09/2021 00:29:18]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Set up the device client.
+    [10/09/2021 00:29:18]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Initializing via DPS
+    [10/09/2021 00:29:38]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Set handler for 'reboot' command.
+    [10/09/2021 00:29:39]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Connection status change registered - status=Connected, reason=Connection_Ok.
+    [10/09/2021 00:29:39]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Set handler for "getMaxMinReport" command.
+    [10/09/2021 00:29:39]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Set handler to receive 'targetTemperature' updates.
+    [10/09/2021 00:29:39]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Property: Update - component = 'deviceInformation', properties update is complete.
+    [10/09/2021 00:29:39]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Property: Update - { "serialNumber": "SR-123456" } is complete.
+    [10/09/2021 00:29:40]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Telemetry: Sent - component="thermostat1", { "temperature": 23.7 } in °C.
+    [10/09/2021 00:29:40]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Property: Update - component="thermostat1", { "maxTempSinceLastReboot": 23.7 } in °C is complete.
+    [10/09/2021 00:29:40]dbug: Microsoft.Azure.Devices.Client.Samples.TemperatureControllerSample[0]
+          Telemetry: Sent - component="thermostat2", { "temperature": 25.8 } in °C.
     ```
diff --git a/includes/iot-develop-send-telemetry-iot-hub-csharp.md b/includes/iot-develop-send-telemetry-iot-hub-csharp.md
@@ -4,7 +4,7 @@
  author: timlt
  ms.service: iot-develop
  ms.topic: include
- ms.date: 08/03/2021
+ ms.date: 10/07/2021
  ms.author: timlt
  ms.custom: include file
 ---
@@ -14,37 +14,100 @@
 In this quickstart, you learn a basic Azure IoT application development workflow. You use the Azure CLI and IoT Explorer to create an Azure IoT hub and a device. Then you use an Azure IoT device SDK sample to run a simulated temperature controller, connect it securely to the hub, and send telemetry.
 
 ## Prerequisites
+
+This quickstart runs on Windows, Linux, and Raspberry Pi. It's been tested on the following OS and device versions:
+
+- Windows 10
+- Ubuntu 20.04 LTS running on Windows Subsystem for Linux (WSL)
+- Raspberry Pi OS version 10 (Raspian) running on a Raspberry Pi 3 Model B+
+
+Install the following prerequisites on your development machine except where noted for Raspberry Pi:
+
 - If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
-- [Visual Studio (Community, Professional, or Enterprise) 2019](https://visualstudio.microsoft.com/downloads/).
-- A local copy of the [Microsoft Azure IoT Samples for C# (.NET)](https://github.com/Azure-Samples/azure-iot-samples-csharp) GitHub repository. Download a copy of the repository and extract it: [Download ZIP](https://github.com/Azure-Samples/azure-iot-samples-csharp/archive/main.zip).
-- [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform, GUI-base utility to monitor and manage Azure IoT. 
+- [Git](https://git-scm.com/downloads).
+- .NET Core SDK 3.1. Be sure to install the .NET SDK, not just the runtime. To check the version of the .NET SDK and runtime installed on your machine, run `dotnet --info`.
+
+  - For Windows and Linux (except Raspberry Pi), follow the instructions to [install the .NET Core SDK 3.1](/dotnet/core/install/) on your platform.
+  - For Raspberry Pi, you'll need to follow the instructions to [manually install the SDK](/dotnet/core/install/linux-scripted-manual#manual-install). This is because on Debian, package manager installs of the .NET SDK are only supported for the x64 architecture.
+
+- [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer/releases): Cross-platform, GUI-based utility to monitor and manage Azure IoT. If you're using Raspberry Pi as your development platform, we recommend that you install IoT Explorer on another computer. If you don't want to install IoT Explorer, you can use Azure CLI to perform the same steps. 
 - Azure CLI. You have two options for running Azure CLI commands in this quickstart:
     - Use the Azure Cloud Shell, an interactive shell that runs CLI commands in your browser. This option is recommended because you don't need to install anything. If you're using Cloud Shell for the first time, log into the [Azure portal](https://portal.azure.com). Follow the steps in [Cloud Shell quickstart](../articles/cloud-shell/quickstart.md) to **Start Cloud Shell** and **Select the Bash environment**.
-    - Optionally, run Azure CLI on your local machine. If Azure CLI is already installed, run `az upgrade` to upgrade the CLI and extensions to the current version. To install Azure CLI, see [Install Azure CLI]( /cli/azure/install-azure-cli).
+    - Optionally, run Azure CLI on your local machine. If Azure CLI is already installed, run `az upgrade` to upgrade the CLI and extensions to the current version. To install Azure CLI, see [Install Azure CLI]( /cli/azure/install-azure-cli). If you're using Raspberry Pi as your development platform, we recommend that you use Azure Cloud Shell or install Azure CLI on another computer.
 
 [!INCLUDE [iot-hub-include-create-hub-iot-explorer](iot-hub-include-create-hub-iot-explorer.md)]
 
 ## Run a simulated device
+
 In this section, you'll use the C# SDK to send messages from a simulated device to your IoT hub. You'll run a sample that implements a temperature controller with two thermostat sensors.
 
-To run the sample application in Visual Studio:
+1. Open a new console such as Windows CMD, PowerShell, or Bash. In the following steps, you'll use this console to install the Node.js SDK and work with Node.js sample code.
 
-1. In the folder where you unzipped the Azure IoT Samples for C#, open the *azure-iot-samples-csharp-main\iot-hub\Samples\device\IoTHubDeviceSamples.sln"* solution file in Visual Studio. 
+    > [!NOTE]
+    > If you're using a local installation of Azure CLI, you might now have two console windows open. Be sure to enter the commands in this section in the console you just opened, not the one that you've been using for the CLI.
 
-1. In **Solution Explorer**, select the **PnpDeviceSamples > TemperatureController** project file, right-click it, and select **Set as Startup Project**.
+1. Clone the [Microsoft Azure IoT Samples for C# (.NET)](https://github.com/Azure-Samples/azure-iot-samples-csharp) to your local machine:
 
-1. Right-click the **TemperatureController** project, select **Properties**, select the **Debug** tab, and add the following environment variables to the project:
+    ```console
+    git clone https://github.com/Azure-Samples/azure-iot-samples-csharp.git
+    ```
+
+1. Navigate to the sample directory:
 
-    | Name | Value |
-    | ---- | ----- |
-    | IOTHUB_DEVICE_SECURITY_TYPE | *connectionString* |
-    | IOTHUB_DEVICE_CONNECTION_STRING | The connection string you saved previously. |
+    **Windows**
+    ```console
+    cd azure-iot-samples-csharp\iot-hub\Samples\device\PnpDeviceSamples\TemperatureController
+    ```
 
-1. Save the updated **TemperatureController** project file.
+    **Linux or Raspberry Pi OS**
+    ```console
+    cd azure-iot-samples-csharp/iot-hub/Samples/device/PnpDeviceSamples/TemperatureController
+    ```
+
+1. Install the Azure IoT C# SDK and necessary dependencies:
+
+    ```console
+    dotnet restore
+    ```
 
-1. In Visual Studio, press CTRL + F5 to run the sample.
+    This command installs the proper dependencies as specified in the *TemperatureController.csproj* file.
+
+1. Set both of the following environment variables, to enable your simulated device to connect to Azure IoT.
+    * Set an environment variable called `IOTHUB_DEVICE_CONNECTION_STRING`. For the variable value, use the device connection string that you saved in the previous section.
+    * Set an environment variable called `IOTHUB_DEVICE_SECURITY_TYPE`. For the variable, use the literal string value `connectionString`.
+
+    **CMD (Windows)**
+
+    ```console
+    set IOTHUB_DEVICE_CONNECTION_STRING=<your connection string here>
+    set IOTHUB_DEVICE_SECURITY_TYPE=connectionString
+    ```
+
+    > [!NOTE]
+    > For Windows CMD there are no quotation marks surrounding the string values for each variable.
+
+    **PowerShell**
+
+    ```azurepowershell
+    $env:IOTHUB_DEVICE_CONNECTION_STRING='<your connection string here>'
+    $env:IOTHUB_DEVICE_SECURITY_TYPE='connectionString'
+    ```
+
+    **Bash**
+
+    ```bash
+    export IOTHUB_DEVICE_CONNECTION_STRING="<your connection string here>"
+    export IOTHUB_DEVICE_SECURITY_TYPE="connectionString"
+    ```
+1. Run the code sample:
+
+    ```console
+    dotnet run
+    ```
+    > [!NOTE]
+    > This code sample uses Azure IoT Plug and Play, which lets you integrate smart devices into your solutions without any manual configuration.  By default, most samples in this documentation use IoT Plug and Play. To learn more about the advantages of IoT PnP, and cases for using or not using it, see [What is IoT Plug and Play?](../articles/iot-develop/overview-iot-plug-and-play.md).
 
-A console window opens. The sample securely connects to your IoT hub as the device you registered and begins sending telemetry messages. The sample output appears in the console.
+The sample securely connects to your IoT hub as the device you registered and begins sending telemetry messages. The sample output appears in your console.
 
 ## View telemetry
 
