NI InsightCM Desktop Simulated Device

Updated Apr 26, 2021

Reported In


  • NI InsightCM

Issue Details

How can I use LabVIEW SDK Source Code to Simulate CMS-9068 device on Windows Machine?
I'm currently trying InsightCM and its SDK and I wanted to simulate a device to better understand the communication between LabVIEW and InsightCM.


After installing NI InsightCM SDK 3.1+, sourcecode is located in the path below.
C:\Program Files (x86)\National Instruments\LabVIEW 2017\InsightCM\Devices\Cms\CMS_Desktop.lvproj

This device shares code with other devices. Be sure to not overwrite shared VIs by creating copies and only modifying your copies.

1. Preparing the Device Definition File

 The device definition file, contains all necessary information, which are required to configure the CMS Device from NI InsightCM server application. After configuration of the CMS device the server will send the appropriate json files to the device. Please check the NI InsightCM SDK help for further details regarding the device definition file. The device definition file contains also the information regarding the application and firmware image (rt.exe). The Desktop Simulated Code is running within the LV IDE, therefore these parameters are not required.

2. Import Desktop Device Definition File

 A. Export definition file of CMS-9068 with the command prompt. You can change the path in the red box to desired path. Please check the SDK help for further details regarding exporting definition files.

  InsightCMConsole.exe exportdefinition -t device -n "CMS-9068" -o "C:\Temp\CMS-9068.json"

 B. Open exported CMS-9068.json file and remove the SysCfgDeployer capability at the top of the definition file. Don't forget to change the device name so it doesn't override one of the shipping definitions. (Save as "Desktop9068.json")

 C. Import the device definition file with the command prompt. Please check the SDK help for further details regarding importing definition files 

 InsightCMConsole.exe importdefinition -t device -f "C:\Temp\Desktop9068.json"

3. NI InsightCM Server - Create Offline Device
 A. Open a web page to the NI InsightCM web application and navigate to the Device page (Refresh the page if you were already there)

 B. Click Add. Select Create an offline device, click Next

 C. Select Desktop CMS-9068 from the Device Type drop down list. See image below.

 D. Click Next until you can enter a name for the device, then click Finish. When prompted if you want to export the device connection information file, click Yes.
 E. A Connection Info will be exported. This file will be used by the simulated device to connect to the server.

4. Import the connection file to the Windows target

 A. Copy downloaded .json file to the following path on the Windows machine you installed the desktop device on.
  <User>\Documents\LabVIEW Data\InsightCM\conn

 B. Rename the file you copied into the directory to ConnectionInfo.json. If existing - delete the old ConnectionInfo.json file in this directory. Check image below.
5. Run the LV Code

 A. Press the Run button to execute the LV Code
 B. Check Connection Status on NI InsightCM Server like the image below.

6. Using the Simulated Device and Recommendations Settings

 A. Configure the Asset which you would like to monitor with the simulated device.
  • Add Assets
    • Configuration (spanner icon) » Assets » Add » equipment (below Template » Turbine is used) » Add Child Assests of Sensor » 2x Accelerometer, Tachometer and Thermocouple
  • Data Collection
    • Data is collected based on your Data Set Collection Settings (under Configuration (spanner icon) » Assets » Operating States
    • The below example has a data Set collected every hour, and collects a stream of data sets during Run-Up, which is true when the Tachometer Speed rises above 500 RPM. You can use the tachometer dial in the LabVIEW Front Panel to simulate this.
 B. Configure the Device with following Data Group and Channels. Final configuration should look similar to the image below.
  • Channels
    • Navigate to Channels Tab » Add » Hold down shift and select Mod1/Ch0, Mod2/Ch1, Mod2/Ch2, Mod8/Ch0 » OK
    • Navigate to Equipment Mapping » Highlight the channel on the left and the asset on the right to map
      • Mod1/Ch0 - Tachometer
      • Mod2/Ch1 - Accelerometer (Default)
      • Mod2/Ch2 - Accelerometer (Default)
      • Mod8/Ch0 - Thermocouple
  • Data Group:
    • Add/Remove » Add » Highlight Equipment and Select » OK
    • Add all channels to your new Data Group
  • Select Validate and correct any issues.

 C. Update the Device Configuration
  • Select Back to Devices or click Configuration (spanner icon) » Devices
  • Select your device and click Update Configuration (Ensure is running)

D. Use the Simulated Device
  • If needed restart the
  • Now the simulated Device is running and you are able to simulate the dynamic (vibration) and static signals on opened Front Panels of the device code. See image below.

7. Customize the Desktop Device

 A. This device shares code with other devices. Be sure to not overwrite shared VIs by creating copies and only modifying your copies.
 B. You can modify the device code as needed and use any Windows supported software and hardware.