NI InsightCM™ SDK 2.0 Readme

November 2015


This file contains important information about the NI InsightCM™ SDK software, including system requirements, installation instructions, and known issues.


Overview

NI Application Software Support

System Requirements

Installation Instructions

Product Security and Critical Updates

Known Issues

Accessing the Help

Finding Examples

Legal Information


Overview

The NI InsightCM SDK consists of the following components:


  • SDK components:
    ComponentWhere to Find
    Reference code for device software that runs on NI real-time targets <InstallDir>:\Program Files (x86)\National Instruments\LabVIEW 2015\InsightCM\Devices\cRIO\Base
    LabVIEW APIs for customizing the device softwareIn LabVIEW on the Functions»Add-ons palette.
    Reference device definitions for NI-developed device types, including the CompactRIO-based CMS-9068, CMS-9065, and CMS-9036 systems. <InstallDir>:\Program Files (x86)\National Instruments\LabVIEW 2015\examples\InsightCM\MessageService
    A LabVIEW API for developing a service to communicate with services running in NI InsightCM ServerOn the Functions»Add-ons»InsightCM»Message Service palette.
    An example of a C#-based service <InstallDir>:\Program Files (x86)\National Instruments\LabVIEW 2015\examples\InsightCM\ExampleServiceApp
    An example of a LabVIEW-based service <InstallDir>:\Program Files (x86)\National Instruments\LabVIEW 2015\examples\InsightCM\MessageService
    Examples of LabVIEW code that integrates with NI InsightCM Server to calculate custom features from waveform data <InstallDir>:\Program Files (x86)\National Instruments\LabVIEW 2015\examples\InsightCM\AnalysisMean
  • A license for NI InsightCM Server for testing purposes
  • A license for NI InsightCM Data Explorer for testing purposes

NI Application Software Support

The following table lists the NI application software versions, including service packs, supported by the NI InsightCM SDK.


NI Application SoftwareVersions Supported by the NI InsightCM SDK
NI InsightCM Data Explorer 2.0
NI InsightCM Server 2.0

System Requirements

The following sections describe the hardware and software requirements for the components of the SDK.


Host/Development Computer

The computer on which you install and develop with the NI InsightCM SDK has different software requirements for developing with LabVIEW based on what task you want to perform. The following table lists the software requirements for the most common tasks in the InsightCM SDK.


Note  All National Instruments Software in the following list is included on the INSIGHTCM SDK SUPPORT USB.
Task Requirements
Create new device
  • LabVIEW 2015 (32-bit)
  • LabVIEW 2015 Real-Time Module
  • LabVIEW FPGA
  • NI Sound and Vibration Measurement Suite 2015
  • NI Compact RIO Device Drivers August 2015
Create new server side analysis LabVIEW 2015 (32-bit)
Create new LabVIEW-based service LabVIEW 2015 (32-bit)
Create new C#-based service Visual Studio 2013
Note  To develop a C#-based service with the NI InsightCM SDK you need to install only a C# compiler.
Create a new Motor Monitoring Systems (MMS) device
  • LabVIEW 2015 (32-bit)
  • LabVIEW 2015 Real-Time Module
  • LabVIEW 2015 FPGA Module
  • NI Compact RIO Device Drivers August 2015
  • LabVIEW 2015 Electrical Power Suite

NI Real-Time Targets

To run software developed with the NI InsightCM SDK on a CompactRIO, you must first download various supporting software components to the target. Use the LabVIEW-Real-Time Software Wizard in NI Measurement & Automation Explorer to download software to a target. For more information on how to install software onto a remote system, refer to Installing a Custom Software Selection in the Measurement & Automation Explorer Help.


Targets must have the following software installed:


  • (VxWorks) HTTP Client with SSL Support 15.0.0
  • (NI Linux Real-Time) HTTP Client with SSL Support 15.0.0
  • LabVIEW Real-Time 15.0.0
    • (VxWorks) Language Support for LabVIEW RT 1.0.0.7
  • NI Application Web Server 15.0.0
  • NI cRIO Module Detection 1.0
  • NI InsightCM Model Number Bitfiles 2.0
  • NI InsightCM SDK 1.0.1
  • NI Scan Engine 4.4
  • NI Sound and Vibration 15.0
  • NI System Configuration 15.0.0
  • NI System Configuration Remote Support 15.0.0
  • NI Web-based Configuration and Monitoring 15.0.0
    • Hardware Configuration Web Support 15.0.0
    • Network Configuration Web Support 15.0.0
    • Software Management Web Support 15.0.0
    • Time Configuration Web Support 15.0.0
  • NI Compact RIO Device Drivers August 2015
    • CompactRIO Support 15.0
  • NI-RIO IO Scan 15.0
  • NI-Watchdog 15.0.0
  • Remote Panel Server for LabVIEW RT 15.0.0
  • Run-Time Engine for Web Services 15.0.0
  • (NI Linux Real-Time) SSL Support for LabVIEW RT 15.0.0
  • WebDAV Server 15.0.0

Installation Instructions

Complete the following steps to install the NI InsightCM SDK software:


Note  Visit ni.com/info and enter the Info Code USBGuideSpec for the USB flash drive user guide and specifications.
  1. Insert the NI InsightCM SDK installation USB.
  2. Run setup.exe.
  3. Follow the installer prompts, enter any required information, and activate when prompted, if necessary.

Product Security and Critical Updates

Visit ni.com/security to view and subscribe to receive security notifications about National Instruments products. Visit ni.com/critical-updates for information about critical updates from National Instruments.


Known Issues

You can access the software and documentation known issues list online. Refer to the National Instruments website for an up-to-date list of known issues in NI InsightCM Server.


Getting Started and Accessing the Help

You can access the NI InsightCM SDK help in LabVIEW by selecting Help»LabVIEW Help and navigating to the NI InsightCM SDK Help topic.


Finding Examples

LabVIEW examples for the NI InsightCM SDK are located in the labview\examples\InsightCM directory. You can modify an example VI to fit an application, or you can copy and paste from one or more examples into a VI that you create.



Legal Information

Copyright


© 2015 National Instruments. All rights reserved.


Under the copyright laws, this publication may not be reproduced or transmitted in any form, electronic or mechanical, including photocopying, recording, storing in an information retrieval system, or translating, in whole or in part, without the prior written consent of National Instruments Corporation.


National Instruments respects the intellectual property of others, and we ask our users to do the same. NI software is protected by copyright and other intellectual property laws. Where NI software may be used to reproduce software or other materials belonging to others, you may use NI software only to reproduce materials that you may reproduce in accordance with the terms of any applicable license or other legal restriction.


End-User License Agreements and Third-Party Legal Notices


You can find end-user license agreements (EULAs) and third-party legal notices in the following locations after installation:


  • Notices are located in the <National Instruments>\_Legal Information and <National Instruments> directories.
  • EULAs are located in the <National Instruments>\Shared\MDF\Legal\license directory.
  • Review <National Instruments>\_Legal Information.txt for information on including legal information in installers built with NI products.

U.S. Government Restricted Rights


If you are an agency, department, or other entity of the United States Government ("Government"), the use, duplication, reproduction, release, modification, disclosure or transfer of the technical data included in this manual is governed by the Restricted Rights provisions under Federal Acquisition Regulation 52.227-14 for civilian agencies and Defense Federal Acquisition Regulation Supplement Section 252.227-7014 and 252.227-7015 for military agencies.


IVI Foundation Copyright Notice


Content from the IVI specifications reproduced with permission from the IVI Foundation.


The IVI Foundation and its member companies make no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The IVI Foundation and its member companies shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material.


Trademarks


Refer to the NI Trademarks and Logo Guidelines at ni.com/trademarks for information on National Instruments trademarks. Other product and company names mentioned herein are trademarks or trade names of their respective companies.


Patents


For patents covering the National Instruments products/technology, refer to the appropriate location: Help»Patents in your software, the patents.txt file on your media, or the National Instruments Patent Notice at ni.com/patents.


375582A-01