Customizing the Behavior of NI-Developed Processes

NI InsightCM™ SDK 3.3 Help

Edition Date: December 2018

Part Number: 375191F-01

»View Product Info
Download Help (Windows Only)

Parent Topic: Overview: Developing Software for Devices in an NI InsightCM System

Several NI-developed processes that run in device software rely on global properties to control certain behaviors. These properties, set in software configurations, customize behaviors that you do not need users to configure on a per-device basis. This property is set in the following example of a software configuration definition.

[

{

"Section": "TagPublisher": {

"KeyValues": {

"OnDemandInterval": "60",

}

}

]

Changing the Default Values for NI-Developed Properties

The following list describes the properties and their default values that NI-developed software configurations set for NI-developed processes:

Controller

  • DisableDeviceRTProtocol (Default: false)—Whether to disable LabVIEW project access so you cannot add or connect to the device in the LabVIEW project that contains Main.vi and dependent source code.
  • DisableDeviceUSBConfiguration (Default: false)—Whether to disable the ability of the device to read or write network connection information from a USB drive. If you disable this property, you must instead transfer connection information across the network.
  • DisableDeviceWebService (Default: false)—Whether to disable the port NI InsightCM Server uses to communicate with the device web service. Setting this property to True disables certain operations that rely on this form of communication. For example, NI InsightCM Server requires this web service to transfer connection information files across the network to devices. In this case, you must instead manually transfer the connection information file via USB drive.
  • SafeModeAllowedReboots (Default: 60)—The maximum number of times the device can reboot during the time period specified by SafeModeLookbackMinutes.
  • SafeModeLookbackMinutes (Default: 10)—The time period during which a reboot remains in the reboot count that the device evaluates to determine whether the SafeModeAllowedReboots is exceeded.

Data Accumulator

  • MaxBlockSeconds (Default: 20)—The greatest amount of data, in seconds, that an acquisition block can contain before this process ends the block.
  • MinBlockSeconds (Default: 1)—The smallest amount of data, in seconds, that an acquisition block can contain. This process continues accumulating data in a block until it reaches MinBlockSeconds even if the configured acquisition block length was reached.
  • DefaultDataBlockLength (Default: 4)—The amount of data, in revolutions or seconds according to the device configuration set in the InsightCM web application, to accumulate in each block. This process uses this property only if the device configuration sets the Acquisition Block Length to 0.

Device Health

UpdateInterval (Default: 30)—The period, in seconds, at which this process updates health-related tags.

File Manager

  • ManageDriveIntervalMinutes (Default: 1)—The interval in minutes at which this process evaluates whether the device has sufficient free disk space, as specified by the MinDriveFreeSpace property.
  • MaxTdmsFilesInMemory (Default: 15)—The number of in-memory data sets this process handles simultaneously. If this process receives a SendTdmsInMemory message with a new in-memory data set when it has already reached the MaxTdmsFilesInMemory value, this process writes the incoming in-memory data set to disk to be transferred to the server later and then removes the original data set from memory.
  • MinDriveFreeSpace (Default: 30)—The minimum percentage of disk space to keep free. If the percentage of free disk space falls below this value, this process deletes the oldest data sets until sufficient disk space is free.

FPGA Acquisition

SettlingTimeSeconds (Default: 30)—The number of seconds to wait after start-up before retaining data to pass to the first process in the Dataflow Script. This allows time for the AC coupling filter to settle.

Server Comm

  • ReconnectIntervalSeconds (Default: 30)—The amount of time, in seconds, the device waits to reconnect to NI InsightCM Server after a connection attempt fails due to certain conditions, such as a missed ping.
    Note  
    • After the number of attempts specified by the MaxAttempt property, the device stops waiting for the duration this property specifies and instead waits five minutes before trying to reconnect.
    • Some conditions that cause failed connections, such as firmware or configuration mismatches between the device and the server, always cause the device to wait five minutes before reconnecting. In other words, this property does not apply when these conditions cause a connection failure.
  • MaxAttempts (Default: -1)—The maximum number of attempts the device makes to connect to NI InsightCM Server before increasing the interval between reconnect attempts.
  • PacketSizeKbytes (Default: 16)—The size, in KB, of the network packets in which the device transfers data to the server.
  • InterPacketDelay (Default: 0)—The amount of time, in seconds, the device waits between sending packets of data to the server.

Data Event Creator

  • FileMemoryTransferMode (Default: True)—If True, the device transfers data sets to the server directly from memory rather than writing the data sets to disk before transferring them. Transferring data sets from memory helps extend the lifespan of the device by avoiding read and write operations to the hard drive.
  • TdmsMemoryBlockSize (Default: 8388608)—The size, in bytes, of the chunks into which the device divides in-memory data sets from periodic acquisitions before sending them to the server.
  • TdmsMemoryStreamBlockSize (Default: 1048576)—The size, in bytes, of the chunks into which the device divides in-memory data sets from stream acquisitions before sending them to the server.

Modifying or Creating a Software Configuration

To modify properties for an NI-developed process, you can export the device definition, change a property value, and then reimport the device definition. The top-level device type definition contains software configuration definitions. Otherwise, you can create a new software configuration within the device type definition and remove NI-developed software configurations.

Related Information

Getting Software Configuration Properties

Software Configurations

WAS THIS ARTICLE HELPFUL?

Not Helpful