Io T Developer Portal

Introduction

The objective of this portal is to facilitate set of developer tools to onboard, test and publish custom devices. The device vendors and SDKs developers can directly interact with the system, by onboarding their custom devices that provide specific user scenarios. The tenant can use this portal to cater the internal device onboarding requirements as well as facilitate the business verticals like ‘developer engagement’.

Main areas that can be viewed under Developer Panel are;

  • Device Management
  • Device operations

  • Device SDKs

  • SCE

  • Reports

  • API Management

  • Advance Operations

  • My Profile

The following depicts the flows of Developer Portal;

Developer Home Page

In order to login into the Developer Portal, select ‘I am a Developer’ and it will direct to the Developer Portal login.

Developer Portal Login

A user can enter the email and password credentials to log into the system.

Incase if the user has forgotten the password, click on ‘Forgot Password’ to define a new password.

User Registration

If a user does not have an account, click on ‘Sign Up’ to create a new account.

All fields in the sign up page are mandatory. Once a user clicks on ‘Create Account’, he/she is required to wait till the Tenant Admin approves the created user.

Device Management

Device Dashboard

A developer is facilitated to view device dashboard view which displays one device per dashboard.

Dashboard can be viewed in diverse types if charts by simply selecting from the dropdown. A special feature of this dashboard is that is it dynamic therefore user can prioritize the dashboard views as he wish.

Follow this procedure to create a customized dashboard;

  • Select the map type

  • Insert a Label

  • Select the device

  • Select the event

  • Finally click on ‘Save Widget’

Based on the device selection, field input entries may differ to extract more accurate results.

Further, user is able to share the dashboard as well.

Brands and Device Types

For a developer to configure a device, he/she should have register a brand first, which undergoes an approval process. After the Brand is being approved the developer can add multiple device types which also should await Approval

As per the below image the the Brands and their corresponding Device Types will be listed under Device Management > Bran Type

Device Operations

The user is able to perform device configurations using this interface where custom devices testing can be performed.

Eg – if user create externally controlled robotic arm using R-pi, he can do the testing by controlling the arm using this interface.

Scenes

A scene is to create an Action to be executed on a device based on an Event Trigger The following image shows the existing scenes. You can update them within the same page You can also add other actions to be exicuted

Device Creation

  • Device Addition – this is where user can define a new device

  • Update Device Details – this is the edit view of predefined device details.

Scene Creation

A scene allows the user to configure device actions to occur based on a selected instance.

Eg – if user created a home automation hub using Arduino, he can do the test automation by interacting newly created hub operation with other standard devices already added to his profile.

  • Click on ‘Add Scene’ in order to define a new scene.

Based on the selection of ‘How to occur’ scene creation instances may differ. User will be directed to the following screen displaying three instances for a user to manage a scene and they are;

  1. Manual scene

  2. Event base scene

  3. Schedule scene

  4. Manual Scene – allows to execute scene manually by the user

  • By Time - Under Schedule scene the device gets triggered based on a particular time frame defined

  • Device Event – allows defining a device event occurrence.

Defining Device and Global Actions

In each case user can define a device or global action.

  • Click on ‘Add Action’

  • If user wants to execute a particular scene, select a scene out of the predefined scene and click on ‘Execute’ button.

Device SDK

Device SDK helps a user to easily connect devices to IoT. Therefore simply click on Download button to configure the device. The SDK code is open source and can be modified as the user requirement.

API’s Management

This screen exposes APIs of different applications where each beholds information such as;

  • Username

  • Consumer key

  • Consumer secret

Moreover, each application consists of its own Access Token and Refresh Tokens to be generated when required.

Each application has its own APIs published, therefore user is able to view them and subscribe.

Device Onboarding

A developer is able to onboard devices on his portal itself by configuring the device details and adds related Events and Actions.

Events tab permits the user to define a new event.

Action tab permit the user to define a new action.

Based on the defined action, a json code is generated automatically for developer reference.

Advance Operations

Brand Type

This interface allows defining brand and type by simply clicking on the Add button. Once a brand/type is created, the request is sent to the device admin for approval and then validated at the backend.

  • Click on ‘Add Brand’ button to define a new brand. User should enter a brand name and click on ‘Save’ button.

  • Click on ‘Add Type’ button to define a new type. User should select a brand name and enter a type name and click on ‘Save’ button.

My Profile

A registered user of the developer portal is facilitated to update his/her profile when required. Editable fields are only First Name and Last Name; other fields such as Email, Phone and Created date are not permitted to amend.

Last updated on 15th Mar 2018