Document Revision 1.1

Introduction to the KtMAwg IVI.NET/-C Instrument Driver

Driver Version: 1.1.880.0

This instrument driver provides access to the functionality of the M9336A AWG through a .NET or C API which also complies with the IVI specifications. This driver works in any development environment which supports .NET or C programming, including Microsoft Visual C++, Microsoft .NET languages, LabVIEW, LabWindows CVI, MATLAB and others.

For more information on this driver, visit  www.keysight.com/find/M9336A.

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 help files for the IVI.NET (Keysight.KtMAwg.Fx40.chm) and IVI-C (KtMAwg.chm) drivers can be found in the <Program Files (x86)>\Keysight\MAwg\Help directory. They contain:

  • General information about using the driver
  • IVI compliance information
  • Reference information for all functions and attributes in the IVI-C wrapper
  • Information about using the driver in a variety of development environments including Visual Studio (C#, VB.NET, C++).
  • Example programs

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) can be found in the folder: <Program Files (x86)>\IVI Foundation\IVI\Microsoft.NET\Framework32\v4.0.30319\Keysight.KtMAwg <driver version>\Examples and < Program Files (x86)>\IVI Foundation\IVI\Drivers\KtMAwg\Examples . For instructions on building examples, refer to Examples Readme.txt file in the Examples folder.

The IVI.NET driver and IVI-C source code, if optionally installed, can be found in the following folders: <Program Files (x86)>\IVI Foundation\IVI\Microsoft.NET\Framework32\v4.0.30319\Keysight.KtMAwg <driver version>\Source and <Program Files (x86)>\IVI Foundation\IVI\Drivers\KtMAwg\Source. The source code is a Visual Studio 2013 C++ project and may be loaded in newer versions of Visual Studio but the platform toolset must be set to Visual Studio 2013 (v120). 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.NET). 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.NET driver in different development environments:

Configuring Instrument Settings

The KtMAwg 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 KtMAwg IVI.NET Driver > Reference help topic and KtMAwg IVI-C Driver > IVI-C 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 about using the driver constructors, refer to the information on Direct Driver Instantiation in the KtMAwg IVI.NET Driver > Instantiating the IVI.NET Driver help topic and KtMAwg IVI-C Driver > Initializing the IVI-C Driver help topic. For more information about the usage of the instrument specific hierarchy, refer to KtMAwg IVI.NET Driver > Reference > Driver Hierarchy > IKtMAwg > help topic and IVI-C Driver > IVI-C Reference > Hierarchy > help topic.

The second hierarchy is the IVI Instrument Class compliant hierarchy which supports limited, basic instrument functionality common to most instruments of a 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 class. This hierarchy is available to programs that use the IVI class factory to instantiate the driver. For more information about the usage of the class factory, refer to the information on .NET Session Factory in the KtMAwg IVI.NET Driver > Instantiating the IVI.NET Driver help topic and KtMAwg IVI-C Driver > Initializing the IVI-C Driver help topic. For more information about using the IVI.NET class compliant hierarchy, refer to KtMAwg IVI.NET Driver > Reference > Driver Interfaces > Ivi.Driver Assembly > Classes > 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 about using the inherent capabilities, refer to KtMAwg IVI.NET Driver > Reference > Driver Hierarchy > IIviDriver help topic and KtMAwg IVI-C Driver > IVI-C Reference > Hierarchy > Inherent IVI Attributes 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 KtMAwg IVI.NET Driver > Instantiating the IVI.NET Driver help topic and KtMAwg IVI-C Driver > Initializing the IVI-C Driver help topic.

Obtaining the latest Introduction and KtMAwg driver

Obtaining the latest revision of this Introduction: This document is 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 first.

Date

Revision

Description

2017-05-15

1.0

First release of the Introduction for driver version 1.0.

2017-11-08

1.1

Second release of the Introduction for driver version 1.1.

To see if a later revision of the Introduction is available for this driver, perform the following steps:

In addition to checking for a later revision of this Introduction for your current driver version, you may also want to consider installing a later version of this driver, if available. Refer to the next section to determine if a later driver version is available.

To see if a later version of this driver is available, perform the following steps:

Supported Hardware and Software

Supported PXIe Module

Keysight M9336A PXIe I/Q Arbitrary Waveform Generator: 540 MHz, 3 scalar channels

Supported Module Firmware Revision

1.6.65

Supported Operating Systems

  • Windows 7 64-bit
  • Windows 10 64-bit

Supported Keysight Embedded Controllers

Embedded Controller

Operating System

M9036A

Windows Embedded Standard 7 (64 bit)

M9037A

Windows Embedded Standard 7 (64-bit)

Keysight's IO Libraries Suite

The IO Libraries Suite must be installed prior to installing the KtMAwg driver. This driver supports the following IO Libraries Suite releases, with the most recent release listed first.

Release Date

Release Version

2017-10-11

2018

2017-06-14

2017 Update 1

Keysight PC Interface Cards

This driver supports the following Keysight PC interface cards:

  • M9045B
  • M9048A
  • M9048B
  • M9049A

Keysight Chassis System Modules

This driver supports the following Keysight chassis system modules:

  • M9021A
  • M9022A
  • M9023A
  • M9024A

Keysight Chassis

This driver supports the following Keysight chassis:

  • M9005A
  • M9010A
  • M9018A/B
  • M9019A

NOTE : For more information about the right configuration of your single chassis and multi-chassis systems, refer to MultiChassisTool.pdf.

NOTE : Keysight recommends the use of Keysight chassis with Keysight PC Interface cards and chassis interface modules to avoid any errors. For detailed information about the tested PC Configurations for your chassis, refer to PC Tested Configurations with PXI/AXIe Chassis.

Supported M9018A Chassis Driver Releases

This driver supports the following M9018A chassis driver releases:

Release Date

Release Version

2016-09-04

1.6.2.1

2015-02-05

1.5.80.1

Supported Keysight Command Expert Releases

Command Expert can be used to write programs to learn how the AWG module works and to perform simple operations. This driver supports the following Command Expert releases, with the most recent release listed first.

Release Date

Release Version

Comments

2017-03-08

1.7 (2017)

Use of this version is recommended.

2016-12-01

1.6 Update1

 

2016-05-25

1.6

 

IVI Compliance

This page provides IVI-required compliance information for the KtMAwg 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 KtMAwg driver.

IVI Generation

IVI-2014

Category Name

IVI.NET/C Custom Specific Instrument Driver

Class Specification Version

No IVI instrument class supported

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

Optional Features

This section provides IVI-required information regarding optional IVI driver features supported by the KtMAwg driver.

Interchangeability checking

No

State caching

No

Coercion recording

No

Driver Identification

This section provides IVI-required identity information for the KtMAwg driver.

Driver Revision

See driver version listed at top of this page

Driver Vendor

Keysight Technologies

Driver Description

IVI Driver for the KtMAwg I/Q Arbitrary Waveform Generator module

Prefix/Component Identifier

KtMAwg

Supported Models

M9336A

Hardware Information

Instrument Manufacturer

Keysight Technologies

Supported Instrument Models

M9336A

Supported Bus Interfaces

PXI, PXIe

64-bit Software Information

Supported Operating Systems

Windows 7 64-bit, Windows 10 64-bit

Unsupported Operating Systems

Windows Vista 64-bit

Support Software Required

VISA

Source Code Availability

Source code is installed with this driver

Unit Testing

Test Setup Instrument

Instrument Models (FW Revision)

M9336A

Bus Interface

PXI, PXIe

Operating System (Service Pack)

Windows 7 64-bit and Windows 10 64-bit

OS Bitness/Application Bitness

64-bit/64-bit

VISA Vendor and Version

Keysight VISA (IO Libraries version 17.3)

IVI Shared Components Version

2.2.1

Test Setup Simulation

Instrument Models

M9336A

Bus Interface

N/A

Operating System (Service Pack)

Windows 7 64-bit and Windows 10 64-bit

OS Bitness/Application Bitness

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 64-bit and Windows 10 64-bit

OS Bitness/Application Bitness

64-bit/64-bit

Driver Buildability

Operating System (Service Pack)

Windows 7 64-bit and Windows 10 64-bit

OS Bitness/Application Bitness

64-bit/64-bit

Visual Studio Version

VS2013

Known Issues

Keysight Technologies has evaluated and tested this driver to verify that it meets all applicable requirements of the IVI specifications at this 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.

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:

  • Phone Support: +1 800 829-4444

Trademarks

Keysight Technologies 2017

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