Device Capability Definitions

NI InsightCM™ SDK 3.3 Help

Edition Date: December 2018

Part Number: 375191F-01

»View Product Info
Download Help (Windows Only)

Parent Topic: Introduction to Device Type Definitions

Capability definitions specify different groups of behaviors that a given device type supports. Device capability definitions in JSON contain a CapabilityName and a Property.

CapabilityName is an array of objects that enable UI elements that appear in various configuration tabs and dialog boxes. Refer to the following table for a list of CapabilityName values and their descriptions.

Capability Name Description
SysCfgDeployer Enables the given device type to use image deployment tools.
SoftwareTemplate Controls whether device configurations can be saved or loaded as templates.
DeviceHealth Determines whether the given device supports the Device Health view.
SuppressIepe Specifies that IEPE options are not available on the given device.
NiAuth Enables NiAuth features on the given device.
TestPanel Controls whether the given device supports a test panel.
AlarmEngine Allows the alarm engine to run on the given device.
CustomClientDependencies Specifies classes to be loaded for third party validation rules. Use unique keys, and specify class names for the values.
DisableDeviceAnalysis Prevents analysis from running on the given device.
DataGroups Enables multiple data groups.
OperatingStates Enables multiple operating states per data group.
CalculatedMetrics Specifies which features can be calculated on the given device.
FileCollectionTrigger Enables data collection based on time or feature values.
TagCollectionTrigger Enables tag updates based on time or feature values.
EnterTrigger Enables specification of operating state enter conditions.
ExitTrigger Enables specification of operating state exit conditions.

Properties define which behaviors are enabled for a capability. Refer to the following table for a list of Property names and their descriptions.

Property Name Description Capabilities to Which the Property Applies Data Type
SharedChannels Determines whether different data groups can share channels. DataGroups Bool
CanCreate Determines whether operating states can be created and removed. OperatingStates Bool
CustomUrl Specifies an external test panel resource. TestPanel String
CustomView Specifies a panel to use instead of the default. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger, TestPanel String
Tag Controls whether tags can be configured for the trigger. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger Bool
Cron Controls whether CRON can be configured for the trigger. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger Bool
Timespan Controls whether timespan can be configured for the trigger. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger Bool
TagDoubleOperators Specifies operators for tags with a double data type. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger json string
TagIntOperators Specifies operators for tags with an int data type. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger json string
TagStringOperators Specifies operators for tags with a string data type. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger json string
Dwell Controls whether the dwell numeric control is visible. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger Bool
Expression Controls whether the expression string textbox is visible. If this value is set to false, conditions are OR'd. FileCollectionTrigger, TagCollectionTrigger, EnterTrigger, ExitTrigger Bool
CMSLib Specifies the class name of the custom library to load. CustomClientDependencies String
ApplicationGuid Specifies the unique ID for the device application image. SysCfgDeployer String
BootstrapGuid Determines the ability to reset to factory. SysCfgDeployer String
FirmwareDeployment Controls the Update Firmware item on the Action menu. This property does not influence the Update Application button. SysCfgDeployer String

Related Information

Introduction to Device Type Definitions

WAS THIS ARTICLE HELPFUL?

Not Helpful