Getting Started with Implementing New Features in Device Software

NI InsightCM™ SDK 3.3 Help

Edition Date: December 2018

Part Number: 375191F-01

»View Product Info
Download Help (Windows Only)

Before You Begin: Ensure you have completed the process to successfully run the SDK source code prior to make any changes to the code: Getting Started with Running the SDK Source Code on a Device

After your device is successfully connected and authorized, you can begin to extend its functionality. The NI InsightCM SDK provides you with tools for customizing many components of devices and NI InsightCM Server, and the process you follow to accomplish a particular goal can differ significantly from the process for another goal. This document outlines a general process for accomplishing many goals related to customizing how a type of device operates.

  1. Make new components, such as devices types, channel types or properties, and features/spectral bands, accessible in the InsightCM web application by creating or updating the appropriate type of definition.
  2. Add or update LabVIEW source code for the device application.
  3. Build the source code into an application.

Create or Update the Definitions of Components

When you develop device software to run on NI real-time targets, you might determine that you must present end users with new options or user interface elements in the InsightCM web application. For example, you might need to allow users to configure a device with a new type of C Series module or to set a property that influences how the device operates. To customize the InsightCM web application to display desired user interface components, create a new definition for that component or update an existing definition.

  1. Determine the type of component you need to define. For a list of the modifications to the InsightCM web application you can perform, refer to Customizable Features of the InsightCM Web Application.
  2. Defining some types of components requires more work than is required for others. For example, adding one new property field for configuring a particular channel type requires much less work than defining an entirely new device type. The process for completing your desired task also differs according to your goal:
    • To create a new definition for a particular type of component, first export an NI-developed version of the same component type and assign it a new name. For example, to create a new channel type, export an NI-developed channel type definition that the InsightCM web application already supports.
    • To edit an existing NI-developed component, first export the definition for that component. For example, if you are adding a new user-configurable property in the InsightCM web application for Accelerometer channels, export the Accelerometer (923x) definition.

    Refer to Accessing a Device, Feature, or Unit Definition to Use as a Template for instructions for completing these tasks.
  3. Define the component according to the required format of that definition. Each type of component has a different format. To access specifications for each component type's format, browse to Introduction to Device Type Definitions and locate the type of component you want to define.
  4. Import the component you defined or updated to NI InsightCM Server.

Add to or Update the Device Software

After you have defined new features for InsightCM web application users to configure, update the device software to act on the data.

Building and Deploying the Device Application

When you are ready to build and deploy the application from the LabVIEW source files, complete the following steps:

  1. Create a build specification for a real-time application by right-clicking the Build Specifications node under the real-time target in the project tree.
  2. Use the NI Replication and Deployment (RAD) utility to create an application image from the real-time application. RAD is available for download from
  3. In the InsightCM web application, expand the Navigation menu and select Utilities»Package Management.
  4. Click the Upload button and browse to the application image you created.
  5. When the Upload Packages dialog box reports the upload is complete, click Close.
  6. Browse to the Devices page»Software tab. Select the device, and then click the Update Application button.
  7. Select the application version you uploaded, and then click OK.

Related Information

Getting Started with Running the SDK Source Code on a Device


Not Helpful