Introduction to the KtMDsr IVI-COM-C Instrument Driver
Driver version: 2.1.118.0

Table of Contents

This is revision "A" of this Introduction document.



Introducing the KtMDsr IVI Driver for the Keysight Digital Stimulus/Response module

This instrument driver provides access to the functionality of the Keysight Digital Stimulus/Response module through a COM server or ANSI C API which also complies with the IVI specifications. This driver works in any development environment which supports COM or C programming, including Microsoft Visual C++, Microsoft .NET languages, LabVIEW, LabWindows CVI, MATLAB and others.

For more information on this driver, go to www.keysight.com/find/M9195B.

This Introduction document includes what would have normally been in the ReadMe.txt file. It also includes required IVI 2014 introduction and compliance information.

The driver help file, KtMDsr.chm, can be found in the <Program Files>\IVI Foundation\IVI\Drivers\KtMDsr directory. It contains:

In addition to the .chm file, the driver installs MS Help Viewer driver help (VS2010 or newer) and may optionally install integrated driver help for Visual Studio 2005/2008 (this may increase the install time by several minutes).



Driver Examples and Source Code

Driver example programs (C#, C++, VB.NET, MATLAB) can be found in the folder: <Program Files>\IVI Foundation\IVI\Drivers\KtMDsr\Examples\ For instructions on building examples, refer to the “Examples Readme.txt” file in the Examples folder.

The IVI-COM/C driver source code, if optionally installed, can be found in the folder: <Program Files>\IVI Foundation\IVI\Drivers\KtMDsr\Source\ The source code is a Visual Studio 2010 C++ project and may be updated to newer versions of Visual Studio. To use the rebuilt driver, the driver dll in the build output directory must be registered using the regsvr32.exe utility or by setting the VS project C++ Linker settings to do so. This driver provides the lowest-level API that is a reliable API.



Connecting to the Instrument

The driver help topic, “Driver Examples,” documents program examples for Visual Studio (C#, C++, VB), LabVIEW, and MATLAB. Each of these examples illustrates how to connect to an instrument in the respective development environment.

The IVI resources page (http://ivifoundation.org/resources/default.aspx) has documents and videos that explain how to get started with an IVI-COM driver in different development environments:

Using IVI with Visual C++

Using IVI with Visual C# and Visual Basic .NET

Using IVI with LabVIEW

Using IVI with LabWindows/CVI

Using IVI with MATLAB



Configuring Instrument Settings

The KtMDsr instrument driver application programming interface (API) includes methods and properties for setting instrument state variables, as well as methods for controlling the instrument and reading results from the instrument. These are documented in the KtMDsr IVI-COM Driver > IVI-COM Reference help topic.

There are two driver API hierarchies that client programs may use to control the instrument. The first is the instrument specific hierarchy. This hierarchy can be used to access all of the functionality of the instrument. This hierarchy is available to programs that use one of the driver constructors to instantiate the driver. For more information on using the driver constructors, refer to the information on Direct Driver Instantiation in the KtMDsr IVI-COM Driver > Initializing the IVI-COM Driver help topic. For more information on using the instrument specific hierarchy, refer to the KtMDsr IVI-COM Driver > IVI-COM Reference > Driver Hierarchy > IKtMDsr help topic.

The second hierarchy is the optional IVI Instrument Class compliant hierarchy which supports limited, basic instrument functionality common to most instruments of similar type. To see if this driver supports an IVI Instrument Class, refer to the IVI Compliance Information help topic. If supported, this hierarchy can be used to access the IVI class API for the <ClassName> class. This hierarchy is available to programs that use the IVI-COM class factory to instantiate the driver. For more information on using the class factory, refer to the information on COM Session Factory in the KtMDsr IVI-COM Driver > Initializing the IVI-COM Driver help topic. For more information on using the class compliant hierarchy, refer to the KtMDsr IVI-COM Driver > IVI-COM Reference > Driver Hierarchy > IIvi<ClassName> help topic.



Configuring Driver Settings

IVI instrument drivers implement inherent capabilities including properties that control driver behavior, utility methods, and identifying information. For more information on using the inherent capabilities, refer to the KtMDsr IVI-COM Driver > IVI-COM Reference > Driver Hierarchy > IIviDriver help topic.

Properties that control driver behavior such as simulation, range checking, and instrument status checking can be enabled/disabled when initializing the driver or by using configuration information in the IVI Configuration Store. For more information, refer to the KtMDsr IVI-COM Driver > Initializing the IVI-COM Driver help topic.



Obtaining the latest KtMDsr driver and Introduction 

Driver Releases: The table below shows the releases of the KtMDsr driver, with the most recent released listed first.

Date   Revision Description
2018-1-18 2.1.118.0 Third release of the KtMDsr driver as described in this document.
2016-3-10 2.0.2098.0 Second release of the KtMDsr driver.
2015-4-14 1.0.10.1 First release of the KtMDsr driver.

Obtaining the latest version of this driver: To see if a later version of this driver is available, perform the steps listed below. Note that a single driver works with both M9195A and M9195B.

  1. Go to www.keysight.com/find/M9195B.
  2. Click "Visit Technical Support".
  3. Select the "Drivers, Firmware & Software" tab.
  4. Click the "M9195B PXIe Digital Stimulus/Response IVI and MATLAB Instrument Drivers" link.
  5. Click the "Current Version" tab to view the latest version of this driver, and compare it to the driver version that you have.
  6. If the current version is later than your driver version, click the "Download" button and follow the instructions to download the current version and install it.

Obtaining the latest revision of this Introduction: This document is re-released with a new revision letter whenever any information in this document changes. The revisions to the Introduction are listed in the table below, with the most recent revision listed last.

Date   Revision Description
2018-1-18 A First release of the Introduction for driver version 2.1.118.0.
To see if a later revision of the Introduction is available for this driver, perform the following steps:
  1. Go to www.keysight.com/find/M9195B.
  2. Click "Visit Technical Support".
  3. Select the "Drivers, Firmware & Software" tab.
  4. Click the "M9195B PXIe Digital Stimulus/Response IVI and MATLAB Instrument Drivers" link.
  5. Find your version of the driver. The Introduction you're reading now is for driver version 2.1.118.0.
  6. The link to the latest revision of the Introduction is provided under the "Supporting Documentation" label. It is recommended that you use the Introduction accessible from this link if it is a later revision than the Introduction you're reading now.



Hardware and Software supported with this driver

Modules supported with this driver:

Module Firmware revision supported with this driver: 101

Operating Systems Supported with this driver:

Versions of Visual Studio supported with this driver: Visual Studio 2010 or later.

 Keysight embedded controllers supported with this driver:

Embedded Controller Operating system Description
M9036A Windows Embedded Standard 7 (32/64-bit)      
M9037A Windows Embedded Standard 7 (32/64-bit), Windows 10 64-bit      
M9536A Windows Embedded Standard 7 (32/64-bit) Controller for the AXIe chassis. The M9195A/M9195B module can be installed in a PXIe chassis that is connected to the M9521A AXIe System Module in a M9514A AXIe chassis.
M9537A Windows Embedded Standard 7 (32/64-bit), Windows 10 64-bit Controller for the AXIe chassis. The M9195A/M9195B module can be installed in a PXIe chassis that is connected as a downstream chassis to the AXIe chassis.

Keysight's IO Libraries Suite: The IO Libraries Suite must be installed prior to installing the KtMDsr driver. The following IO Libraries Suite releases are supported with this driver, with the most recent release listed first.

Release Date Release Version Comments
2017-11-15 2018 Update 0.1 18.1.22713.0 Use of this release is recommended.
2017-10-11 2018 18.1.22603.1  

System Requirements

Topic Windows Requirements
Processor speed 1 GHz 32-bit(x86), 1 GHz 64-bit (x64)
Available memory 4 GB minimum (8 GB recommended for 64-bit OS)
Available disk space* 1.5 GB available hard disk space, inlcudes:
      ♦  1 GB available for Microsoft .NET Framework 4.0†
      ♦  100 MB for Keysight IO Libraries Suite

* This is the disk space required for installation. Less disk space is required for operation
   than for installation.

† .NET Framework Runtime Components may be installed by default with Windows 7. If so, it is possible
   that you may not need this amount of disk space.

Hardware Requirements

Topic Requirements
Chassis PXIe or PXI-H chassis slot
Host Controller
A PXI or PXI Express embedded controller or remote controller (external PC
 connected to the chassis by a PCI-to-PXI interface) is required.
  Embedded controller Keysight M9037A or an embedded controller that meets the
following requirements:
     ♦  PXIe system controller (PXI-1 controllers are not compatible)
     ♦  Run one of the operating systems listed above.
Remote controller (For Keysight M9018A chassis use only)
Keysight M9021A Cable Interface x8 with one of the following PC
interface options:
     ♦  Keysight M9045B PCIe ExpressCard Adapter x1, with cable
         (for a laptop PC)
     ♦  Keysight M9048A, M9048B, or M9049A PCIe Desktop Adapter, with cable (for desktop PCs)
         or an equivalent remote controller using a PC running an operating system listed
         above.
   

Keysight Host Desktop Adapters: The following Keysight Host Desktop Adapters are supported with this driver:

Keysight System Modules: The following Keysight system modules are supported with this driver:

Keysight chassis: The following Keysight chassis are supported with this driver:

PXIe Chassis Family Driver releases supported with KtMDsr driver: The PXIe Chassis Family Driver enables IO Libraries Suite to display the contents of the chassis slots. The following PXIe Chassis Family Driver releases are supported with the KtMDsr driver:

Release Date Version
2017-04-19 1.6.493.1
2016-09-04 1.6.2.1

Keysight Command Expert releases supported with this driver Command Expert can be used to write programs to learn how the DSR module works and to perform simple operations. The following Command Expert releases are supported with this driver, with the most recent release listed first.

Release Date Version Description
2017-07-07 2017 Update 2 Use of this version is recommended.
2017-06-14 2017 Update 1  



IVI Compliance

This page provides IVI-required compliance information for the KtMDsr driver. IVI Compliance is describes in the IVI Specifications at: http://ivifoundation.org/specifications/default.aspx

IVI Compliance Category: IVI drivers come in a variety of types and configurations. This section provides IVI-required compliance information on the various categories of IVI compliance for the KtMDsr driver.

IVI Generation IVI-2014
Category Name IVI-COM/C Custom Specific Instrument Driver
Class Specification Version No IVI instrument class supported.

The KtMDsr driver supports the IVI Inherent Capabilities required of all IVI drivers. For detailed information, refer to the KtMDsr driver help file.

Optional Features: This section provides IVI-required information regarding optional IVI driver features supported by the KtMDsr driver.

Interchangeability checking No
State caching No
Coercion recording No

Driver Identification: This section provides IVI-required identity information for the KtMDsr driver.

Driver Revision See driver version listed at top of this page.
Driver Vendor Keysight Technologies
Driver Description IVI Driver for the KtMDsr Digital Stimulus Response module
Prefix/Component Identifier KtMDsr
Supported Models M9195A, M9195B

Hardware Information:

Instrument Manufacturer: Keysight Technologies
Supported Instrument Models: M9195A, M9195B
Supported Bus Interfaces: PXI, PXIe

32-bit Software Information:

Supported Operating Systems: Windows 7, Windows 10
Unsupported Operating Systems: Windows 8.0, Windows 8.1, Windows XP, Windows Vista
Support Software Required: VISA
Source Code Availability: Source code is installed with this driver.

64-bit Software Information:

Supported Operating Systems: Windows 7, Windows 8.1, Windows 10
Unsupported Operating Systems: Windows 8.0, Windows XP, Windows Vista
Support Software Required: VISA
Source Code Availability: Source code is installed with the driver.

Unit Testing

Test Setup Instrument:

Instrument Models (FW Revision): M9195A, M9195B
Bus Interface: PXI, PXIe
Operating System (Service Pack): Windows 7, Windows 8.1 64-bit and Windows 10
OS Bitness/Application Bitness: 32-bit/64-bit
VISA Vendor and Version: Keysight VISA (IO Libraries version 17.2 Update 1)
IVI Shared Components Version: 2.2.1

Test Setup Simulation:

Instrument Models: M9195A, M9195B
Bus Interface: N/A
Operating System (Service Pack): Windows 7, Windows 8.1 64-bit and Windows 10
OS Bitness/Application Bitness: 64-bit/32-bit, 64-bit/64-bit
VISA Vendor and Version: N/A
IVI Shared Components Version: 2.2.1

Driver Installation Testing:

Operating System (Service Pack): Windows 7, Windows 8.1 64-bit and Windows 10
OS Bitness: 32-bit, 64-bit

Driver Buildability:

Operating System (Service Pack): Windows 7 (SP1), Windows 8.1
OS Bitness: 32-bit, 64-bit
Visual Studio Version: VS2010, VS2013



Known Issues

Keysight Technologies has evaluated and tested this driver to verify that it meets all applicable requirements of the IVI specifications at the time this compliance document was submitted to the IVI Foundation and agrees to abide by the dispute arbitration provisions in Section 7 of the IVI Specification, section IVI-1.2: Operating Procedures, if the IVI Foundation finds this driver to be non-conformant.

There are no known issues with the driver at the time of shipment.

More Information

For more information about this driver and other instrument drivers and software available from Keysight Technologies visit: http://www.keysight.com/find/drivers



Contact Support

If you have feedback or need help using this driver, contact Keysight Technical Support:



Trademarks

© Keysight Technologies 2018

Microsoft, Windows, MS Windows, and Windows NT are U.S. registered trademarks of Microsoft Corporation.