Info |
---|
For SmartServer 3.4 and 3.5, see Defining Device Types (Release 3.4 and 3.5). For SmartServer 3.3 and prior, see Defining Device Types (Release 3.3 and Prior). |
...
Table of Contents | ||
---|---|---|
|
The Device Types widget provides the ability to create, view, and edit device types. Device type definition (DTD) files are CSV files that list the device type names, program identifier (ID), application image names, and graphics assets to be used as icons for specified device types. These file use a .dtd extension.
You first have to import any XIF files (see Collecting or Creating Device Definitions), resource files, application image files, system image files, and graphics files that you plan to use. When an XIF file that does not already have an associated device type defined is imported, a default device type will be created with the device type name equal to the XIF file name, the protocol and program ID set from the XIF file, and the graphics file set to a default device icon.
Once imported, you will be able to create new device types in the Device Types widget, and since the referenced files are already available in the database, you will only have to type a device type name (all the other entries will be selections from pull-down lists).
You can create a device type package (DTP) file that is an archive file that contains assets, resources, and definitions for defining new device types using the Export feature on the Device Types widget.
Users with Administrator, Owner, Controller, or Tenant roles can use this widget to create, modify, and delete device types datapoints within the geozones where they have the Administrator, Owner, Controller, or Tenant roles.
Creating a Graphics File
You can specify a graphics file to customize the image displayed for a device type. You can supply the graphics file as a .JPG or .PNG. file. Files with a .JPG extension are interpreted as JPEG files, as defined by ISO/IEC 10918-1. Files with a .PNG extension are interpreted as Portable Network Graphics files, as defined by ISO/IEC 15948.
...
- Open the SmartServer IoT CMS and go to the Device Types widget. Click the Expand button ( ).
- Click the Create Device button ().
- Enter the device type parameters as appropriate, including:
- Device Type – a unique name for the device type
- Protocol – the communications protocol (BACnet, IAP, LON, Modbus, EnOcean, LoRaWAN EnOcean for local EnOcean interface, LON, LoRaWAN, Modbus, iotc for remote EnOcean interface)
XIF File – provides the ability to upload an XIF file plus a list of all available XIF files with the selected protocol in the SmartServer CMS database
Program ID – ID – read-only field with the program ID of the selected XIF file
Default Application Image – provides the ability to upload an application image file plus a list of all available application image files with the selected protocol in the SmartServer CMS database. (For SmartServer IoT 2.5, this option is only available for LON devices.)
Automatic Application Image Load – indicates if the default application image must be loaded upon initial provisioning a device of the specified type. The default value is cleared. It is cleared and grayed out if a Default Application Image is not selected
Default System Image – provides the ability to upload a system image file plus a list of all available system image files with the selected protocol in the database. (For SmartServer IoT 2.5, this option is only available for LON devices.)
Automatic System Image Load – indicates if the default system image must be loaded upon initial provisioning a device of the specified type. The default value is cleared. It is cleared and grayed out if a Default System Image is not selected.
Graphics File – provides the ability to upload a graphics file plus a list of all available graphics files in the SmartServer CMS database
Create Device Type settings
Create Device Type settings – LON example
Create Device Type settings - Select a graphic file optionssettings – EnOcean example Click SAVE to create the new device type.
...
A DTD file contains the following columns (headings and values are not case sensitive):
Parameter | Description |
---|---|
Device Type | Unique name for the device type. This is the name that will be shown to the user when defining the device in the CMS. (required parameter) |
Protocol | Communications protocol, e.g., LON, Modbus, BACnet, EnOcean for local EnOcean interface, LON, LoRaWAN. , Modbus, iotc for remote EnOcean interface (required parameter) |
Program ID | Unique program ID used to find the XIF file. Upon import, if the program ID exists because of a previously imported XIF, the automatically created type is deleted. (required parameter) |
Default App | Filename for the default application image file. (optional parameter; does not apply to Modbus) |
Default Sys | Filename for the default system image file. (optional parameter; does not apply to Modbus) |
Auto App Load | Boolean indicating if the Default_App must be loaded upon initial provisioning a device of the specified type. Default value is false. (optional parameter; does not apply to Modbus) |
Auto Sys Load | Boolean indicating if the Default_Sys must be loaded upon initial provisioning a device of the specified type. Default value is false. (optional parameter; does not apply to Modbus) |
Graphics File | Name of the graphics file for the device type icon. (optional parameter) |
...
To import a device type, perform the following steps:
- If you are importing LoRaWAN or remote EnOcean interface device types for SmartServer Pi 4.3, then first perform the steps found in (Optional) Importing LoRaWAN and Remote EnOcean Device Types (Release 4.3)
- Open the SmartServer IoT CMS.
- Click the Import / Export button () on the CMS dashboard.
The Import / Export dialog appears. - Select the device types file to be imported and place it in the Drop Files to Import or Browse box.
- Click IMPORT.
Notification messages (similar to the one shown below) will appear indicating that device types are being uploaded and the CPU usage on the main CMS page will show increased activity. - When the device types file has finished loading, click CANCEL to close the Import / Export dialog.
Exporting a Device Type
You can export your device type definitions to a device type definition (DTD) file from the Device Types widget. You can use this capability to export a set of device type definitions to any number of new SmartServers in a single operation per SmartServer.
...