Link Search Menu Expand Document

Device Options

Dec 6 2023 at 12:00 AM

  1. Introduction
  2. Example Options File
    1. Device Configuration Definitions

Introduction

The Device Options section delves into the crucial details of setting up a Generic Driver interface service. This segment provides comprehensive insights into configuring and optimizing the interface service for the Generic Driver, ensuring a streamlined and effective setup.

NOTE
Generic Drivers do not rely on default property devices. Instead, each device is required to define its unique property mappings within its configured filters, adhering to the specifications set by the respective filter.

Example Options File

{
  "Devices": {
    "Device1": {
      "Enabled": true,
      "DeviceType": "Generic",
      "Debug": true,
      "ActionDelay": 30000,
      "DataSource": {
         {selected data source options}
      },
      "Filters": [
         {selected filter options}
      ]
    }
  }
}

Device Configuration Definitions


Here is an overview of the properties for device configuration:

Property NameDescription
DeviceTypeSpecifies the type of device, and for this device, the value is set to “Generic”.
EnabledIndicates whether this device is enabled. If set to false, the device will not be executed. Defaults to false.
GatewayIdIdentifies the gateway associated with the device. If left blank, the Gateway ID of the Collector Service will be used.
GroupNameRefers to the group name assigned to the device.
ActionDelayDenotes the time delay, in milliseconds, between each execution. It is recommended to set this to 0.
DebugDetermines whether debug information is written to the log file. Defaults to false.
DataSourcePertains to the options available for the selected data source.
FiltersEncompasses the options for one or more selected filters.