CM_ESG_E4438C_Sink
Library: Instruments
Parameters
Name |
Description |
Default |
Unit |
Type |
Range |
---|---|---|---|---|---|
Instrument |
instrument to be used in the simulation |
[GPIB0::20::INSTR][localhost][4790] |
|
instrument |
|
Enabled |
When YES communicates with instrument: NO, YES |
YES |
|
enum |
|
Start |
sample number to start waveform recording |
DefaultNumericStart |
|
int |
|
Stop |
sample number to stop waveform recording |
DefaultNumericStop |
|
int |
|
Frequency |
RF output frequency |
3e9 |
Hz |
real |
|
Amplitude |
RF output power level (dBm) |
-135 |
|
real |
|
ARBRef |
reference for the waveform clock: Internal, External |
Internal |
|
enum |
|
ARBRefFreq |
reference frequency of the external clock generator |
10e6 |
Hz |
real |
|
IQModFilter |
baseband filter applied to the IQ signals: through, filter_2100kHz, filter_40MHz |
through |
|
enum |
|
SampleClk |
sample clock rate for sequencer and DAC |
4.9152e6 |
Hz |
real |
|
FileName |
waveform file name |
esg.wfm |
|
filename |
|
DownloadMode |
select mode of operation of the sink: download_to_VARB, write_to_datafile, both |
download_to_VARB |
|
enum |
|
AutoScaling |
scale inputs to range { -1, +1 } before download: NO, YES |
YES |
|
enum |
|
ArbOn |
select waveform and turn ARB ON after download: NO, YES |
NO |
|
enum |
|
RFPowOn |
turn RF power ON after download: NO, YES |
NO |
|
enum |
|
EventMarkers |
enable ESG markers: Neither, Event1, Event2, Both |
Neither |
|
enum |
|
MarkerLength |
select number of points for ESG markers |
10 |
|
int |
|
InstructionTimeout |
Instrument instruction timeout |
300 sec |
sec |
int |
[1,∞) |
Pin Inputs
Pin |
Name |
Description |
Signal Type |
---|---|---|---|
1 |
I |
I input waveform data |
real |
2 |
Q |
Q input waveform data |
real |
Notes/Equations
- The CM_ESG_E4438C_Sink model collects data from a simulation and downloads the data to an E4438C Vector Signal Generator. Parameters specify how data is interpreted by the ESG. This model uses the connection manager architecture to communicate with the instrument. In addition to the E4438C mentioned above, the E8267C (PSG-C), E8267D (PSG-D), and N5182A (MXG) are also supported.
- Prerequisites for using CM_ESG_E4438C_Sink are:
- ESG Vector Signal Generator E4438C; for information, visit the website http://www.keysight.com/find/esg.
- Supported method of connecting the instrument to your computer through the Connection Manager architecture. For detailed setup information, refer to Connection Manager documentation.
- The Instrument parameter specifies a triplet that identifies the specific instrument to be used in the simulation, along with the Connection Manager server information to be used to connect to the instrument.
To interactively select an instrument, refer to Instrument Selection under About Instruments Components.
For more information regarding instrument selection, refer to Discovering Connected Hardware under the section on Getting Started with Connection Manager in the Connection Manager documentation. - The Enabled parameter specifies whether communication with the instrument needs to be established during the simulation. For example, if the sink needs to send a command to the instrument, Enabled should be set to "YES".
- The Start and Stop parameters specify when to start and stop data collection. The number of samples collected, Stop − Start + 1, must be in the range 60 samples to 64 Msamples, where 1 Msample = 1,048,576 samples. The ESG requires an even number of samples; the last sample is discarded if Stop − Start + 1 is odd.
- The ARBRef parameter specifies an internal or external reference for the ESG clock generator. If set to External, the ARBRefFreq parameter sets the frequency of this clock.
- The IQModFilter parameter specifies the cutoff frequency for the reconstruction filter that lies between the DAC output and the Dual Arbitrary Waveform Generator output inside the ESG.
- The SampleClk parameter sets the sample clock rate for the DAC output.
- The FileName parameter sets the name of the file into which data is written. Depending on the DownloadMode parameter, data can be written to the ESG, to a local data file, or both. The same filename is used for both options.
- The DownloadMode parameter specifies the mode of operation of this sink component.
download_to_VARB - The waveform is downloaded to the ESG volatile ARB (VARB) memory.
Use this mode of operation to avoid writing data to the local file system.
write_to_datafile - The waveform is written to a proprietary encrypted binary file format in the data directory of the project. Then the file can be transferred to the SECUREWAVE directory in the ESG file system using an FTP client (select the binary data transfer option during the FTP process). The ESG automatically decrypts the file and makes the file available for selection from the list of waveforms in its NVARB memory.
Use this mode of operation to avoid communication with the ESG instrument during simulation.
Note that, besides data, only the Frequency and SampleClk values are embedded in the file as header information. Other ESG settings (such as Amplitude) must be set manually from the ESG front panel or by using appropriate SCPI commands.
both - download_to_VARB and write_to_datafile options are enabled.Note
When the write_to_datafile option is used to create a datafile in the SignalStudio Wavform Package Library Format, the signal is normalized to the {−1, 1} range. In order to enable the recovery of the signal voltage level, the scaling factor used for normalization
(abs(max(I,Q)))
is embedded in the header of the datafile. When this file is used with the CM_SStudioFileRead component, the embedded scaling factor value is used to restore the signal to its original level. - The ESG driver expects data in the range {−1, 1}. The AutoScaling parameter specifies whether to scale inputs to fit this range.
If AutoScaling = YES, inputs are scaled to the range {−1, 1} and scaling is applied to data written to the local file (refer to note 10).
If AutoScaling = NO, raw simulation data is downloaded to the ESG without any scaling, but data outside the range {−1, 1} is clipped to −1 or 1. - If ArbOn = YES, the ESG starts generating the signal immediately after simulation data is downloaded; if ArbOn = NO, waveform generation must be turned on at the ESG front panel.
- If RFPowOn = YES, the ESG turns on RF power immediately after simulation data is downloaded; if RFPowOn = NO (default), RF power must be turned on at the ESG front panel.
- The EventMarkers parameter specifies which ESG Event markers are enabled: Event1, Event2, Both, or Neither. Event markers are used for synchronizing other instruments to the ESG. When one or both EventMarkers are enabled, Event1 and/or Event2 is set to the first sample of the downloaded Arb waveform. This is equivalent to setting the corresponding event from the front panel of the ESG.
- The MarkerLength parameter specifies the range of points over which the markers must be set starting from the first point of the waveform. Depending on the setting of the EventMarkers parameter, the length of trigger Event1 and/or Event2 is set to a multiple of the pulse-width which, in turn, is determined by the sample clock rate of the DAC output.
- The InstructionTimeout parameter (added for ADS 2008 Update 1 Release) specifies how long the application will wait for an instrument instruction execution to complete before a timeout error is reported This parameter must be at least 1 second. The default value is 300 seconds. The purpose for this parameter is to accomodate different instrument operation complete times, especially the downloading time of lengthy waveforms (tens of Mega-samples) for N5182 (MXG). This parameter will have no impact on performance. The only drawback for specifying a long waiting time, is that if no instrument is present or there is a communication problem between the host computer and the instrument, the SW will appear to hang before reporting a timeout error.
- To access usage examples, from the ADS Main window, choose File > Example Project > Instruments > CM_ESG_prj.
- Note on use of the N5182A (MXG): Use of this instrument in Connected Solutions applications is limited for use with one power point. If swept power is desired for the Connected Solution application, then a special work around is required using SCPI commands. The work around is descibed in a Knowledge Center application note.