Advertisement

EPICS Interface
M-Class Oscilloscopes
LXI Models
User's Manual: 0004-000067
Revision 2a
December 7, 2009
0004-000067
®
ZT4611, ZT4612,
ZT4211, ZT4212,
ZT4421, ZT4422,
ZT4431, ZT4432,
ZT4441, ZT4442
1

Advertisement

Table of Contents
loading

Summary of Contents for Z-Tec ZT4611

  • Page 1 ® EPICS Interface M-Class Oscilloscopes LXI Models ZT4611, ZT4612, ZT4211, ZT4212, ZT4421, ZT4422, ZT4431, ZT4432, ZT4441, ZT4442 User’s Manual: 0004-000067 Revision 2a December 7, 2009 0004-000067...
  • Page 2 Contact ZTEC Instruments Telephone: (505) 342-0132 7715 Tiburon Street NE Fax: (505) 342-0222 Albuquerque, NM 87109 Web Site: www.ztecinstruments.com ZTEC Instruments, Inc. welcomes your comments on this manual. All manuals are thoroughly reviewed before distribution. We are, however, grateful for any comments from our users which will further help to improve the content and quality of our documents.
  • Page 3 Handling Precautions for Electronic Devices Subject to Damage by Static Electricity This instrument is susceptible to Electronic Static Discharge (ESD) damage. When transporting, place the instrument or module in conductive (anti-static) envelopes or carriers. Open only at an ESD-approved work surface. An ESD safe work surface is defined as follows: •...
  • Page 4 Revision History Date Section Description 1-4-08 Initial Release 4-10-08 Updated PV list, expanded introduction, added upload waveform information 9-15-08 Added new PVs: gating, initiate continuous, webLXI interface 9-10-09 All Sections revised, new sections added. Added new PVs: operation complete enable, operation complete query, segment view, segment mode, segment count, accessory id, memory clear, undo, reference position,...
  • Page 5: Table Of Contents

    Table of Contents Introduction ..........................6 Instrument Discovery......................6 Versions ..........................6 Instrument Information ......................6 EPICS Information......................6 Installed Files ........................7 Configuration..........................8 Instrument Configuration ....................8 Database Configuration.....................9 PV Database File....................9 Database Template Files..................10 Database Definition File ..................10 Changing PVs......................10 PV Naming Conventions ..................10 Set/Get PVs......................11 FLNKs &...
  • Page 6: Introduction

    Introduction ® This manual provides detailed information on the ZTEC EPICS interface and functionality. Printed LXI Quick Start and EPICS Getting Started guides, included with an instrument, may provide enough information to get an instrument up and running quickly. Reference this manual or visit http://www.ztecinstruments.com/support for additional technical support.
  • Page 7: Installed Files

    Installed Files ® ® Both Windows and Linux versions of the ZTEC M-Class ZScope installers provide EPICS files in the following default installation directories (EPICS Installation): Windows: C:\Program Files\ZTEC Instruments\Mclass\Scope\EPICS Linux: /usr/local/share/ZScopeM/EPICS 0004-000067...
  • Page 8: Configuration

    Configuration Instrument Configuration The instrument’s Network and Channel Access settings may be changed using the ® ZTEC webLXI interface, accessed through a web browser by navigating to the IP address of the instrument. webLXI presents three main pages, or tabs, of functionality. The initial page is a Welcome tab which presents a set of instrument information available to all webLXI users.
  • Page 9: Database Configuration

    Go to the Configuration EPICS Configuration page to adjust and apply the Channel Access values. Power cycle the instrument if any changes are made. webLXI EPICS Configuration Database Configuration PV Database File The PV database file defines the capabilities of the instrument accessible through EPICS.
  • Page 10: Database Template Files

    the Instrument Manual for values that match your specific instrument. The default PV file comes preloaded on the instrument and provides most instrument functionality. Each PV is an instance of a record, which has a type and a set of fields. Each PV within the database file references a template file.
  • Page 11: Set/Get Pvs

    being communicated with. Name changes may affect links and fanouts; to prevent loss of functionality make sure any FLNK names are also changed. Set/Get PVs The “set” PVs allow the user to change an instrument’s state. The “get” PVs allow the user to read the value without changing the instrument’s state.
  • Page 12: Uploading A Pv Database File

    Through a browser’s File menu, the …/ztec.pv page can be saved as a text file to then be modified and uploaded, or just backed up. The name of this file does not matter in regards to uploading, but the .pv extension is suggested, along with a relevant filename, in order to better track its contents.
  • Page 13: Channel Access Interface

    PV File Upload Interface Once The PV file is loaded it can be reviewed by using the link on the EPICS Configuration webLXI page, or going to http://<your instrument’s ip address>/ztec.pv. If the new PV file is not visible, make sure the browser is not caching an old page by clearing the cache or temporary internet files, and then try to access the page again.
  • Page 14: Edm & Medm Interfaces

    EDM & MEDM Interfaces The Extensible Display Manager (EDM) and the Motif Editor and Display Manager (MEDM) are common graphical extensions to Channel Access and EPICS. ® ZTEC has provided an example display panel for EDM and for MEDM. The panel launcher scripts can be found in the EPICS Installation script directories.
  • Page 15: Functionality

    However, if setOutCoerce is set to on, set PVs will update their own value based on the current instrument state during processing. For example, with a ZT4611, when setting an invalid input range of 3, the value will be coerced to 2. In Channel Access you would see:...
  • Page 16: Capturing

    is not recommended. Note that PVs with scan rates will continue to access the instrument even if they are not being used. Ensure that all scan rates are disabled before using a non-CA interface. Capturing Before capturing waveforms it is best to configure the instrument as needed (see Instrument Use Example and the Waveform Process Variables Table).
  • Page 17: Uploading Waveforms

    Uploading Waveforms Waveforms can be uploaded as an array of type DBR_DOUBLE via Channel Access using the CalcNUpload, CalcNScaledUpload, RefNUpload and RefNScaledUpload PVs (see section “Reference Process Variables”). In order to correctly store the uploaded waveform data, some waveform preamble information must be included. This is done by storing the needed values in the first four elements of the array.
  • Page 18: Instrument Use Example

    Instrument Use Example This set up assumes a system with the EPICS environment installed. 1. Limit your instrument communication, there are several possible options: a. Upload a new PV file as described above. Changing the PV prefixes will give the instrument a unique set of PVs. b.
  • Page 19: Process Variables

    Process Variables Process Variable Table The following tables list the process variables for the oscilloscope, grouped according to instrument functionality. 0004-000067...
  • Page 20: Input Process Variables

    Input Process Variables The following table lists the PVs for the input or vertical (voltage-axis) settings of the input channels. These PVs are duplicated for each input channel. In the following table, N is substituted with the appropriate channel number (for example: Inp1Enable). The ZT4xx1 has two channels (N = 1 to 2) and the ZT4xx2 has four channels (N = 1 to 4).
  • Page 21: Horizontal Process Variables

    Horizontal Process Variables The following table lists the PVs for the horizontal (time-axis) settings for the waveform acquisition. These PVs configure the common horizontal settings of all input channels. Process Type Values Description Variable setHorzPoints longout 10 to max, Varies Number of points in waveform getHorzPoints longin...
  • Page 22: Acquisition Process Variables

    Acquisition Process Variables The following table lists the PVs for the waveform acquisition settings. These PVs configure the common acquisition settings of all input channels. Process Variable Type Values Description setAcqType mbbo Discrete Waveform acquisition type: getAcqType mbbi “NORM” = normal “AVER”...
  • Page 23: Trigger Process Variables

    Trigger Process Variables The following table lists the PVs for the trigger settings used to configure the trigger for the waveform acquisition synchronization. There are individual trigger level settings for each of the input channels, with N designating the appropriate channel number (for example: TrigLevInp1).
  • Page 24: Advanced Trigger Process Variables

    Process Variable Type Values Description setTrigHoldoff 0 to 100 Holdoff time in seconds to wait before detecting getTrigHoldoff trigger setTrigCount longout 1 to 65535 Trigger event count to qualify trigger getTrigCount longin Advanced Trigger Process Variables The following table lists the PVs for the advanced trigger settings. These PVs configure advanced trigger functions including trigger B, pulse width triggering, glitch triggering, pattern triggering, and video triggering.
  • Page 25 Process Variable Type Values Description setTrigPattMask longout 0000 Pattern trigger mask for defining pattern match getTrigPattMask longin 1FFF criteria (0 = ignore, 1 = match required), used in conjunction with set/getTrigPattTruth: Bit 0 = input channel 1 Bit 1 = input channel 2 Bit 2 = input channel 3 (ZT4xx2) Bit 3 = input channel 4 (ZT4xx2) Bit 4 = external input...
  • Page 26: Arm Process Variables

    Arm Process Variables The following table lists the PVs for the arm settings used to configure the arm-qualified trigger for the waveform acquisition synchronization. When using the input channels or external input as the arm source, the arm threshold level is set using the corresponding trigger PV.
  • Page 27: Output Process Variables

    Output Process Variables The following table lists the PVs for the output settings used to configure the signal outputs. These outputs include the external output on the front panel and TTLTRGN outputs on the external trigger header. The trigger output PVs are duplicated for each TTLTRGN output.
  • Page 28: Calculate Process Variables

    Process Variable Type Values Description setOutTrigNSource mbbo Discrete Output source for selected trigger: getOutTrigNSource mbbi “ARM = arm event “TRIG” = trigger complete event “ATR” = trigger A event “BTR” = trigger B event “CAPT” = capture complete event “OPC” = operation complete event “CONS”...
  • Page 29 Process Variable Type Values Description setCalcNPos 0.0 to 1.0 Sets or queries the relative DC voltage offset for the getCalcNPos Calculate Channel represented at the vertical zero for the selected channel. Default voltage position is 0.5 (50%). Changing a Calculate Channel’s position resets the calculation.
  • Page 30: Advanced Calculate Process Variables

    Advanced Calculate Process Variables The following table lists the PVs for the advanced calculate channel settings used to configure specific calculations or math. These PVs are duplicated for each calculate channel. In the following table, N is substituted with the appropriate channel number from 1 to 4 (for example: Calc1FFTWin).
  • Page 31 Process Variable Type Values Description “PER” = Period “PHAS” = Phase “PTP” = Peak-to-peak “PWID” = Positive width “REDG” = Number of Rising Edges “ROV” = Rising edge overshoot “RPR” = Rising edge preshoot “RTCR” = Rising edge crossing time “RTIM”...
  • Page 32 Process Variable Type Values Description CalcNMaskGen 0 or 1 Generates reference waveforms for mask testing based on calculation source. setCalcMaskVertOffset 0 to full Sets the vertical offset in volts used in getCalcMaskVertOffset scale generate reference masks setCalcMaskHorzOffset 0 to sweep Sets the horizontal offset in seconds used in getCalcMaskHorzOffset time...
  • Page 33 Process Variable Type Values Description CalcNMeasClear 0 or 1 Clears measurement history. A transition from 0 to 1 causes the clear, after which the value returns to 0 setCalcNGateTimeStart 0 to Sets or gets the start time for the mask test getCalcNGateTimeStart Maximum gate, if setting the gates by time.
  • Page 34: Reference Process Variables

    Reference Process Variables The following table lists the PVs for the reference channel settings used to configure the waveform storage channels. These PVs are duplicated for each reference channel. In the following table, N is substituted with the appropriate channel number from 1 to 4 (for example: Ref1Enable).
  • Page 35: Measure Process Variables

    Measure Process Variables The following table lists the PVs for the Measure functionality. Up to 32 measurements are performed automatically after each waveform acquisition, and the results updated in the corresponding measurement PVs. In the following table, N is substituted with the appropriate measurement number from 1 to 32 (for example: Meas1Enable), except where stated otherwise.
  • Page 36 Process Variable Type Values Description MeasCursXDelta -Inf to +Inf Queries the difference between the cursor positions on the x axis. Units depend upon the cursor source waveform type. For normal time based waveforms, the x axis is time. For FFTs the x axis is frequency.
  • Page 37 Process Variable Type Values Description “ENOB” = Effective number of bits (FFT) “FEDG” = Number of Falling Edges “FOV” = Falling edge overshoot “FPR” = Falling edge preshoot “FREQ” = Frequency “FTCR” = Falling edge crossing time “FTIM” = Fall time “HIGH”...
  • Page 38: Operate Process Variables

    Operate Process Variables The following table lists the PVs for the instrument operation involving the controls for waveform acquisition. Process Variable Type Values Description setOpInitCont 0 or 1 The instrument’s continuous acquisition mode: getOpInitCont 0 = single capture 1 = continuous capture OpInitiate 0 or 1 Initiate waveform acquisition.
  • Page 39: Waveform Process Variables

    Waveform Process Variables The following table lists the PVs for the acquired waveforms. In the following table, N is substituted with the appropriate channel number (for example: Inp1Wave). The ZT4xx1 has two input channels and the ZT4xx2 has four input channels. There are four calculate channels and four reference channels.
  • Page 40: Utility Process Variables

    Process Variable Type Values Description CalcNScaledWave waveform -inf to +inf Floating point scaled waveform data in Volts for selected calculate channel CalcNScaledTime waveform -inf to +inf Floating point scaled time (X-axis) waveform data for selected calculate channel RefNWavePoints longin 10 to 32768 The number of actual data points stored in RefNWave, RefNScaledWave and RefNScaledTime.
  • Page 41 Process Variable Type Values Description UtilErrReport stringin command Returns last command to cause an error. string Note: This functionality is only valid for the ZT44xx UtilErr stringin error string Error string explaining current error code UtilTemp 0.0 to 100.0 Internal temperature in degrees C UtilMem longin Varies by...
  • Page 42 Process Variable Type Values Description UtilSelfTest mbbiDire 0000 Initiates an instrument self test and returns the test 0375 results as a 16-bit code. The self test is initiated on instrument power up. Bit 0 = baseboard test failed Bit 1 = unused Bit 2 = ROM test failed Bit 3 = unused Bit 4 = reference oscillator test failed...
  • Page 43 Process Variable Type Values Description UtilSCPISend stringout string Sends the entered SCPI string to the instrument. If sending a query, call UtilSCPIRecv immediately after this. To ensure a proper response from the UtilSCPIRecv, make sure there are no other queries occurring at the same time, whether through another PV’s Scan Rate, or any other instrument interface.
  • Page 44: Status Register Variables

    Status Register Variables The following table lists the PVs associated with the various instrument status registers. For the Digitizer Test Register PVs in the following table, N is substituted with either 1 or 2 (for 4 channel instruments only) (for example: getStatusTestDig1Enable). Process Variable Type Values...
  • Page 45 Process Variable Type Values Description StatusFreq mbbiDirect 0000 Frequency fault status results: FFFF 1 = latched event ZT4610: Bit 0 = sample clock unlocked Bit 1 = unused Bit 2 = memory 1-2 clock unlocked Bit 3 = memory 3-4 clock unlocked (ZT4xx2) Bits 4-6 = unused Bit 7 = baseboard clock unlocked...
  • Page 46 Process Variable Type Values Description setStatusFreqEnable mbboDirect 0000 Frequency register bit enable mask: getStatusFreqEnable mbbiDirect FFFF ZT4610: Bit 0 = sample clock unlocked Bit 1 = unused Bit 2 = memory 1-2 clock unlocked Bit 3 = memory 3-4 clock unlocked (ZT4xx2) Bits 4-6 = unused Bit 7 = baseboard clock unlocked...
  • Page 47 Process Variable Type Values Description StatusFreqCond mbbiDirect 0000 Frequency fault status conditions: FFFF ZT4610: Bit 0 = sample clock unlocked Bit 1 = unused Bit 2 = memory 1-2 clock unlocked Bit 3 = memory 3-4 clock unlocked (ZT4xx2) Bits 4-6 = unused Bit 7 = baseboard clock unlocked Bits 8-15 = unused ZT4400:...
  • Page 48 Process Variable Type Values Description setStatusTestEnable mbboDirect 0000 Test register bit enable mask getStatusTestEnable mbbiDirect FFFF Bit 0 = baseboard register test failed Bit 1 = n/a Bit 2 = baseboard ROM test failed Bit 3 = n/a Bit 4 = reference oscillator test failed Bit 5 = DRAM test failed Bit 6 = flash memory test failed Bit 7 = unused...
  • Page 49 Process Variable Type Values Description setStatusOperEnable mbboDirect 0000 Operation register bit enable mask getStatusOperEnable mbbiDirect FFFF Bit 0 = calibrating Bit 1 = settling Bit 2 = ranging Bit 3 = sweeping Bit 4 = measuring Bit 5 = waiting for trigger Bit 6 = waiting for arm Bit 7 = unused Bit 8 = trigger event...
  • Page 50 Process Variable Type Values Description StatusQues mbbiDirect 0000 Questionable status: FFFF 1 = latched event Bit 0 = voltage fault Bits 1-4 = unused Bit 5 = frequency fault Bits 6-7 = unused Bit 8 = calibration failure Bit 9 = test failure Bits 10-15 = unused setStatusQuesEnable mbboDirect...
  • Page 51 Process Variable Type Values Description StatusVolt mbbiDirect 000 Voltage status faults: 1 = latched event ZT4210: Bit 0 = input 1 overload Bit 1 = input 2 overload Bit 2 = input 3 overload (ZT4xx2) Bit 3 = input 4 overload (ZT4xx2) Bit 4 = input 1-2 overvoltage Bit 5 = unused Bit 6 = input 3-4 overvoltage (ZT4xx2)
  • Page 52 Process Variable Type Values Description setStatusVoltEnable mbboDirect Voltage register bit enable mask getStatusVoltEnable mbbiDirect ZT4210: Bit 0 = input 1 overload Bit 1 = input 2 overload Bit 2 = input 3 overload (ZT4xx2) Bit 3 = input 4 overload (ZT4xx2) Bit 4 = input 1-2 overvoltage Bit 5 = unused Bit 6 = input 3-4 overvoltage (ZT4xx2)
  • Page 53 Process Variable Type Values Description StatusVoltCond mbbiDirect 000 Voltage condition register: ZT4210: Bit 0 = input 1 overload Bit 1 = input 2 overload Bit 2 = input 3 overload (ZT4xx2) Bit 3 = input 4 overload (ZT4xx2) Bit 4 = input 1-2 overvoltage Bit 5 = unused Bit 6 = input 3-4 overvoltage (ZT4xx2) Bit 7 = unused...
  • Page 54 Process Variable Type Values Description StatusCal mbbiDirect 0000 Calibration status results: FFFF 1 = latched event ZT4610: Bit 0 = calibration storage failed Bit 1 = offset zero failed Bit 2 = offset scale failed Bit 3 = null balance failed Bit 4 = gain balance failed Bit 5 = trigger level failed Bits 6-15 = unused...
  • Page 55 Process Variable Type Values Description setStatusCalEnable mbboDirect 0000 Calibration register bit enable mask: getStatusCalEnable mbbiDirect FFFF ZT4610: Bit 0 = calibration storage failed Bit 1 = offset zero failed Bit 2 = offset scale failed Bit 3 = null balance failed Bit 4 = gain balance failed Bit 5 = trigger level failed Bits 6-15 = unused...
  • Page 56 Process Variable Type Values Description StatusCalCond mbbiDirect 0000 Calibration condition register: FFFF ZT4610: Bit 0 = calibration storage failed Bit 1 = offset zero failed Bit 2 = offset scale failed Bit 3 = null balance failed Bit 4 = gain balance failed Bit 5 = trigger level failed Bits 6-15 = unused ZT4400:...
  • Page 57 Process Variable Type Values Description StatusTestDigN mbbiDirect 00 to FF Digitizer status results: Digitizer 1: Bit 0 = register test failed Bit 1 = ROM test failed Bit 2 = sample clock test failed Bit 3 = memory clock test failed Bit 4 = ZT4410 &...
  • Page 58 Process Variable Type Values Description setStatusTestDigNEnable mbboDirect to FF Digitizer register bit enable mask getStatusTestDigNEnable mbbiDirect Digitizer 1: Bit 0 = register test failed Bit 1 = ROM test failed Bit 2 = sample clock test failed Bit 3 = memory clock test failed Bit 4 = ZT4410 &...
  • Page 59 ® ® ZTEC Instruments 0004-000067...

Table of Contents