Quickstart Guide

Quickstart Guide

As a partner or solution provider, you can use IoTConnect to create an IoT application for your company, customers or end-users. This guide will explain the basic requirements and provide steps to quickly get started with the platform. After going through this guide, you will be able to;

  • Create a template
  • Add a device
  • Send data to IoTConnect
  • Check device / sensor output using a simulator or actual device
  • View real-time telemetry data

Before you begin, you need to have completed the following;

Steps to quickly get started

  1. Platform setup and company registration

From the portal, navigate to the IoTConnect environment that you have created and sign in to the platform. You will see the default IoTConnect dashboard. Your selected IoTConnect environment will have a company profile with a unique CPID.

  1. Create a template

Templates consist of unique identifiers and allow you to allocate attributes, properties and commands associated with the devices you want to connect. To get started quickly you can create a standard template using JSON format.

Learn more about templates in IoTConnect here.

  1. Create a device

You need to provide a unique id which helps to identify the device along with a display name. Select the template which you have defined in the earlier step to proceed with device creation. You can also leave notes or describe the device that you are adding. The device will be added in active state and displayed on the devices screen.

Depending on the device type selected (Type 1 or Type 2) while creating the template, the system will give an option to select the tag (parent device) under which you can add multiple devices.

Learn more about parent devices and tags here.

Clicking on the unique id or the edit button on this screen will display a new screen with numerous other parameters.

Note: To add or create a device you will need to create an entity. To learn about entity creation in IoTConnect, visit our user guide.

4. Send data to IoTConnect and check sensor output

A. Device simulation

IoTConnect provides a simulator to check the flow of data. The data simulation is done for a defined interval and duration. To check the connectivity and data flow, you can simulate a device from here.

By clicking on the unique id of a device, you will see a radio button on the top right corner to enable the simulator screen. Read more about device simulation here.

Note: You will see simulator radio button only when your device is registered in the platform and attributes are defined for the device.

B. SDK integration for actual devices

For successful device to cloud and cloud to device communication, IoTConnect provides SDKs for various programming languages. SDK integration consists of;

i. Initialize / Create IoTConnectSDK object

ii. Send data

iii. Receive data / Callback function

For more information on SDK integration, click here.

For SDK code samples, click here.

  1. View real-time data – telemetry / graph / tabular

Once you have achieved connectivity, you can view real-time data of the added device by clicking on the device’s unique id from the list of devices. Navigate to the Live Data tab which gives you telemetry, graph and tabular options. Clicking on each will show you the data received as per the intervals and durations you defined in the earlier steps.

For more information on viewing live data, click here.