From b911106288280122f892a7b16bd5ffad1834356b Mon Sep 17 00:00:00 2001 From: ashokkhurana Date: Fri, 16 Dec 2016 14:03:30 -0800 Subject: [PATCH] Getting Started Document (#1029) F10 and F7 from iRuggby Bracewell Family from MSC Titan S from sam4s E7708T from Unistrong --- doc/get_started/linux-msc-ldk-braswell-c.md | 93 +++++++++++++++++++++ doc/get_started/windows10-F10-csharp.md | 64 ++++++++++++++ doc/get_started/windows10-F7-csharp.md | 64 ++++++++++++++ doc/get_started/windows10-titan-s-c.md | 83 ++++++++++++++++++ doc/get_started/windows10_e7708t_csharp.md | 61 ++++++++++++++ 5 files changed, 365 insertions(+) create mode 100644 doc/get_started/linux-msc-ldk-braswell-c.md create mode 100644 doc/get_started/windows10-F10-csharp.md create mode 100644 doc/get_started/windows10-F7-csharp.md create mode 100644 doc/get_started/windows10-titan-s-c.md create mode 100644 doc/get_started/windows10_e7708t_csharp.md diff --git a/doc/get_started/linux-msc-ldk-braswell-c.md b/doc/get_started/linux-msc-ldk-braswell-c.md new file mode 100644 index 00000000..04018dbb --- /dev/null +++ b/doc/get_started/linux-msc-ldk-braswell-c.md @@ -0,0 +1,93 @@ +--- +platform: Linux (MSC-LDK) +device: Braswell +language: c +--- + +Run a simple C sample on a Braswell family device with MSC-LDK +=== +--- + +# 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 the Braswell device running MSC-LDK 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: + +- [Setup your IoT hub][lnk-setup-iot-hub] +- [Provision your device and get its credentials][lnk-manage-iot-hub] +- Braswell module and baseboard. +- MSC-LDK (Linux Development Kit) + + +# Step 2: Prepare your Device +- Follow the instructions in chapter "Getting Started" of the [devices user manual][lnk-user-manual] + + +# Step 3: Build and Run the sample + + +## 3.1 Build SDK and sample + +- The Microsoft Azure IoT Device SDK for C is already installed in the standard images as the package "azure-iot-sdks-samples". + +- These images can be built after MSC-LDK installation with: + + make msc-image-sato + + or + + make msc-image-lxqt + +## 3.2 Send Device Events to IoT Hub: + +- Open a telnet session and connect to the device. +- Run the sample by issuing following command: + + **For HTTP:** + + iothub_client_sample_http "" + +- Replace the above placeholder "<device connection string>" with device connection string you obtained in [Step 1](#Step-1:-Prerequisites) and save the changes. + +- 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: + + ./build.sh bitbake -c cleanall azure-iot-sdks + ./build.sh bitbake -c compile azure-iot-sdks + ./build.sh bitbake -c devshell azure-iot-sdks + + and in the devshell + + ../temp/run.do_compile + +[lnk-user-manual]:https://www.msc-technologies.eu/fileadmin/documentpool/Support-Center/COMExpress/C6C-BW/20-Drivers/70-Linux/MSC_C6C-BW-ldk-bsp-01004.pdf + +[lnk-setup-iot-hub]: ../../setup_iothub.md +[lnk-manage-iot-hub]: ../../manage_iot_hub.md diff --git a/doc/get_started/windows10-F10-csharp.md b/doc/get_started/windows10-F10-csharp.md new file mode 100644 index 00000000..e3aa74f0 --- /dev/null +++ b/doc/get_started/windows10-F10-csharp.md @@ -0,0 +1,64 @@ +--- +platform: Windows 10 +device: iRUGGY F10 Mobile Tablet +language: csharp +--- + +Run a simple Csharp sample on iRUGGY F10 Mobile Tablet 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 iRUGGY F10 Mobile Tablet 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] +- iRUGGY F10 Mobile Tablet device. + + +# Step 2: Prepare your Device + +- Follow the instructions from http://www.iruggy.com/products/tablet-f7-10 + + +# 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 HTTP 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-F7-csharp.md b/doc/get_started/windows10-F7-csharp.md new file mode 100644 index 00000000..3a9fed19 --- /dev/null +++ b/doc/get_started/windows10-F7-csharp.md @@ -0,0 +1,64 @@ +--- +platform: Windows 10 +device: iRUGGY F7 Mobile Tablet +language: csharp +--- + +Run a simple Csharp sample on iRUGGY F7 Mobile Tablet 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 iRUGGY F7 Mobile Tablet 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] +- iRUGGY F7 Mobile Tablet device. + + +# Step 2: Prepare your Device + +- Follow the instructions from http://www.iruggy.com/products/tablet-f7-10 + + +# 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 HTTP 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-titan-s-c.md b/doc/get_started/windows10-titan-s-c.md new file mode 100644 index 00000000..f7c81e6f --- /dev/null +++ b/doc/get_started/windows10-titan-s-c.md @@ -0,0 +1,83 @@ +--- +platform: Windows 10 IoT Enterprise LTSB +device: Titan-S +language: c +--- + +Run a simple C sample on Titan-S 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) + + +# Introduction + +**About this document** + +This document describes how to connect Titan-S device running Windows 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 + + +# Step 1: Prerequisites + +You should have the following items ready before beginning the process: + +- Computer with GitHub installed and access to the [azure-iot-sdks GitHub](https://github.com/Azure/azure-iot-sdks) private repository. +- Install any version of [Visual Studio 2015](https://www.visualstudio.com/downloads/download-visual-studio-vs.aspx). + Make sure you have following components selected: + - Programming Languages + - Visual C++ + - Common Tools for Visual C++ 2015 + - Microsoft Foundation Classes for C++ + - Windows and Web Development + - Microsoft SQL server Data Tools + - Universal Windows App Development Tools + - Tools and Windows 10 SDK + - Windows 10 SDK +- Install [Microsoft Azure SDK for ..NET](http://www.microsoft.com/download/details.aspx?id=48178) +- [Setup your IoT hub][lnk-setup-iot-hub] +- [Provision your device and get its credentials][lnk-manage-iot-hub] +- Titan-S device. + + +# Step 2: Prepare your Device + +Install Windows 10 IoT Enterprise LTSB on Titan-S +• Create a bootable USB Drive. Please follow this guide on [how to create a bootable drive]. +• Insert the bootable USB Drive from the previous step into your Titan-S. Turn on your Titan-S device and press the Delete key. +• Change the BIOS Boot option filter to UEFI and Legacy. +• Change the BIOS OS Selection to "Windows 10". +• Change the Boot Option Priorities to boot from your USB Drive. +• Save changes and restart your Titan-S. Follow on screen instructions to install Windows Operating System on your Titan-S. + + + +# Step 3: Build SDK and Run the sample + +- Start a new instance of Visual Studio 2015. Open the **iothub_client_sample_http.sln** solution in the **azureIotSDks\c\iothub_client\samples\iothub_client_sample_http\windows** folder in your local copy of the repository. + +- In Visual Studio, in **Solution Explorer**, navigate to **samples** folder. + +- In the **iothub_client_sample_http** project, open the **iothub_client_sample_http.c** file. + +- Locate the following code in the file: + + static const char* connectionString = "[device connection string]"; + +- Replace the above placeholder with device connection string you obtained in [Step 1](#Step-1:-Prerequisites) and save the changes. + +- In visual Studio, under Solution Explorer, right-click the **iothub_client_sample_http** project, click **Debug −> Start new instance** to build and run the sample. The console displays messages as the application sends device-to-cloud messages to IoT Hub. + +- See [Manage IoT Hub][lnk-manage-iot-hub] to learn how to observe the messages IoT Hub receives from the application and how to send cloud-to-device messages to the application. + +[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_e7708t_csharp.md b/doc/get_started/windows10_e7708t_csharp.md new file mode 100644 index 00000000..d285bd5c --- /dev/null +++ b/doc/get_started/windows10_e7708t_csharp.md @@ -0,0 +1,61 @@ +--- +platform: windows 10 +device: E7708T +language: csharp +--- + +Run a simple Csharp sample on E7708T 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 E7708T 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: + +- [Setup your IoT hub][lnk-setup-iot-hub] +- [Provision your device and get its credentials][lnk-manage-iot-hub] +- E7708T device. + + +# Step 2: Prepare your Device + +- Follow the instructions from [devices website]http://www.unistrong.com/ + + +# 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 `` 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. + +[lnk-setup-iot-hub]: ../../setup_iothub.md +[lnk-manage-iot-hub]: ../../manage_iot_hub.md +