Device-specific instructions

Azure · Aug 30, 2016 · 7bfce41 · 7bfce41
1 parent 266fc32
commit 7bfce41
Show file tree

Hide file tree

Showing 7 changed files with 583 additions and 0 deletions.
diff --git a/doc/get_started/windows-10-iot-enterprise-ltsb-etile19-fb-csharp.md b/doc/get_started/windows-10-iot-enterprise-ltsb-etile19-fb-csharp.md
@@ -0,0 +1,100 @@
+---
+platform: windows 10 iot enterprise ltsb
+device: etile19-fb
+language: csharp
+---
+
+Run a simple Csharp sample on ETILE19-FB device running Windows 10 IoT Enterprise LTSB
+===
+---
+
+# Table of Contents
+
+-   [Introduction](#Introduction)
+-   [Step 1: Prerequisites](#Prerequisites)
+-   [Step 2: Prepare your Device](#PrepareDevice)
+-   [Step 3: Build and Run the Sample](#Build)
+
+<a name="Introduction"></a>
+# Introduction
+
+**About this document**
+
+This document describes how to connect ETILE19-FB device running Window 10 IoT Enterprise LTSB with Azure IoT SDK. This multi-step process includes:
+-   Configuring Azure IoT Hub
+-   Registering your IoT device
+-   Build and deploy Azure IoT SDK on device
+
+<a name="Prerequisites"></a>
+# Step 1: Prerequisites
+
+You should have the following items ready before beginning the process:
+
+-   Computer with Git client installed and access to the
+    [azure-iot-sdks](https://github.com/Azure/azure-iot-sdks) GitHub public repository.
+-   [Setup your IoT hub][lnk-setup-iot-hub]
+-   [Provision your device and get its credentials][lnk-manage-iot-hub]
+-   AOPEN ETILE19-FB device.
+
+#### Install Visual Studio 2015 and Tools
+
+-   To create Windows IoT Core solutions, you will need to install [Visual Studio 2015](https://www.visualstudio.com/en-us/products/vs-2015-product-editions.aspx). You can install any edition of Visual Studio, including the free Community edition.
+
+    Make sure to select the **Universal Windows App Development Tools**, the component required for writing apps Windows 10:
+
+<a name="PrepareDevice"></a>
+# Step 2: Prepare your Device
+
+-   Connect the power adapter with AOPEN ETILE19-FB.
+-   Press the power button by “Power on\off Steel tool” .
+-   Wait until the operating system is ready.
+-   You may download [user manual](http://global.aopen.com/download.aspx)
+
+<a name="Build"></a>
+# Step 3: Build and Run the Sample
+
+<a name="Step_3_1:_Connect"></a>
+## 3.1 Connect the Device
+
+-   Connect the board to your network using an Ethernet cable. This step is required, as the sample depends on internet access.
+
+-   Plug the device into your computer using a micro-USB cable.
+
+<a name="Step_3_2:_Build"></a>
+## 3.2  Build the Samples
+
+-   Download the Azure IoT SDK and the sample programs and save them to your local repository.
+
+-   Start a new instance of Visual Studio 2015. Open the **iothub_csharp_client.sln** solution (/azure-iot-sdks/csharp) from your local copy of the repository.
+
+-   In Visual Studio, from **Solution Explorer**, navigate to the **UWPSample(Universal Windows)** project.
+
+-   Locate the following code in the **ConnectionStrings.cs** file:
+
+        public const string DeviceConnectionString = "<replace>";
+
+-   Replace the above placeholder with device connection string you obtained in [Step 1](#Step-1:-Prerequisites) and save the changes.
+
+-   Choose the right architecture (x86 or ARM, depending on your device) and set the debugging method to "Remote Machine":
+
+-   To deploy the binaries on your device, right-click on the UWPSample project in the **Solution Explorer**, select **Properties** and navigate to the **Debug** tab:
+
+    Type in the name of your device. Make sure the "Use authentication" box is unchecked.
+
+-   Build the solution.
+
+<a name="Step_3_3:_Run"/>
+## 3.3 Run and Validate the Samples
+
+### 3.3.1 Send Device Events to IoT Hub
+
+-   In Visual Studio, from **Solution Explorer**, right-click the **UWPSample(Universal Windows)** project, click **Debug &minus;&gt; Start new instance** to build and run the sample. 
+
+-   See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to observe the messages IoT Hub receives from the application.
+
+### 3.3.2 Receive messages from IoT Hub
+
+-   See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to send cloud-to-device messages to the application.
+
+[lnk-setup-iot-hub]: ../../setup_iothub.md
+[lnk-manage-iot-hub]: ../../manage_iot_hub.md
diff --git a/doc/get_started/windows-10-iot-enterprise-ltsb-etile22-fw-csharp.md b/doc/get_started/windows-10-iot-enterprise-ltsb-etile22-fw-csharp.md
@@ -0,0 +1,100 @@
+---
+platform: windows 10 iot enterprise ltsb
+device: etile22-fw
+language: csharp
+---
+
+Run a simple Csharp sample on ETILE22-FW device running Windows 10 IoT Enterprise LTSB
+===
+---
+
+# Table of Contents
+
+-   [Introduction](#Introduction)
+-   [Step 1: Prerequisites](#Prerequisites)
+-   [Step 2: Prepare your Device](#PrepareDevice)
+-   [Step 3: Build and Run the Sample](#Build)
+
+<a name="Introduction"></a>
+# Introduction
+
+**About this document**
+
+This document describes how to connect ETILE22-FW device running Window 10 IoT Enterprise LTSB with Azure IoT SDK. This multi-step process includes:
+-   Configuring Azure IoT Hub
+-   Registering your IoT device
+-   Build and deploy Azure IoT SDK on device
+
+<a name="Prerequisites"></a>
+# Step 1: Prerequisites
+
+You should have the following items ready before beginning the process:
+
+-   Computer with Git client installed and access to the
+    [azure-iot-sdks](https://github.com/Azure/azure-iot-sdks) GitHub public repository.
+-   [Setup your IoT hub][lnk-setup-iot-hub]
+-   [Provision your device and get its credentials][lnk-manage-iot-hub]
+-   AOPEN ETILE22-FW device.
+
+#### Install Visual Studio 2015 and Tools
+
+-   To create Windows IoT Core solutions, you will need to install [Visual Studio 2015](https://www.visualstudio.com/en-us/products/vs-2015-product-editions.aspx). You can install any edition of Visual Studio, including the free Community edition.
+
+    Make sure to select the **Universal Windows App Development Tools**, the component required for writing apps Windows 10:
+
+<a name="PrepareDevice"></a>
+# Step 2: Prepare your Device
+
+-   Connect the power adapter with AOPEN ETILE22-FW.
+-   Press the power button by “Power on\off Steel tool” .
+-   Wait until the operating system is ready.
+-   You may download [user manual](http://global.aopen.com/download.aspx)
+
+<a name="Build"></a>
+# Step 3: Build and Run the Sample
+
+<a name="Step_3_1:_Connect"></a>
+## 3.1 Connect the Device
+
+-   Connect the board to your network using an Ethernet cable. This step is required, as the sample depends on internet access.
+
+-   Plug the device into your computer using a micro-USB cable.
+
+<a name="Step_3_2:_Build"></a>
+## 3.2  Build the Samples
+
+-   Download the Azure IoT SDK and the sample programs and save them to your local repository.
+
+-   Start a new instance of Visual Studio 2015. Open the **iothub_csharp_client.sln** solution (/azure-iot-sdks/csharp) from your local copy of the repository.
+
+-   In Visual Studio, from **Solution Explorer**, navigate to the **UWPSample(Universal Windows)** project.
+
+-   Locate the following code in the **ConnectionStrings.cs** file:
+
+        public const string DeviceConnectionString = "<replace>";
+
+-   Replace the above placeholder with device connection string you obtained in [Step 1](#Step-1:-Prerequisites) and save the changes.
+
+-   Choose the right architecture (x86 or ARM, depending on your device) and set the debugging method to "Remote Machine":
+
+-   To deploy the binaries on your device, right-click on the UWPSample project in the **Solution Explorer**, select **Properties** and navigate to the **Debug** tab:
+
+    Type in the name of your device. Make sure the "Use authentication" box is unchecked.
+
+-   Build the solution.
+
+<a name="Step_3_3:_Run"/>
+## 3.3 Run and Validate the Samples
+
+### 3.3.1 Send Device Events to IoT Hub
+
+-   In Visual Studio, from **Solution Explorer**, right-click the **UWPSample(Universal Windows)** project, click **Debug &minus;&gt; Start new instance** to build and run the sample. 
+
+-   See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to observe the messages IoT Hub receives from the application.
+
+### 3.3.2 Receive messages from IoT Hub
+
+-   See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to send cloud-to-device messages to the application.
+
+[lnk-setup-iot-hub]: ../../setup_iothub.md
+[lnk-manage-iot-hub]: ../../manage_iot_hub.md
diff --git a/doc/get_started/windows-10-iot-enterprise-ltsb-wt15m-fb-csharp.md b/doc/get_started/windows-10-iot-enterprise-ltsb-wt15m-fb-csharp.md
@@ -0,0 +1,100 @@
+---
+platform: windows 10 iot enterprise ltsb
+device: wt15m-fb
+language: csharp
+---
+
+Run a simple Csharp sample on WT15M-FB device running Windows 10 IoT Enterprise LTSB
+===
+---
+
+# Table of Contents
+
+-   [Introduction](#Introduction)
+-   [Step 1: Prerequisites](#Prerequisites)
+-   [Step 2: Prepare your Device](#PrepareDevice)
+-   [Step 3: Build and Run the Sample](#Build)
+
+<a name="Introduction"></a>
+# Introduction
+
+**About this document**
+
+This document describes how to connect WT15M-FB device running Window 10 IoT Enterprise LTSB with Azure IoT SDK. This multi-step process includes:
+-   Configuring Azure IoT Hub
+-   Registering your IoT device
+-   Build and deploy Azure IoT SDK on device
+
+<a name="Prerequisites"></a>
+# Step 1: Prerequisites
+
+You should have the following items ready before beginning the process:
+
+-   Computer with Git client installed and access to the
+    [azure-iot-sdks](https://github.com/Azure/azure-iot-sdks) GitHub public repository.
+-   [Setup your IoT hub][lnk-setup-iot-hub]
+-   [Provision your device and get its credentials][lnk-manage-iot-hub]
+-   AOPEN WT15M-FB device.
+
+#### Install Visual Studio 2015 and Tools
+
+-   To create Windows IoT Core solutions, you will need to install [Visual Studio 2015](https://www.visualstudio.com/en-us/products/vs-2015-product-editions.aspx). You can install any edition of Visual Studio, including the free Community edition.
+
+    Make sure to select the **Universal Windows App Development Tools**, the component required for writing apps Windows 10:
+
+<a name="PrepareDevice"></a>
+# Step 2: Prepare your Device
+
+-   Connect the power adapter with AOPEN WT15M-FB.
+-   Press the power button by “Power on\off Steel tool” .
+-   Wait until the operating system is ready.
+-   You may download [user manual](http://global.aopen.com/download.aspx)
+
+<a name="Build"></a>
+# Step 3: Build and Run the Sample
+
+<a name="Step_3_1:_Connect"></a>
+## 3.1 Connect the Device
+
+-   Connect the board to your network using an Ethernet cable. This step is required, as the sample depends on internet access.
+
+-   Plug the device into your computer using a micro-USB cable.
+
+<a name="Step_3_2:_Build"></a>
+## 3.2  Build the Samples
+
+-   Download the Azure IoT SDK and the sample programs and save them to your local repository.
+
+-   Start a new instance of Visual Studio 2015. Open the **iothub_csharp_client.sln** solution (/azure-iot-sdks/csharp) from your local copy of the repository.
+
+-   In Visual Studio, from **Solution Explorer**, navigate to the **UWPSample(Universal Windows)** project.
+
+-   Locate the following code in the **ConnectionStrings.cs** file:
+
+        public const string DeviceConnectionString = "<replace>";
+
+-   Replace the above placeholder with device connection string you obtained in [Step 1](#Step-1:-Prerequisites) and save the changes.
+
+-   Choose the right architecture (x86 or ARM, depending on your device) and set the debugging method to "Remote Machine":
+
+-   To deploy the binaries on your device, right-click on the UWPSample project in the **Solution Explorer**, select **Properties** and navigate to the **Debug** tab:
+
+    Type in the name of your device. Make sure the "Use authentication" box is unchecked.
+
+-   Build the solution.
+
+<a name="Step_3_3:_Run"/>
+## 3.3 Run and Validate the Samples
+
+### 3.3.1 Send Device Events to IoT Hub
+
+-   In Visual Studio, from **Solution Explorer**, right-click the **UWPSample(Universal Windows)** project, click **Debug &minus;&gt; Start new instance** to build and run the sample. 
+
+-   See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to observe the messages IoT Hub receives from the application.
+
+### 3.3.2 Receive messages from IoT Hub
+
+-   See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to send cloud-to-device messages to the application.
+
+[lnk-setup-iot-hub]: ../../setup_iothub.md
+[lnk-manage-iot-hub]: ../../manage_iot_hub.md
diff --git a/...get_started/windows-storage-server-2012-r2-essentials-thecus w2810pro-csharp.md b/...get_started/windows-storage-server-2012-r2-essentials-thecus w2810pro-csharp.md
@@ -0,0 +1,67 @@
+---
+platform: windows storage server 2012 r2 essentials
+device: thecus w2810pro
+language: csharp
+---
+
+Run a simple Csharp sample on Thecus W2810PRO device running Windows Storage Server 2012 R2 Essentials
+===
+---
+
+# Table of Contents
+
+-   [Introduction](#Introduction)
+-   [Step 1: Prerequisites](#Prerequisites)
+-   [Step 2: Prepare your Device](#PrepareDevice)
+-   [Step 3: Build and Run the Sample](#Build)
+
+<a name="Introduction"></a>
+# Introduction
+
+**About this document**
+
+This document describes how to connect Thecus W2810PRO device running Windows Storage Server 2012 R2 Essentials with Azure IoT SDK. This multi-step process includes:
+-   Configuring Azure IoT Hub
+-   Registering your IoT device
+-   Build and deploy Azure IoT SDK on device
+
+<a name="Prerequisites"></a>
+# Step 1: Prerequisites
+
+You should have the following items ready before beginning the process:
+
+-   [Prepare your development environment][setup-devbox-windows]
+-   [Setup your IoT hub][lnk-setup-iot-hub]
+-   [Provision your device and get its credentials][lnk-manage-iot-hub]
+-   Thecus W2810PRO device.
+-   Monitor, HDMI Cable, USB Keyboard/Mouse, and the Internet connection
+
+<a name="PrepareDevice"></a>
+# Step 2: Prepare your Device
+
+-   Connect Ethernet cable to the WAN port on Thecus W2810PRO device and connect the other end to your switch/hub/router.
+-   Connect a USB Keyboard and Mouse to the back USB ports of your Thecus W2810PRO device. Using an HDMI cable (The maximum supported screen resolution is 1280 x 1024 or 1920 x 1080 (depends on models)), also connect a monitor to the device.
+-   Connect power cord & power on.
+-   Wait until the operating system is ready.
+
+<a name="Build"></a>
+# Step 3: Build and Run the sample
+
+-   Download the [Azure IoT SDK](https://github.com/Azure/azure-iot-sdks) and the sample programs and save them to your local repository.
+-   Start a new instance of Visual Studio 2015.
+-   Open the **iothub_csharp_client.sln** solution in the `csharp\device` folder in your local copy of the repository.
+-   In Visual Studio, from Solution Explorer, navigate to the **samples** folder.
+-   In the **DeviceClientAmqpSample** project, open the ***Program.cs*** file.
+-   Locate the following code in the file:
+
+        private const string DeviceConnectionString = "<replace>";
+        
+-   Replace `<replace>` with the connection string for your device.
+-   In **Solution Explorer**, right-click the **DeviceClientAmqpSample** project, click **Debug**, and then click **Start new instance** to build and run the sample. The console displays messages as the application sends device-to-cloud messages to IoT Hub.
+-   Use the **DeviceExplorer** utility to observe the messages IoT Hub receives from the **Device Client AMQP Sample** application.
+-   Refer "Monitor device-to-cloud events" in [DeviceExplorer Usage document](https://github.com/Azure/azure-iot-sdks/blob/master/tools/DeviceExplorer/doc/how_to_use_device_explorer.md) to see the data your device is sending.
+-   Refer "Send cloud-to-device messages" in [DeviceExplorer Usage document](https://github.com/Azure/azure-iot-sdks/blob/master/tools/DeviceExplorer/doc/how_to_use_device_explorer.md) for instructions on sending messages to device.
+
+[setup-devbox-windows]: https://github.com/Azure/azure-iot-sdks/blob/master/c/doc/devbox_setup.md
+[lnk-setup-iot-hub]: ../../setup_iothub.md
+[lnk-manage-iot-hub]: ../../manage_iot_hub.md