IoT Developer Portal


Introduction

The objective of this portal is to facilitate a set of developer tools to onboard, test and publish custom devices.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 to facilitate the business verticals like developer engagement.

Main areas that can be viewed under the Developer Panel are,

  • Device Management
    • Device Dashboard
    • Advance Dashboard
    • Dynamic Dashboard
    • Brand Type
    • Device Onboarding (json)
    • Device Onboarding (plugin)
    • Device Operations
    • Device SDKs
  • API Management
  • Documentation
  • My Profile

The following depicts the flow of Developer Portal.

flow diagram

Developer Home Page

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

homepage

Developer Portal Login

A user can enter the email along with the password to log into the system.In case if the user has forgotten the password, click on Forgot Password to define a new password.
If a user does not have an account, click on Sign Up to create a new account.

login

User Registration

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.

registration

Device Management

Dashboard

A developer is facilitated to view device dashboard view which displays one device per dashboard. Dashboard can be viewed in diverse types of charts by simply selecting from the dropdown. A special feature of this dashboard is Dynamic Dashboard where a developer can prioritize the dashboard views as he wish.

dashboard

follow the below steps to customize your dashboard

  • Click the Add Widget
  • Select the Device Definition
  • Select the Device
  • Select the Event,Event parameters & Event state
  • Select the Graph type and provide Graph label
  • Finally Click the Save Widget

{primary} Based on the device selection, field input entries may differ to extract more accurate results.
Furthermore, the developer is able to share the dashboard as well.

{info} Look into the Dynamic Dashboard, it has more features and cool gadgets.
Check it out.

Brands and Device Types

For a developer to configure a device, he/she have to 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 Brands and their corresponding Device Types will be listed under Device Management > Brand Type

brand type

Device Onboarding

A developer can create 'Device Definitions' by configuring the device details and add the related 'Events and Actions'.

device onboarding

The 'Event' tab permits the developer to define a new event. This encourages you to get readings from Devices.
when you create an Event, the JSON message format will generate automatically according to your parameters. it helps you to send events from devices to IoT core.

event

The 'Action' tab permits the developer to define a new action. This encourages you to send actions to the device.
For every action, you will have a unique JSON message format that helps you to set actions from IoT core to the device.

action

Device Operations

Devices

When you create 'Device Definitions', you can create a device by clicking the + Add Device button.
The Developer can perform actions by select an action and click Execute button.
The device event parameters are listed down under the 'Device Information' section.
For Example, if the developer creates an externally controlled robotic arm using R-pi, he/she can do the testing by controlling the arm using this interface.

device Operation

Scenes

Scenes are useful to configure device actions that are occur based on the selection of How to occur.
For Example, if you created a home automation hub using Arduino, you can do the test automation by interacting the newly created hub operation with other standard devices that are already added to your profile.
Click the Scenes tab and click the + Add Scene to create new Scenes.

scenes

{info} Don't forget to add actions for your Scene.

There are 3 ways to manage an instance of the Scene,

  1. Manual based Scene
  2. Event based Scene
  3. Time based Scene

  1. Manual based Scene - allows to execute the scene manually by the user. manual scene
  2. Event based Scene - allows to execute the scene by triggerring an event. event scene

{primary} An event based scene have another option call Condition.
With this feature you can add conditions for event parameters as well.

condition

  1. Time based Scene - allows to execute the scene by a particular time. you can set the Date and Time as well. time scene

{primary} When you defining an Action in the Scene part, there is an option called Global. It has some Cool options like sending SMS, email, etc. Check It Out!

global Action

API Management

API Management helps you to access Your IoT core with API calls. When you create a developer account X-Secret key is generated for you.

api management

{primary} Did you know?
IoT Developer Portal Creates Postman Collections to manage APIs easily. You can download your Postman Collections at the top right corner of API management.

My Profile

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

my profile