i4connected Knowledgebase 5.6

Adding Devices

Abstract

Check out this article and learn how to add new devices and everything that you need to know about the device type dependendent settings.

In order to be allowed to create new devices, the user must have the Manage devices permission enabled.

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.

Add_device_panel_and_button.jpg

The Select Device Type panel

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

New_device.jpg

The Add Device panel

The device settings are split up in two categories:

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

    Device_info.jpg
    • Name - The unique 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

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

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

  • Custom parameters

    Important

    If no Custom field definitions were specified for Devices, the Custom parameters area will be hidden from the Add / Edit device panel.

    As soon as at least one Custom field definition is available, the Custom parameters area allows the user to fill in Device's metadata, as described below.

    For more details upon the Custom field definitions validation rules, please also visit the dedicated article here.

    • Text metadata - expects a textual metadata, with the scope to provide additional information about the user. When setting the textual metadata, the introduced value will be validated against the rules specified at level of the Text Custom field definition.

      Text_param.jpg
    • Email metadata - expects a valid email address. When setting the email metadata, the introduced value will be validated against the rules specified at level of the Email Custom field definition.

      Custom_para_email.jpg
    • Integer metadata - expects an integer value. When setting the integer metadata, the introduced value will be validated against the rules specified at level of the Integer Custom field definition.

      Custom_param_integer.jpg
    • Decimal metadata - expects a decimal value. When setting the decimal metadata, the introduced value will be validated against the rules specified at level of the Decimal Custom field definition.

      Custom_param_decimal.jpg
    • Date metadata - expects a date metadata, that can be selected using the Calendar pop-up. When setting the date metadata, the introduced value will be validated against the rules specified at level of the Date Custom field definition.

      Date.jpg
    • Time metadata - expects a time metadata, that can be selected using the Clock pop-up. When setting the time metadata, the introduced value will be validated against the rules specified at level of the Time Custom field definition.

      Time.jpg
    • DateTime metadata - expects a date and time metadata, that can be selected using the Calendar pop-up. When setting the DateTime metadata, the introduced value will be validated against the rules specified at level of the DateTime Custom field definition.

      DateTime.jpg
    • Url metadata - expects an URL. When setting the DateTime metadata, the introduced value will be validated against the rules specified at level of the DateTime Custom field definition.

      Url_Param.jpg
    • Enumeration metadata - expects the selection of one of the values defined by the Custom field definition. Selection can be done using the drop-down list. When setting the Enumeration metadata, the introduced value will be validated against the rules specified at level of the Enumeration Custom field definition.

      Custom_param_enumeratiohn.jpg
    • Boolean metadata - expects the selection of one of the Yes / No values. Selection can be done using the toggle button. When setting the Boolean metadata, the introduced value will be validated against the rules specified at level of the Boolean Custom field definition.

      Boolean.jpg
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.

  • CSV / Text

    • CSV settings

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

  • The Email device, governing Email handling, features the following settings:

    • Email settings

      • Email Adapter - sets the name of the Email adapter providing the configuration for accessing the Email server. This field is mandatory.

      • Sender Name Pattern - the name pattern of the Email sender (source), used to filter the Emails corresponding to the device.

      • Sender Address Pattern - the address pattern of the Email sender (source address), used to filter the Emails corresponding to the device.

      • Recipient Name Pattern - the name pattern of the Email recipient (target), used to filter the Emails corresponding to the device.

      • Recipient Address Pattern - the address pattern of the Email recipient (target address), used to filter the Emails corresponding to the device.

      • Subject Pattern - the pattern of the Email subject, used to filter the Emails corresponding to the device. The Subject Pattern field can match strings with wildcards (*), where the wildcard means "any".

      • Body Pattern - the pattern of the Email body, used to filter the Emails corresponding to the device. The Body Pattern field can match strings with wildcards (*), where the wildcard means "any".

      • Script - the name of the Email Alarm Script used to process Email data. The user can either define a custom script or use the ones provided by default: Carel, Carel2, Danfoss, Dixell, Dixell2, Eliwell and Wurm.

        Tip

        For more details about Email script, please visit the dedicated section, here.

    Important

    All the above Email pattern fields can match strings with wildcards (*), where the wildcard means "any".

  • Ewon

    • Ewon settings

      • Ewon Adapter - the name of the Ewon server providing the data. This field is mandatory.

      • Ewon name - the name of new Ewon device associated with the Ewon server.

      • Time zone - the time zone of the Ewon device. This setting will only be used if the Ewon device is not set to use the UTC time zone, in order to convert the received timestamps to UTC. Otherwise, the adapter will store directly the received timestamps, as they are already in UTC. This setting is required.

      • Ewon username - specifies the username of the Ewon device.

      • Ewon password - specifies the password of the Ewon device.

      Note

      The Ewon username and password fields should only be filled in, when signal writing is also needed.

  • GridVis

    • GridVis settings

      • GridVis server name - the name of the GridVis Adapter (GridVis project) providing the data. This field is mandatory.

      • GridVis device - the name of the GridVis device. This field is mandatory.

  • 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.

  • 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.

  • Netbiter

    • Netbiter settings

      • Netbiter Adapter - the name of the Netbiter server providing the data. This field is mandatory.

      • Netbiter name - the name of new Netbiter device associated with the Netbiter server.

  • 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.