Overview

Devices are the repository for sensors and sensor data within the iTwin IoT platform. Devices are added to the platform in a few ways. Connections like Threads, Geonets, and Strands add Devices when they are added to the platform, providing Diagnostics sensors for the Connections and a Device Configuration area for connected analog sensors. API Connections are auto-populated with Devices and Sensors based on what information being transmitted in the file transfer. Other sensor hardware physically connected to Thread ports are manually added by the user as Devices in the application. Below are two graphic representations of the Device connections and their hierarchy in the application.

Thread Connection with Devices & Sensors

Geomos Connection

Devices in the Connectivity Module

Once Devices have been added to the application via one of the means outlined in the Overview above, the Device and associated sensors will be visible in the right window of the Connectivity Module. The example below shows a Thread Device with Diagnostic sensors listed below the Device and a Tilt Array Device with the sensor segments listed below the Device. Each Device will be associated back to a single Connection. 

 

Adding a Device

A Device added to a Thread port is the most common instance whereby a user must manually add a Device to the platform. The Thread must be added as a connection before a Device can be added within the application. That device will then populate with the associated sensors after setup in the application. The below steps will briefly cover how to Add a Device connected to a Thread. For more information regarding adding and configuring a specific Device, search the Hardware Information section of articles in the iTwin IoT Wiki.

1. Navigate to the Connectivity page.

2. Press the + button directly on a THREAD to add a Device to it. This automatically populates the Thread connect code in step 5 below.

3. You may also add a device from the + Device button in the Devices & Sensors Section.

4. On the next page, begin searching for your Device by typing in the device name or manufacturer. Select the Device you wish to add once the Device name is auto-populated in the dropdown. Once a Device has been selected, configuration details specific to the device connection will appear, as illustrated in the image below.

5.  Type in the Connect Code of the THREAD that the Device will be connected to. If Step 2 was followed previously, this field will be pre-populated.

6.  Next, select the THREAD Device Port that will be used. Depending on the model, Threads will have 2 or 3 ports. These ports are demarked by labels or small, indented dots. Select the number of the respective port into which the device connect cable is plugged. Some Devices will also required the user to select a Model via a dropdown between the Device Port input and the "Next" icon.

7.  Press   to proceed to the Device Configuration page.

Many Devices will require additional configuration in order to provide the user with accurate data or calculated metrics. The configuration page is specific to the Device type and its configuration requirements, as illustrated below.

For more information regarding configuring Devices and Sensors and additional sensor settings, visit the page specific to that Device.

A device can be also associated with a database connection like a Geomos or Move connection. In this scenario, the device is just used to group the sensors beneath it. These will be automatically added when the connection is added.

Note: A user must have the correct project-level role to add Connections and Devices. For more information, visit the Roles Overview article.

Device Status

The device status will mimic its parent connection if the connection turns blue or red. A Device can also go red independently of the connection due to device-level issues.

Device Functions

Device functions are the controls available for Devices that are displayed across the top of the Devices & Sensors window and next to the Device.