Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Device Capability Definitions

NI InsightCM™ SDK Help

Edition Date: July 2017

Part Number: 375191C-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.

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.

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

Related Information

Introduction to Device Type Definitions


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit