diff --git a/doc/get_started/linux-iopac5542-c-c.md b/doc/get_started/linux-iopac5542-c-c.md new file mode 100644 index 00000000000..33e7f4f0032 --- /dev/null +++ b/doc/get_started/linux-iopac5542-c-c.md @@ -0,0 +1,98 @@ +--- +platform: linux +device: iopac5542-c +language: c +--- + +Run a simple C sample on ioPAC5542-C device running linux +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) +- [Tips](#tips) + + +# Introduction + +**About this document** + +This document describes how to connect ioPAC5542-C device running linux 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 + + +# Step 1: Prerequisites + +You should have the following items ready before beginning the process: + +- [Prepare your development environment][setup-devbox-linux] +- [Setup your IoT hub][lnk-setup-iot-hub] +- [Provision your device and get its credentials][lnk-manage-iot-hub] +- ioPAC5542-C device. +- the ethernet cable and the utility supports ssh + + +# Step 2: Prepare your Device +- Please refer the document "ioPAC_RTU_Software_Users_Manual_v1.pdf". It can be downloaded from Moxa offical webwite http://www.moxa.com/ + + +# Step 3: Build and Run the sample + + +## 3.1 Build SDK and sample + +- Open a PuTTY session and connect to the device. + +- Install the prerequisite packages for the Microsoft Azure IoT Device SDK for C by issuing the following commands from the command line on your board: + + It's enough to use the toolchain Moxa provided. No need alternative packages + +- Download the Microsoft Azure IoT Device SDK for C to the board by issuing the following command on the board:: + + git clone --recursive https://github.com/Azure/azure-iot-sdks.git + +- Edit the following file using any text editor of your choice: + + azure-iot-sdks/c/iothub_client/samples/iothub_client_sample_amqp/iothub_client_sample_amqp.c + +- Find the following place holder for IoT connection string: + + static const char* connectionString = "[device connection string]"; + +- Replace the above placeholder with device connection string you obtained in [Step 1](#Prerequisites) and save the changes. + +- Build the SDK using following command. + + sudo ./azure-iot-sdks/c/build_all/linux/build.sh + +## 3.2 Send Device Events to IoT Hub: + +- Run the sample by issuing following command: + + ~/azure-iot-sdks/c/cmake/iotsdk_linux/iothub_client/samples/iothub_client_sample_amqp/iothub_client_sample_amqp + +- See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to observe the messages IoT Hub receives from the application. + +## 3.3 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. + + +# Tips + +- If you just want to build the serializer samples, run the following commands: + + ``` + cd ./c/serializer/build/linux + make -f makefile.linux all + ``` + +[setup-devbox-linux]: 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 diff --git a/doc/get_started/windows10-aimb-203-csharp.md b/doc/get_started/windows10-aimb-203-csharp.md new file mode 100644 index 00000000000..94f696b19a7 --- /dev/null +++ b/doc/get_started/windows10-aimb-203-csharp.md @@ -0,0 +1,63 @@ +--- +platform: windows 10 +device: aimb-203 +language: csharp +--- + +Run a simple Csharp sample on AIMB-203 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect AIMB-203 device running Windows 10 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 + + +# 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] +- AIMB-203 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-2jkkgr/aimb-203/mod_a46984f8-caa9-433a-a720-e1815a8c16a3). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-aimb-215-csharp.md b/doc/get_started/windows10-aimb-215-csharp.md new file mode 100644 index 00000000000..ef90b22961b --- /dev/null +++ b/doc/get_started/windows10-aimb-215-csharp.md @@ -0,0 +1,63 @@ +--- +platform: windows 10 +device: aimb-215 +language: csharp +--- + +Run a simple Csharp sample on AIMB-215 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect AIMB-215 device running Windows 10 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 + + +# 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] +- AIMB-215 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-2jkkgr/aimb-215-b1/mod_4373ad48-1a60-440d-8785-4bac45ab03ea). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-aimb-501-csharp.md b/doc/get_started/windows10-aimb-501-csharp.md new file mode 100644 index 00000000000..a20ff36b6d5 --- /dev/null +++ b/doc/get_started/windows10-aimb-501-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: aimb-501 +language: csharp +--- +Run a simple Csharp sample on AIMB-501 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect AIMB-501 device running Windows 10 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 + + +# 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] +- AIMB-501 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-2jkkgc/aimb-501/mod_3ed96dd6-792f-431d-b3e7-c524380b15d6). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-aimb-503-csharp.md b/doc/get_started/windows10-aimb-503-csharp.md new file mode 100644 index 00000000000..006a9b1cdae --- /dev/null +++ b/doc/get_started/windows10-aimb-503-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: aimb-503 +language: csharp +--- +Run a simple Csharp sample on AIMB-503 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect AIMB-503 device running Windows 10 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 + + +# 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] +- AIMB-503 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-2jkkgc/aimb-503/mod_5db22cce-25c7-488d-a5a4-f76a4061161b). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-ark-1123h-csharp.md b/doc/get_started/windows10-ark-1123h-csharp.md new file mode 100644 index 00000000000..644cca2bb63 --- /dev/null +++ b/doc/get_started/windows10-ark-1123h-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: ark-1123h +language: csharp +--- +Run a simple Csharp sample on ARK-1123H device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect ARK-1123H device running Windows 10 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 + + +# 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] +- ARK-1123H device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/92d96fda-cdd3-409d-aae5-2e516c0f1b01/ark-1123h/mod_590fcfdc-278c-4). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-ark-2121l-csharp.md b/doc/get_started/windows10-ark-2121l-csharp.md new file mode 100644 index 00000000000..cf67ef3b2f8 --- /dev/null +++ b/doc/get_started/windows10-ark-2121l-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: ark-2121l +language: csharp +--- +Run a simple Csharp sample on ARK-2121L device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect ARK-2121L device running Windows 10 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 + + +# 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] +- ARK-2121L device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/ark-2000_series_embedded_box_pcs/ark-2121l/mod_dd092808-0832-44bc-). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-dpx-s430-csharp.md b/doc/get_started/windows10-dpx-s430-csharp.md new file mode 100644 index 00000000000..de2d5dd07e0 --- /dev/null +++ b/doc/get_started/windows10-dpx-s430-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: dpx-S430 +language: csharp +--- +Run a simple Csharp sample on DPX-S430 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect DPX-S430 device running Windows 10 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 + + +# 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] +- DPX-S430 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/standalone_(s_series)/dpx-s430/mod_2c298749-cd5f-4c67-928a-0325836). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-dpx-s435-csharp.md b/doc/get_started/windows10-dpx-s435-csharp.md new file mode 100644 index 00000000000..d78b35009f4 --- /dev/null +++ b/doc/get_started/windows10-dpx-s435-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: dpx-s435 +language: csharp +--- +Run a simple Csharp sample on DPX-S435 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect DPX-S435 device running Windows 10 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 + + +# 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] +- DPX-S435 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www2.advantech.com/products/search.aspx?keyword=dpx-s435). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-ds-060-csharp.md b/doc/get_started/windows10-ds-060-csharp.md new file mode 100644 index 00000000000..ca5fbdeb034 --- /dev/null +++ b/doc/get_started/windows10-ds-060-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: ds-060 +language: csharp +--- +Run a simple Csharp sample on DS-060 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect DS-060 device running Windows 10 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 + + +# 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] +- DS-060 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/5408f56b-e978-41fa-9509-0b9fcd27e902/ds-060/mod_c739322c-c2c7-43f1). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-ds-370-csharp.md b/doc/get_started/windows10-ds-370-csharp.md new file mode 100644 index 00000000000..6e9be688304 --- /dev/null +++ b/doc/get_started/windows10-ds-370-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: ds-370 +language: csharp +--- +Run a simple Csharp sample on DS-370 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect DS-370 device running Windows 10 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 + + +# 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] +- DS-370 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/92d96fda-cdd3-409d-aae5-2e516c0f1b01/ds-370/mod_ada71950-a0b5-4ee2). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-mio-2261-csharp.md b/doc/get_started/windows10-mio-2261-csharp.md new file mode 100644 index 00000000000..afdcf2186fa --- /dev/null +++ b/doc/get_started/windows10-mio-2261-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: mio-2261 +language: csharp +--- +Run a simple Csharp sample on MIO-2261 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect MIO-2261 device running Windows 10 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 + + +# 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] +- MIO-2261 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/mi%7B%7B--o_ultra_single_board_computers/mio-2261/mod_a06b85aa-873). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-mio-2263-csharp.md b/doc/get_started/windows10-mio-2263-csharp.md new file mode 100644 index 00000000000..c435839aabd --- /dev/null +++ b/doc/get_started/windows10-mio-2263-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: mio-2263 +language: csharp +--- +Run a simple Csharp sample on MIO-2263 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect MIO-2263 device running Windows 10 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 + + +# 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] +- MIO-2263 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/mi%7B%7B--o_ultra_single_board_computers/mio-2263/mod_3c9191fb-edf). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-mio-5250-csharp.md b/doc/get_started/windows10-mio-5250-csharp.md new file mode 100644 index 00000000000..6e3a4040bd9 --- /dev/null +++ b/doc/get_started/windows10-mio-5250-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: mio-5250 +language: csharp +--- +Run a simple Csharp sample on MIO-5250 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect MIO-5250 device running Windows 10 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 + + +# 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] +- MIO-5250 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/bc6786b7-b69b-4fdd-9b63-79180dbd5dcb/mio-5250/mod_eea5e107-b1e6-49). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-mio-5251-csharp.md b/doc/get_started/windows10-mio-5251-csharp.md new file mode 100644 index 00000000000..a86e8d5f86f --- /dev/null +++ b/doc/get_started/windows10-mio-5251-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: mio-5251 +language: csharp +--- +Run a simple Csharp sample on MIO-5251 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect MIO-5251 device running Windows 10 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 + + +# 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] +- MIO-5251 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/bc6786b7-b69b-4fdd-9b63-79180dbd5dcb/mio-5251/mod_ff8534cc-e858-40). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-pcm-3356-csharp.md b/doc/get_started/windows10-pcm-3356-csharp.md new file mode 100644 index 00000000000..d969c76675d --- /dev/null +++ b/doc/get_started/windows10-pcm-3356-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: pcm-3356 +language: csharp +--- +Run a simple Csharp sample on PCM-3356 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect PCM-3356 device running Windows 10 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 + + +# 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] +- PCM-3356 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-2jkltu/pcm-3356/mod_0706f4d5-2e44-473a-a7b7-53bd1a7bd1a0). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-pcm-9365-csharp.md b/doc/get_started/windows10-pcm-9365-csharp.md new file mode 100644 index 00000000000..d5373e8eccd --- /dev/null +++ b/doc/get_started/windows10-pcm-9365-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: pcm-9365 +language: csharp +--- +Run a simple Csharp sample on PCM-9365 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect PCM-9365 device running Windows 10 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 + + +# 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] +- PCM-9365 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-2jkd1i/pcm-9365/mod_5051a369-13cb-4cda-a44b-cc34e37d6196). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-pcm-9376-csharp.md b/doc/get_started/windows10-pcm-9376-csharp.md new file mode 100644 index 00000000000..c204d518e7d --- /dev/null +++ b/doc/get_started/windows10-pcm-9376-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: pcm-9376 +language: csharp +--- +Run a simple Csharp sample on PCM-9376 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect PCM-9376 device running Windows 10 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 + + +# 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] +- PCM-9376 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-2jkd1i/pcm-9376/mod_9870f332-c45f-4ac1-acf0-3407038c0d4a). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-som-5893-csharp.md b/doc/get_started/windows10-som-5893-csharp.md new file mode 100644 index 00000000000..1db2e9a5792 --- /dev/null +++ b/doc/get_started/windows10-som-5893-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: som-5893 +language: csharp +--- +Run a simple Csharp sample on SOM-5893 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect SOM-5893 device running Windows 10 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 + + +# 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] +- SOM-5893 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-e0e7i7/som-5893/mod_7f19c5d2-2fee-4b7f-a551-43c826c20c25). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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 diff --git a/doc/get_started/windows10-som-6867-csharp.md b/doc/get_started/windows10-som-6867-csharp.md new file mode 100644 index 00000000000..230b605fb3f --- /dev/null +++ b/doc/get_started/windows10-som-6867-csharp.md @@ -0,0 +1,62 @@ +--- +platform: windows 10 +device: som-6867 +language: csharp +--- +Run a simple Csharp sample on SOM-6867 device running Windows 10 +=== +--- + +# Table of Contents + +- [Introduction](#Introduction) +- [Step 1: Prerequisites](#Prerequisites) +- [Step 2: Prepare your Device](#PrepareDevice) +- [Step 3: Build and Run the Sample](#Build) + + +# Introduction + +**About this document** + +This document describes how to connect SOM-6867 device running Windows 10 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 + + +# 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] +- SOM-6867 device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [device website](http://www.advantech.com/products/1-34h3r7/som-6867/mod_4cbd463d-32cd-4440-921a-07b2421ec744). + + +# 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 **DeviceClientHttpSample** project, open the ***Program.cs*** file. +- Locate the following code in the file: + + private const string DeviceConnectionString = ""; + +- Replace `` with the connection string for your device. +- In **Solution Explorer**, right-click the **DeviceClientHttpSample** 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