• Documentation
  • Device Onboarding Overview

Device Onboarding Overview


The Device Onboarding function acts as a device data protocol gateway, enabling users to use third-party device protocols to access EnOS for dynamic modeling and asset management in IoT Hub. Users can either use the third-party device protocols as they are, or define their own process for two-way conversion of third-party device protocols to EnOS standard protocol.


The below shows a two-way protocol conversion process using Haystack as an example.


../../_images/device_access_diagram_example.png


  1. Tags that describe devices are defined and generated using Haystack through a third-party edge.

  2. Whenever there are changes such as adding new devices, updating device information, etc., the APIs provided by EnOS are invoked, dynamically synchronizing the Haystack tag updates to IoT Hub.

  3. The Haystack data is converted to EnOS standard data in IoT Hub where new models and their instances are generated and information of existing models are updated.

  4. IoT Hub returns the device triple information as an API response to the third-party edge. The third-party edge then encapsulates device data such as the measurement points, attributes, and event message through EnOS SDK, and uses the MQTT protocol to report the data to IoT Hub. Commands from IoT Hub can also be passed to the device for execution using MQTT.

Key Features

Protocol Conversion

Provides two-way conversion of protocols, opening up more ways to connect device data to EnOS. Users are not confined to using only specific protocols and if users need to adapt new protocols as per business needs, they can easily switch without worrying about problems that will result due to protocol incompatibility.

Dynamic Modeling

Provides the option to dynamically generate assets in IoT Hub based on the device data specified by the protocol, eliminating the need to manually create assets in IoT Hub.

How Device Onboarding Works


../../_images/device_access_diagram_process.png


  1. Log in to the EnOS Management Console and navigate to Device Onboarding.

  2. Create a network module such as HTTP Server.

  3. Create and configure a device protocol for device protocol conversion through JavaScript or uploading a JAR package.

  4. Create and configure a protocol gateway such as Haystack with options to dynamically generate models and assets in IoT Hub.

  5. The created models and assets are bound to the protocol gateway, and the subsequent updating of device data can be done using protocols such as MQTT, which can be accessed in the EnOS Management Console.

Limitations

  • Maximum number of URLs for protocol route that can be added when creating a protcol gateway: 5

System-Defined Templates

To facilitate the device onboarding process, EnOS provides system-defined preset network modules and device protocols, and protocol gateway templates so that users do not need to create from scratch. These system-defined presets and templates can be viewed but cannot be edited or deleted.

Network Modules

Name

Type

Haystack HTTP Server (System-Defined)

HTTP Server


Device Protocols

Name

Method

Haystack Codec Protocol (System-Defined)

JAR


Public Protocol Gateways

Name

Description

Network Module

Device Protocol

Tridium N4 Haystack Protocol Gateway

Tridium Haystack protocol gateway for smart building device modeling and access.

Haystack HTTP Server (System-Defined)

Haystack Codec Protocol (System-Defined)

Usage Scenario

You can refer to the tutorial below for a device onboarding usage scenario.