Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update template-plug-and-play-getstarted.md #681

Open
wants to merge 55 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
b6e9c9e
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
feb7b3d
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
96ca91f
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
1872517
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
6b65b4d
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
c7e5702
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
48ee809
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
6ba0928
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
a920f0b
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
0e8a396
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
c2a95ee
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
191e24a
Update template-plug-and-play-getstarted.md
jetwayiot Oct 21, 2020
51e407f
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
bb93f1d
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
d8dce6a
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
bf68edc
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
4ae5b92
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
d97f460
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
baa2b5d
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
e732592
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
262b0a9
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
017ad5b
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
0c23664
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
a3144b1
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
cf8eff8
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
15831fa
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
4259dcd
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
b6a686f
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
11e9f6d
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
5cf7311
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
1eb89f5
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
c6056bd
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
61b72db
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
69146a1
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
155eccd
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
c24ee35
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
408323f
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
01f2093
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
95a8c8f
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
dd75478
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
3afb92d
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
7f80995
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
3472c2f
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
02646a9
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
f2dd399
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
a9a460e
Update template-plug-and-play-getstarted.md
jetwayiot Oct 22, 2020
712cafe
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
4a04166
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
f8a2e17
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
2adfcd7
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
5c4587a
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
f019ad1
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
415ad44
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
7eafa02
Update template-plug-and-play-getstarted.md
jetwayiot Oct 23, 2020
cb197ac
Delete template-plug-and-play-getstarted.md
jetwayiot Oct 31, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,93 +1,79 @@
---
platform: {enter the OS name running on device}
device: {enter your device name here}
language: {}
platform: {Windows 10}
device: {HBFBU691-3455-B}
language: {Node.js}
---

Connect {enter your device name here} device to your Azure IoT services
Connect {HBFBU691-3455-B} device to your Azure IoT services
===

---
# Table of Contents

- [Introduction](#Introduction)
- [Prerequisites](#Prerequisites)
- [Prepare the Device](#preparethedevice)
- [Integration with Azure IoT Explorer](#IntegrationwithAzureIoTExplorer)
- [Additional Links](#AdditionalLinks)

# Instructions for using this template

- Replace the text in {placeholders} with correct values.
- Delete the lines {{enclosed}} after following the instructions enclosed between them.
- It is advisable to use external links, wherever possible.
- Remove this section from final document.

# Tips for authoring great getting started guide (remove this section)
Following below tips reduces operational overhead via email exchange and accelerate your overall certification process

- When there are multiple options to provision devices using DPS, try to define the golden path in the main flow. Put other paths in #Additional information section below
- Provide some paragraphs to the headers and avoid headers with just a link
- Device application must be either pre-installed on the device or download-able via various means (partner hosted website/GitHub etc). Be specific about the steps on deploying or flashing the device application
- Be specific about how to provision a device using DPS. DPS ID scope, registration ID and attestation methods (X.509, TPM or SAS key) configuration

- Introduction
- Step 1: Prerequisites
- Step 2: Prepare your Device
- Step 3: Build and Run the Sample
- Next Steps

<a name="Introduction"></a>

# Introduction

**About this document**

This document describes how to connect {enter your device name here} to Azure IoT Hub using the Azure IoT Explorer with certified device application and device models.

IoT Plug and Play certified device simplifies the process of building devices without custom device code. Using Solution builders can integrated quickly using the certified IoT Plug and Play enabled device based on Azure IoT Central as well as third-party solutions.
This document describes how to connect [HBFBU691-3455-B](https://www.jetwayipc.com/product/hbfbu691-3455-b-series/) device running Windows 10 with Azure IoT SDK. This multi-step process includes:

This getting started guide provides step by step instruction on getting the device provisioned to Azure IoT Hub using Device Provisioning Service (DPS) and using Azure IoT Explorer to interact with device's capabilities.

{Please provide introduction and features of your device here}
- Configuring Azure IoT Hub
- Registering your IoT device
- Build and deploy Azure IoT SDK on device

<a name="Prerequisites"></a>
# Prerequisites
# Step 1: Prerequisites

You should have the following items ready before beginning the process:
- [Prepare your development environment](https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/devbox_setup.md)
- [Setup your IoT hub](https://github.com/Azure/azure-iot-device-ecosystem/blob/master/setup_iothub.md)
- [Provision your device and get its credentials](https://github.com/Azure/azure-iot-device-ecosystem/blob/master/manage_iot_hub.md)
- HBFBU691-3455-B device.
- VGA Cable,USB Keyboard/Mouse, and the Internet connection

- [Azure Account](https://portal.azure.com)
- [Azure IoT Hub Instance](https://docs.microsoft.com/en-us/azure/iot-hub/about-iot-hub)
- [Azure IoT Hub Device Provisioning Service](https://docs.microsoft.com/en-us/azure/iot-dps/quick-setup-auto-provision)
- [Azure IoT Public Model Repository](https://docs.microsoft.com/en-us/azure/iot-pnp/concepts-model-repository)
<a name="preparethedevice"></a>
# Step 2: Prepare the Device.

- Connect the power adapter, USB Keyborad/Mouse with [HBFBU691-3455-B](https://www.jetwayipc.com/product/hbfbu691-3455-b-series/) .
- Wait until the operating system is ready.

<a name="preparethedevice"></a>
# Prepare the Device.
# Step 3: Build and Run the sample

In Set up your environment, you created four environment variables to configure the sample to use the Device Provisioning Service (DPS) to connect to your IoT hub:

- IOTHUB_DEVICE_SECURITY_TYPE with the value DPS
- IOTHUB_DEVICE_DPS_ID_SCOPE with the DPS ID scope.
- IOTHUB_DEVICE_DPS_DEVICE_ID with the value my-pnp-device.
- IOTHUB_DEVICE_DPS_DEVICE_KEY with the enrollment primary key.
- IOTHUB_DEVICE_DPS_ENDPOINT with the value global.azure-devices-provisioning.net.
To learn more about the sample configuration, see the sample readme.

In this quickstart, you use a sample thermostat device that's written in Node.js as the IoT Plug and Play device. To run the sample device:

**Development Environmental setup**
1.Open a terminal window and navigate to the local folder that contains the Microsoft Azure IoT SDK for Node.js repository you cloned from GitHub.

IoT Plug and Play Certification is certifying specific device code implementation against specific device model. Device builders should either pre-install device code or make the binary download-able.{Please include the below pointers specific to device in this section and add screen shots where ever necessary}
2.This terminal window is used as your device terminal. Go to the folder of your cloned repository, and navigate to the /azure-iot-sdk-node/device/samples/pnp folder.Install all the dependencies by running the following command:

1. Describing the capabilities of the device
2. How to setup the device and connect power
3. How to take the DPS configuration and program the device (Note : DPS ID scope should be configured w/o recompiling the embedded code)
4. How to configure device over Wifi, cellular, screens, etc.
5. Add the links of external software/tools as required
6. Add steps on how to run the device code/how and where to download binary and then run on device. If you have multiple options on how to deploy device code please mention only one option here and other options in Additional links section
npm install

<a name="IntegrationwithAzureIoTExplorer"></a>
# Integration with Azure IoT Explorer
3.Run the sample thermostat device with the following command:

- Include the steps on how to connect the IoT Plug and Play Device to Azure IoT Explorer
- Include screenshots and comments on how IoT Explorer shows/visualize telemetry , commands and properties coming from your IoT Plug and Play device.
- Include the steps on how to interact with devices (telemetry, commands properties)
- Ensure to attach the screenshot on consuming the device models available in public repository (not local folder) when using Azure IoT Explorer
node simple_thermostat.js

# Additional information
Put any additional information here such as alternative paths to deploy device application etc.
4.You see messages saying that the device has sent some information and reported itself online. These messages indicate that the device has begun sending telemetry data to the hub, and is now ready to receive commands and property updates. Don't close this terminal, you need it to confirm the service sample is working.

<a name="AdditionalLinks"></a>
# Additional Links
# Next Steps

Please refer to the below link for additional information for Plug and Play

- [Manage cloud device messaging with Azure-IoT-Explorer](https://github.com/Azure/azure-iot-explorer/releases)
- [Import the Plug and Play model](https://docs.microsoft.com/en-us/azure/iot-pnp/concepts-model-repository)
- [Configure to connect to IoT Hub](https://docs.microsoft.com/en-us/azure/iot-pnp/quickstart-connect-device-c)
- [How to use IoT Explorer to interact with the device ](https://docs.microsoft.com/en-us/azure/iot-pnp/howto-use-iot-explorer#install-azure-iot-explorer)
- [How to use IoT Explorer to interact with the device ](https://docs.microsoft.com/en-us/azure/iot-pnp/howto-use-iot-explorer#install-azure-iot-explorer)