background image

M5200A PXIe Digitizer Modules Startup Guide

59

Setting up the M5200x software

3

 

 3.4.3: Installing KS2201A PathWave Test Sync Executive SW

Note that the KS2201A PathWave Test Sync Executive software is not a

standalone software. It enhances the Keysight M5200x API to support HVI

technology by adding the DLLs required for programming libraries.

Therefore, the Keysight M5200x software must already be installed on the

same machine.

Refer to the 

KS2201A PathWave Test Sync Executive User Manual

available at 

KS2201A PathWave Test Sync Executive Technical Support

page for installation instructions and to know about the licenses that you

must procure for the KS2201A PathWave Test Sync Executive software.

Summary of Contents for M5200A

Page 1: ...0 3 H LJLWL HU 0RGXOHV RXU VD VHF ELWV UHVROXWLRQ 67 5783 8 ...

Page 2: ...n No additional government require ments beyond those set forth in the EULA shall apply except to the extent that those terms rights or licenses are explicitly required from all providers of commercial computer software pursuant to the FAR and the DFARS and are set forth specifically in writing elsewhere in the EULA Keysight shall be under no obligation to update revise or otherwise modify the Sof...

Page 3: ...presentative for replacement of device WARNING Verify that all safety precautions are taken Make all connections to the unit before applying power Note the external markings described under Safety symbols instrument markings WARNING Do not operate the device in an explosive atmosphere or wet environments Do not operate the instrument around flammable gases or fumes vapor or wet environments WARNIN...

Page 4: ...on condensing Type tested 95 RH up to 40 C decreases linearly to 40 RH at 45 C Altitude Operating condition Up to 10 000 ft 3048m Storage condition Up to 15 000 ft 4572m Pollution degree Pollution Degree 2 Pollution Degree Description 1 No pollution or only dry non conductive pollution occurs The pollution has no influence Example A clean room or climate controlled office environment 2 Normally on...

Page 5: ...a Authority The KC mark is the Korean certification mark This equipment is Class A suitable for professional use and is for use in electromagnetic environments outside of the home Electro Static Discharge Attach ESD protective wrist strap to avoid damage by direct contact with the equipment China Restricted Substance Product Label The EPUP environmental protection use period number in the center i...

Page 6: ...http www keysight com go conformity You can then search by product number to find the latest Declaration of Conformity Safety Symbol Description The crossed out wheeled bin symbol indicates that separate collection for waste electric and electronic equipment WEEE is required as obligated by the EU DIRECTIVE and other National legislation Please refer to keysight com go takeback to understand your ...

Page 7: ...le Chapter 3 Setting up the M5200x software describes the steps to download install and get started with the M5200x software along with its associated software Chapter 4 Troubleshooting and Safety information describes few troubleshooting steps along with some safety information you must observe while using the M5200A card and related equipment For more information For detailed information on how ...

Page 8: ...8 M5200A PXIe Digitizer Modules Startup Guide ...

Page 9: ...es About this document 14 About M5200A PXIe Digitizer modules 15 About products supported with M5200A modules 18 About M5200x software features 21 About PathWave FPGA and BSP 22 Using PathWave FPGA 22 Using BSP with PathWave FPGA 22 About KS2201A PathWave Test Sync Executive software 24 About HVI Technology 24 M5200A Firmware version requirements for HVI 25 About HVI Application Programming Interf...

Page 10: ...talling the Embedded Controller 35 Connecting a remote controller PC to the chassis 37 Installing Slot Blockers and Filler Panels 38 Installing the Module 38 Powering up the Chassis and Remote Controller PC 39 Installing required software 40 Verifying M5200A module s operation 41 Verifying M5200A connection 41 Conducting Self test 43 Cleaning the module 46 3 Setting up the M5200x software Prerequi...

Page 11: ...6 Initiating PathWave Test Sync Executive software 67 Launching the PathWave FPGA BSP 68 4 Troubleshooting and Safety information Troubleshooting installation issues 72 Troubleshooting issues with Python 73 Installing M5200x Drivers on Python ver other than 3 7 73 Installing Python after the Instrument Driver 73 Troubleshooting issue with launching SFP 74 Troubleshooting issues with PathWave FPGA ...

Page 12: ...12 M5200A PXIe Digitizer Modules Startup Guide Contents ...

Page 13: ...tizer modules About this document 14 About M5200A PXIe Digitizer modules 15 About products supported with M5200A modules 18 About M5200x software features 21 About PathWave FPGA and BSP 22 About KS2201A PathWave Test Sync Executive software 24 References to Help documents 27 ...

Page 14: ...ent This document helps you get started with a brief introduction to the M5200A PXIe Digitizer module along with its associated software components It also serves as a guide for the required preliminary setup followed by procedures to install the Keysight M5200A PXIe Module SFP and API along with its extended components ...

Page 15: ... PXIe Digitizer Modules 1 Section 1 2 About M5200A PXIe Digitizer modules The M5200A is a single slot PXIe module Figure 1 shows the front view of an actual physical M5200A module that can be procured Figure 1 Front view of an M5200A High speed PXIe Digitizer module ...

Page 16: ...nector synchronization and sequencing four bi directional SMB I Os four Channels with single ended analog input SMA connectors and two connectors for 2 4 GHz clkout and 2 4 GHz clkin for coherent frequency response Characteristics Value Range Sampling rate 4 8 GSa s Resolution 12 bit Input impedance 50 Ohm Coupling DC Bandwidth DC 2 GHz Input voltage full scale range 900 mV pk pk module default ga...

Page 17: ... Startup Guide 17 Overview on M5200A PXIe Digitizer Modules 1 Figure 2 Functional depiction of the M5200A module CAUTION Use caution when mating high density connectors to ensure proper alignment and prevent damage to the contacts ...

Page 18: ...operations Required equipment Recommended Part number s PXIe RF AWG modules M5300A PXIe Downconverter modules M5201A PXIe LVDS Digital IO modules M5302A System Sync modules M9032A M9033A Baseband AWG modules M3201A M3202A PXIe Chassis High Power 18 slot 24 GB s M9046A Controller options use one of the following options PXIe High Performance Embedded Controller M9037A External Controller recommende...

Page 19: ... modules require specific Keysight cables that have been customized for connectivity with the M9032x SSM modules and M9046A PXIe high performance chassis Table 4 lists the cables that you may procure for the configuration of a single multi chassis multi system setup Table 4 Customized cables for use with M5200A PXIe Digitizer modules Cable type Specification Model number System Sync Link x4 x4 0 5...

Page 20: ...um computing system shall determine the quantity of modules and cables that should be procured For more information about the cables that you wish to procure contact Keysight Support NOTE When configuring with the M9046A QS1 option all cables must be the same length to ensure proper functioning of the clocking mechanism ...

Page 21: ...M5200A module provides a comprehensive platform to perform the basic operations pertaining to Digitizer modules The M5200x software also supports the Hardware FPGA reprogramming which is done using the PathWave FPGA Board Support Package Moreover the M5200x software API is powered by the KS2201A PathWave Test Sync Executive software for performing real time operations and HVI sequencing Figure 3 M...

Page 22: ... to the embedded help file or the documentation available in the KF9000B PathWave FPGA Technical Support page 1 5 2 Using BSP with PathWave FPGA PathWave FPGA by itself does not provide access to any of the controls which are associated with the Keysight M5200A PXIe modules You must install the Board Support Package BSP which is installed along with the M5200x SW drivers to leverage the features w...

Page 23: ...n FPGA design The sandbox region contains the user specific FPGA design The interface of the sandbox depends on the static region implementation A specific design flow is promoted by PathWave FPGA called Partial Reconfiguration PR In a PR flow a full FPGA reconfiguration is only necessary once for a given static region version The sandboxes can be reconfigured anytime without a full reconfiguratio...

Page 24: ...HVI technology enables you to program one or multiple instruments to execute time deterministic sequences of operations and execute them with precise synchronization It achieves this by deploying an executable code into each instrument s HW to be executed by the HVI engine or processor included integrated into the instrument The code executes on these engines in parallel across multiple instrument...

Page 25: ...common to all products and only the instrument specific HVI API will change instrument instructions actions events depending on the products It is important to differentiate between the core HVI features and the instrument specific extensions which allow a heterogeneous array of instruments and resources to coexist on a common framework The HVI Core API exposes all HVI functions and is a common AP...

Page 26: ... M5200x SFP provides a visual representation of most of the M5200x API s features The M5200x API classes contains HVI add on API interfaces provided as an extension of the instrument These add on interfaces provide access to instrument specific HVI features such as DAQ configuration triggering and so on For installation and usage instructions regarding the KS2201A PathWave Test Sync Executive soft...

Page 27: ...Help Keysight_KtM5200x_Fx45 chm M5200x HVI Add on Help Keysight_KtM5200xHvi_Fx45 chm M5200x C API Help index html ktM5200x LabVIEW API Help KtM5200x_LabVIEW_Help chm C Program Files Keysight M5200x LABVIEW_DRIVER_HELP M5200x Python API Help index html Click Start Keysight M5200x PCIe Module or go to C Program Files Keysight M5200x python html M5000 Series PXIe Modules Data Sheet PDF M5200A PXIe Di...

Page 28: ...28 M5200A PXIe Digitizer Modules Startup Guide 1 Overview on M5200A PXIe Digitizer Modules ...

Page 29: ...XIe Digitizer Modules Startup Guide 2 Setting up the M5200A module Unpacking Inspecting and Verifying the shipment 30 Installing the PXIe Module 33 Verifying M5200A module s operation 41 Cleaning the module 46 ...

Page 30: ...ged notify your local Keysight Technologies Inc representative 2 1 1 Precautions against ESD Electrostatic discharge ESD can damage or destroy electronic components Use a static safe workstation to perform all work on electronic assemblies Figure 4 shows a static safe workstation using two types of ESD protection Figure 4 Static safe workstation for ESD protection Conductive table mat and wrist st...

Page 31: ...hipping damage Report any damage to the shipping agent immediately as such damage is not covered by the warranty Refer to the warranty information at beginning of this document Visit www keysight com find tips for information on preventing damage to your Keysight equipment WARNING DO NOT use these techniques for a static safe workstation when working on circuitry with a voltage potential greater t...

Page 32: ...ite the following information on a tag and attach it to the malfunctioning equipment Name and address of the owner A P O box is not acceptable as a return address Description of failure or service required 4 Pack the instrument in its original packaging Include all cables If the original packaging material is not available use anti static bubble wrap or packing peanuts Place the instrument in a se...

Page 33: ...e the recommended best practices to ensure proper and safe module operating conditions Ensure that the ambient air temperature around the chassis does not exceed 40 C To maintain proper airflow within the chassis all empty chassis slots must be fitted with slot blockers Keysight model Y1212A 5 per kit and EMC filler panels Keysight model Y1213A 5 per kit This includes any empty slots to the left o...

Page 34: ... chassis such that the module may receive sufficient airflow for adequate cooling If not it can result in a thermal shutdown of the M5200A module Setting the fan speed to the maximum limit ensures maximum cooling with all chassis The Keysight Chassis have multiple air intakes They are located at the lower sides lower front and bottom of the chassis Refer to the documentation of the Chassis you are...

Page 35: ...ntroller Figure 6 Front panel view of M9037A Embedded Controller If your configuration contains a Keysight Embedded Controller for example M9037A follow the procedure below For additional details refer to the instructions in the M9037A Startup Guide 1 Remove the M9037A module from its ESD protective bag See Precautions against ESD on page 30 2 Install the embedded controller in Slot 1 see the icon...

Page 36: ...ard position slide the controller module into chassis using the slot guides top and bottom Sliding the module into position when you begin to feel resistance pull up on the injector ejector handle to fully inject the module into the chassis backplane connectors Tighten the module retaining screws top and bottom and torque them to 5 Lb In 0 57 N m 3 Install a blank Y1213A filler panel in the empty ...

Page 37: ...e Interface module into the chassis While holding the module by the injector ejector handle and making sure the injector ejector handle is pushed down in the unlatched downward position slide the module into chassis using the slot guides top and bottom Sliding the module into position when you begin to feel resistance pull up on the injector ejector handle to fully inject the module into the chass...

Page 38: ...modules from left to right similar to installing the embedded controller as shown in Figure 7 Also Figure 8 illustrates and x ray view of the direction and position of the module inside the chassis during insertion When installing the M5200A module 1 Hold the module by the injector ejector handle and make sure that the injector ejector handle is pushed down in the unlatched downward position Slide...

Page 39: ...igure 9 Establishing earth ground to the chassis 2 Make sure all cable connections are secure and modules controller inserted properly 3 Press the power button on the chassis The temperature LED which is on for the first three seconds after the chassis is powered up can be used as an indicator of when to power on the PC When the LED goes off the PC can be powered on 4 Power on the PC NOTE The imag...

Page 40: ...s is powered down The power sequence described above doesn t apply to an embedded controller installed in the chassis because the embedded controller and chassis are powered together 2 2 8 Installing required software After the PC boots up and Windows desktop appears you must install the software required for programming the M5200A modules See Chapter 3 Setting up the M5200x software CAUTION PXIe ...

Page 41: ...fying M5200A connection The Keysight Connection Expert installed with IO Libraries Suite helps you check the connection of the M5200A PXIe Digitizer modules To check if the module and its slot location are visible in the Keysight Connection Expert click Start Keysight Connection Expert As shown in Figure 10 the connected instruments are visible in the Connection Expert including one or more M5200A...

Page 42: ...Ie Module M5200x SFP x64 The Connect to Instrument window appears by default and if connected it displays the M5200A modules along with the respective slots and VISA address Figure 11 Checking M5200A connection in M5200x SFP If you are still unable to communicate with the M5200A modules verify that the following software and hardware has been correctly installed Keysight IO Libraries Suite M5200x ...

Page 43: ... module you wish to run the self test on and click Connect Figure 12 Viewing module connections in M5200x SFP 3 From the main menu of the M5200x SFP click Utilities Self Test Figure 13 Viewing module connections in M5200x SFP 4 On the Self Test window that appears click Run Self Test NOTE If the module and its slot location is not visible in the Connect to Instrument dialog box close the SFP and p...

Page 44: ...p the M5200A module Figure 14 Starting Self test on the selected M5200A module If the self test is successful the Self Test window appears as shown below Figure 15 Self test passed status on the selected M5200A module 5 Click Close to exit the Self Test window ...

Page 45: ...ules Startup Guide 45 Setting up the M5200A module 2 If the Self Test fails it indicates that the module likely needs service In such cases you must return the faulty module Refer to Returning the Module for Service on page 32 ...

Page 46: ...to clean the front plate face plate only of the M5200A module 3 If a damp cloth is used or if there is condensation from the compressed air make sure that the card is completely dry before reinserting the card into the chassis WARNING Do not attempt to clean the card If cleaning is absolutely necessary to prevent electrical shock disconnect the power cord from the mains before removing the modules...

Page 47: ... Modules Startup Guide 3 Setting up the M5200x software Prerequisites to setting up M5200x software 48 Obtaining License Options 52 Downloading required software 53 Installing required software 54 Launching the software 61 ...

Page 48: ...able 8 1 On the Technical Support page click the Download button and save the installer 2 Run the downloaded installer S No Prerequisite software name click to navigate License Free Procured 1 Keysight IO Libraries Suite 2018 version 18 1 23218 or later Free 2 M9046A PXIe Chassis Drivers Free 3 Xilinx Vivado Design Suite 2017 3 or later Refer to PathWave FPGA Customer Documentation for installatio...

Page 49: ...is model being used Keysight recommends installing the required firmware version and its compatible chassis driver separately Instructions for Python users 1 Double click the Python installer which you have downloaded on your local machine The Python Setup window appears Figure 16 Initial Python Setup window 2 Make sure that both options Install launcher for all users recommended and Add Python 3 ...

Page 50: ...ow pertaining to Python Setup click Close to exit 5 To verify if the Python installation is successful a Launch the command prompt b On the root directory type python and press Enter See Figure 18 The version information of the current Python installation is displayed Figure 18 Python installation verification on command prompt window ...

Page 51: ...e following commands to install the NumPy SciPy and Matplotlib libraries python m pip install numpy python m pip install scipy python m pip install matplotlib After each library is installed you should see a message Successfully installed If you encounter any error exit the command prompt window and launch a new one to repeat steps 5b and 6 The procedure for downloading and installing the M5200x s...

Page 52: ... license options that you must procure Visit the respective product page on www keysight com for pricing details and purchasing Keysight products Table 9 Software License Options required for supported Software other than M5200x Software License option KS2201A PathWave Test Sync Executive software KS2201A PathWave Test Sync Executive User Guide KF9000B PathWave FPGA 2022 PathWave FPGA Customer Doc...

Page 53: ...shown in Table 10 Prior to installing one or more of these software files you must have installed the software listed under the section Prerequisite software requirements on page 48 Table 10 Required software and installer pages Sequence Prerequisite software Web Page to download installer from 1 Keysight M5200x software Click here to visit page 2 KS2201A PathWave Test Sync Executive software Clic...

Page 54: ...nce listed in Table 10 Before you begin installing the M5200x software you must ensure that all other software listed in Prerequisite software requirements on page 48 are installed on the same machine 3 4 1 Installing Keysight M5200x software 1 After you have downloaded the executable file from Keysight com double click the installer for M5200x Software Figure 20 Icon for the M5200x software insta...

Page 55: ...x software 3 The Welcome screen on the M5200x Setup Wizard appears Figure 21 Welcome window on the M5200x Setup Wizard 2 Click Next The terms of the License Agreement are displayed Figure 22 License Agreement window on the M5200x Setup Wizard 3 Select Agree to proceed ...

Page 56: ... you that the wizard is ready to begin installation of the M5200x SW drivers Figure 23 Information displayed on the M5200x Setup Wizard 5 Click Next A progress bar appears indicating the installation status Figure 24 Progress bar on the M5200x Setup Wizard The completion window on the M5200x Setup Wizard is displayed ...

Page 57: ...GA firmware enabled click Finish to complete the software installation to exit the M5200x Setup Wizard and to allow the installer to proceed with updating the FPGA firmware revision on the M5200A modules The following prompt is displayed during FPGA firmware update Figure 26 Updating firmware prompt in the M5200x Setup Wizard ii Clear the Update FPGA firmware check box click Finish to complete the...

Page 58: ...g requirements you may either upgrade or downgrade the Firmware version on an M5200A module using the SW driver APIs or the M5200x SFP The APIs to perform firmware update are defined in the Online Help of the respective programming language you may be using The steps to perform firmware update using the SFP are given below 1 Launch the Keysight M5200x SFP software from the Start menu 2 From the ma...

Page 59: ...ht M5200x API to support HVI technology by adding the DLLs required for programming libraries Therefore the Keysight M5200x software must already be installed on the same machine Refer to the KS2201A PathWave Test Sync Executive User Manual available at KS2201A PathWave Test Sync Executive Technical Support page for installation instructions and to know about the licenses that you must procure for...

Page 60: ...software package There is no separate BSP installer for M5200A modules The M5200A BSP can be accessed only within the PathWave FPGA Design Environment and not separately The PathWave FPGA 2022 software along with Xilinx Vivado Design Suite must be installed on the same machine as the M5200x software Also see Xilinx Vivado tool not installed on page 75 and Timing errors during k7z file generation o...

Page 61: ... M5200x user interface Once you have installed the Keysight M5200x software you can launch the Soft Front Panel SFP from the Start menu 1 On your Win10 OS click Start Keysight M5200x PCIe Module M5200x SFP x64 Figure 28 Launching SFP from the Start Menu The Connect to Instrument window is displayed as shown in Figure 29 and Figure 30 ...

Page 62: ...fault window with active cards As shown in Figure 30 while launching the Keysight M5200x software auto detects any active M5200A cards that are connected to the chassis All such cards are displayed along with the chassis slot number and VISA address on the Connect to Instrument window There are two modes that the M5200x SFP can be operated in ...

Page 63: ...if you select an active module which is connected to a chassis in powered on state toggling the SFP controls does not affect the signal state on the module The status bar on the main window shows Simulation Mode as shown in Figure 31 Figure 31 Simulation Mode in the status bar on the main window Note that a demo M5200A module only is displayed in Figure 29 and in Figure 30 along with other active ...

Page 64: ...to Instrument window as shown in Figure 32 In this mode only the active modules are displayed along with the respective chassis number slot number and VISA address Figure 32 Connect to Instrument with Simulation Mode disabled This mode is used for active SFP operations In this mode toggling the SFP controls changes the signal state on the selected module The status bar on the main window shows Con...

Page 65: ...e 3 Figure 33 Connected to VISA address in the status bar on the main window For more information regarding the features and functionality of the Keysight M5200x SFP refer to the M5200A PXIe Digitizer Modules User Guide which can be accessed via the Help menu of the M5200x SFP ...

Page 66: ...ight M5200x Programming Libraries 1 Import required system components and python libraries as needed Examples import sys import os import numpy as np For keysight_ktm5200x arrays 2 Import the M5200x Python library for programming the M5200A card Example import keysight_ktm5200x as m5200x 3 Proceed with creating module objects and defining other M5200x functions For more information regarding M5200...

Page 67: ...thon import the HVI API Python package that is included with the HVI installer This will be your first part of your code in each of your files Unless this package is imported the HVI API will not be found The following work flow using Python commands shows how to add HVI library to an application and create an HVI instance 1 Import required system components and python libraries as needed Examples...

Page 68: ...talled as part of the M5200x software installation which lets you proceed further with creating a new project in PathWave FPGA to design the sandbox region for the corresponding module If you are unable to create a new project see Module specific BSPs not installed on page 75 For instructions to create a new project to design your custom FPGA logic and to generate the Bitstream k7z file which can ...

Page 69: ...es Startup Guide 69 Setting up the M5200x software 3 For information about APIs associated with FPGA operations in the M5200A modules refer to the Python API Help index html located in C Program Files Keysight M5200x python html ...

Page 70: ...70 M5200A PXIe Digitizer Modules Startup Guide 3 Setting up the M5200x software ...

Page 71: ...up Guide 4 Troubleshooting and Safety information Troubleshooting installation issues 72 Troubleshooting issues with Python 73 Troubleshooting issue with launching SFP 74 Troubleshooting issues with PathWave FPGA 75 Safety information 77 ...

Page 72: ...stall and the installer is stalling for long periods or failing installing Keysight IO Libraries try downloading and installing Keysight IO Libraries directly from https www keysight com find iolibs For Keysight support for help with tools and documentation or to connect with a technical support expert for product and service support see https www keysight com find support ...

Page 73: ... file as shown C Program Files Keysight M5200x python pip install keysight_ktm5200x 1 0 43106 tar gz 4 2 2 Installing Python after the Instrument Driver The installers for M5200A module drivers attempt to install Python during installation However there are various reasons including the ones listed below that this may not work for you 1 Python 3 7 x is not set as the default Python interpreter on ...

Page 74: ... LiveSFP example in the LabVIEW drivers or any other wrapper you may encounter an error message as shown in Figure 34 Figure 34 SciChart error when launching SFP using LabVIEW example In such cases you must install the SciChart developer license to launch the SciChart application using a different driver wrapper Visit https www scichart com licensing scichart to obtain the required license ...

Page 75: ...ed by PathWave FPGA SW if BSP is not installed To fix this issue install reinstall the SW drivers for the required driver See Installing required software on page 54 4 4 2 Xilinx Vivado tool not installed If you do not have the Xilinx Vivado Design Suite on the same machine where the KF9000B PathWave FPGA software and BSP are installed the following error is prompted when you click the Generate Bi...

Page 76: ...keysight_common_build tcl file located at C Program Files Keysight M5200A BSP GW version scripts See Figure 37 The place_design directive options available are AltSpreadLogic_medium AltSpreadLogic_high AltSpreadLogic_low ExtraNetDelay_low ExtraNetDelay_high Explore After changing this option close the PathWave FPGA interface and relaunch the application for the changes to take effect Figure 37 Cha...

Page 77: ...ting the equipment is the responsibility of the assembler of the system WARNING If this product is not used as specified the protection provided by the equipment could be impaired This product must be used in a normal condition in which all means for protection are intact only CAUTION The measuring terminals on this instrument are designed to be used with external signals described in Mains isolat...

Page 78: ...s switches socket outlets in the fixed installation equipment for industrial use and some other equipment such as stationary motors with permanent connection to the fixed installation NOTE For equipment that is part of a fixed installation the fuse or circuit breaker of the installation can be considered to provide adequate protection against short circuit currents IV Applicable to test and measur...

Page 79: ...M5200A PXIe Digitizer Modules Startup Guide 79 ...

Page 80: ...This information is subject to change without notice Keysight Technologies 2022 Edition 1 0 July 2022 www keysight com ...

Reviews: