i4connected Knowledgebase

Device Management

Abstract

Check out this article to learn how to manage i4connected Devices and understand the functionality they have in the application.

Device Management article's scope is to guide the user through the usage of devices.

The i4connected portal provides the functionality required to add and edit devices and signals in the i4connected system. This functionality can be accessed using the Devices tile inside the Admin section of the portal.

Devices_tile.jpg

Device management tile

Clicking the Devices tile will open the Device List panel, the starting point for the Device Management.

The Device List panel allows the user to add new devices in the system, using the Add button available in the top menu, next to the Refresh button.

Capture101.jpg

The Device List toolbar options

The available devices are displayed in the panel's central area, as cards in a scroll-able list. Each device card displays the following details:

  • The Device icon

  • The Device name or alias

  • The Device type

  • The Device flags, concerning visibility and status:

    • Not_Visible_in_front_end.jpg - Not visible in front-end

    • Visible_in_front-end.jpg - Visible in front-end

    • Active.jpg - Status Active

    • Not_Active.jpg - Status Inactive

Device_card.jpg

Device card

Clicking on a listed device card the View Device panel is opened.

The Device List Filter

The Devices List panel allow the user with possibility to search for Devices and to apply a set of advanced filters.

By typing in Name or the Alias of a Device, the list is automatically filtered to display only the relevant results.

The_Device_Filter.jpg

The Device Filter area

To reset the search field, the user can click on the X button. Automatically, the search field contents are cleared and the Devices list is updated to display all the Devices.

Reset_search_field.jpg

Reset search contents

By clicking the Open filter button, the Object filters panel is opened. In this view, the user is provided with the following filter options:

  • Filter by Organizational Units

  • Filter by Sites

  • Filter by Areas

  • Filter by Devices

Applying the filters, will reduce the list of devices to those items that correspond to the advanced search.

Adding Devices

The Add button from the top menu of the Device List panel allows the user to add new devices to the Device List. Clicking the Add button opens the Select Device Type panel, allowing the user to chose which device type to create.

Selet_Device_Type_panel.jpg

The Select Device Type panel

Selecting a device type opens the Add Device panel, where the user can input the device settings.

Add_Device_panel.jpg

The Add Device panel

The device settings to be provided are split in two categories:

Default device settings (available for any device type)
  • Device information

    Device_information.jpg
    • Name - The technical name of the device. This field will be mandatory regardless of the selected Device type.

    • Alias - The friendly name of the device. The Device Alias will be displayed in the device card, when listed.

    • Description - The description of the device.

  • Device flags

    Device_flags.jpg
    • Visible in front-end - If enabled, the device will be listed in the i4connected portal.

    • Active - If enabled, the device will be active.

  • Device properties

    Device_properties.jpg
    • Device type - The device sub-type that can be defined by the user. The user can add/edit sub-types using the right-side buttons corresponding to the current field.

    • Manufacturer - The manufacturer of the device.

    • Model - The model of the device.

    • Hardware version - The hardware version of the device.

    • Software version - The software version of the device.

    • Site - The Site where the device is installed.

    • Area - The Area where the device is installed.

    • Organizational Unit - The Organizational Unit to which the device belongs.

  • Photos

    Photyo_properties.jpg
    • Photo - The photo of the device itself.

    • Installation photo - The overview photo of the device installation location.

Type dependent settings

The following device types require additional settings besides the standard ones listed above. These additional settings are usually focused under the Adapter category.

Note

For more details regarding each Adapter type and their specific settings, please also visit the Adapters configuration article.

  • Azure IoT

    • IoT Hub settings

      • IoT Hub name - The name of the i4connected IoT Hub. It is mandatory to provide data for this field.

      • Filter - The filters which parse the data received from the IoT Hub

      • Device Id - The identification number of the device.

    • Direct method of device

      • Method Name - The name of the method which should be called.

      • Method Payload - The JSON payload method.

      • Method response Timeout in Seconds - The timeout, expressed in seconds, for waiting for a response from the method (min: 0 / max: 300, default: 120)

      • Method Connection Timeout in Seconds - The timeout, expressed in seconds, for waiting the IoT device connection (min: 0, default: 0, cannot be more than the Method Response Timeout in Seconds.

  • HMSHub

    • HMSHub settings

      • HMSHub Adapter - the name of the HMSHub server providing the data. To configure and HMSHub Device, filling in the field is a mandatory condition.

  • CSV / Text

    • CSV settings

      • CSV source - The name of the CSV server providing the data. Filling in this field is mandatory.

  • i4SCADA

    • i4SCADA settings

      • i4SCADA Adapter - The name of the i4SCADA server providing the data. To configure an i4SCADA Device, filling in the field is a mandatory condition.

  • Modbus

    • Modbus setings (both Modbus specific settings are required)

      • Modbus server address - The address of the Modbus server driving the device

      • Unit ID - The identification number of the Modbus unit. The field will only accept a number between 0 to 255.

  • MQTT

    • MQTT settings

      • MQTT name - The name of the MQTT Broker (Server) to which the device will be connected.

      • Topic - The device topic. This topic is a string that acts like a filter when used in combination with the signals topics.

      • Filter - The JSON filter obtaining the relevant data.

  • MSCONS

    • MSCONS settings

      • Source - The MSCONS source (server) providing the data. It is required to fill in this field in order to be able to save a new MSCONS device.

  • SQL

    • SQL Settings

      • SQL query name - The query applied to the database, retrieving the relevant information This field is required.

  • WEBfactory

    • WEBfactory settings

      • WEbfactory server address - The address of the WEBfactory server driving the device. Filling in this field is mandatory, in order to be able to save a WEBfactory device.

The Manual counters, OPC-DA and Lertes Devices only require the standard information to be added in the system. These types of devices do not require an adapter in order to manage their data.

Once the device information are provided, click the Save button to add the device to the Device List.

Device Details

The Device details panel is opened by clicking a device card inside the Device List or by adding a new device. This panel displays all the available information about a device and allows the user to perform device-related operations.

Capture98.jpg

The Device Details panel

The top menu buttons provides access to the Edit Device panel (where the user is able to edit the device's settings) and to the Delete panel (where the user can delete the device).

The main body of the Device Details panel lists the following data:

  • Device information - the name, type and other relevant device information;

  • Installation information - the site, area and organizational unit where the device is installed;

  • Device settings - the device type specific settings configured when the device was created/edited.

Capture2033.jpg

The Device details panel also provides access to the device's signals and alarms, through the dedicated tiles. This tiles display the number of signals and alarms of the current device. Clicking the Signals tile opens the Signal List panel, allowing the user to manage the device's signals. Check out the Signals Management article for more information. Clicking the Alarms tile opens the Event scripts list panel, allowing the user to manage the device's alarms. Check out the Event script list article for more information.

Capture100.jpg

The Device Signals and Alarms tiles

Editing Devices

Clicking the Edit button from the View Device top menu opens the Edit Device panel.

Capture105.jpg

The Edit Device panel

This panel allows the user to edit both the standard device information as well as the type dependent information.

Deleting devices

In order to delete a device, the user can click the Delete toolbar button, available in the top toolbar of the Device Details panel. By clicking the Delete button will open the Delete device panel.

Delete_device.jpg

The Delete Device panel

To proceed with device deletion, the user should pay attention to the consequences involved by this operation (the amount of deleted measurements, event occurrences, events and signals).

A confirmation code is requested in this view. In case the typed deletion code is incorrect, the system will warn the user and prevent the deletion operation.

Values_must_be_equal.jpg

The Deletion code needs to correspond with the provided one

After manually typing the correct deletion code and pressing the Delete button, the device is permanently removed.