Site Master MS2085A/MS2089A Programming Manual : MS2089A Commands : Vector Volt Meter Commands
 
Vector Volt Meter Commands
:FETCh:VVM:DATA?
Title:
Fetch Measurement Data
Description:
Returns the measurement data in comma separated values depending upon the measurement type and the measurement format. If no signal is detected, query returns a blank string.
:FETCh:VVM:TABLe:MEASurement? <ABSolute|RELative>,[<numeric_value>]
Title:
Fetch Measurement Data In The Table
Description:
Returns the absolute or relative data at a specified cable index in the cable table display.
Data must be memorized to that location before it can be returned. If no signal is detected, query returns a blank string.
First parameter is the data type to return.
Second parameter is the optional numerical index of the data location in the table display format. If no value is provided,
the value from the [:SENSe]:VVM:DATA:TABLe:CABLe:SELect command will be used.
Parameter(s):
<ABSolute|RELative>,[<numeric_value>]
:FETCh:VVM:ZERO:REFerence?
Title:
Fetch Zero Reference Data
Description:
Returns the reference data in comma separated values depending upon
the measurement type and the measurement format e.g "0.1, 0.1".
If no reference was saved, query returns a blank string.
:INITiate[:IMMediate]
Title:
Initiate Single Sweep
Description:
Initiates a single sweep/measurement. If [:SENSe]:VVM:AVERage:MODE is set to CONTinuous regardless of
whether :INITiate:VVM:HOLD is ON or OFF, or if [:SENSe]:VVM:AVERage:MODE is set to SINGle but the current sweep has
not completed yet, this command is ignored and will generate an error.
This command is overlapped. It can be used in combination with *OPC? to synchronize the capture of one complete set of data.
When this command is received, the pending operation bit is set. The pending operation will finish
once the sweep/measurement is done. Clients can use *OPC? to 'block' until the sweep/measurement is completed.
:INITiate:VVM:HOLD <0 | 1 | ON | OFF>
:INITiate:VVM:HOLD?
Title:
Set Sweep State
Description:
Command sets the sweep state between run and hold. This command is ignored in external trigger mode. Query returns the sweep state, run or hold. Query returns 1 for hold mode, and returns 0 for run mode.
Parameter(s):
<0 | 1 | ON | OFF>
Query Return:
0 | 1
Default Value:
OFF
:MMEMory:LOAD <string>
Title:
Load Data Files
Description:
Loads a file of the type specified by the filename extension. The parameter must contain the MSUS followed by '/' and file path. MSUS is the mass storage device to store the file to. See MMEMory:CATalog:MSUSs? for information on obtaining the list of available devices. The following is a list of supported file extension: stp: setup file \ (Not available with Secure Data Option)
smvvm : measurement file. For example to save a setup file: MMEMory:STORe "Internal/example_setup_file.stp"
Parameter(s):
<string>
:MMEMory:STORe <string>
Title:
Store Data Files
Description:
Stores a data file of the type specified by the filename extension. The parameter must contain the MSUS followed by '/' and file path. MSUS is the mass storage device to store the file to. See MMEMory:CATalog:MSUSs? for information on obtaining the list of available devices. The following is a list of supported file extension: stp: setup file \ (Not available with Secure Data Option)
smvvm : measurement file. txt : tab-delimited text data file. csv : comma separated text data file. For example to save a setup file: MMEMory:STORe "Internal/example_setup_file.stp"
Parameter(s):
<string>
[:SENSe]:VVM:AVERage:CLEar
Title:
Reset Measurement Averaging
Description:
Clears and restarts averaging of the measurement data.
[:SENSe]:VVM:AVERage:COUNt <numeric_value> | DEFault | MINimum | MAXimum
[:SENSe]:VVM:AVERage:COUNt? [DEFault | MINimum | MAXimum]
Title:
Sweep Averaging Count
Description:
Command sets number of sweeps to be averaged. When number of sweep averaging is set to be greater than 1, averaging is turned on.
Query Return:
Numeric
Set Command Parameter(s):
<numeric_value> | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
Default Value:
1
Range:
1 to 1000
[:SENSe]:VVM:AVERage:MODE <SINGle|CONTinuous>
[:SENSe]:VVM:AVERage:MODE?
Title:
Averaging Mode
Description:
Averaging mode has two values: SINGle and CONTinuous. Each averaging mode will function differently in conjunction with :INITiate[:IMMediate] depending on the RUN/HOLD state as described below:
For SINGle and HOLD - Triggering a measurement update will put the instrument into RUN until the average
count ([:SENSe]:VVM:AVERage:COUNt) is reached, then will automatically go back into HOLD.
For SINGle and RUN - Triggering a measurement update will run until the average count ([:SENSe]:VVM:AVERage:COUNt) is reached,
then will automatically go into HOLD.
For CONTinuous and RUN/HOLD - Triggering a measurement update will result in an error.
Parameter(s):
<SINGle|CONTinuous>
Query Return:
SING|CONT
Default Value:
CONTinuous
[:SENSe]:VVM:CALibration:STATe?
Title:
State of Calibrated Measurements
Description:
Query returns the state of calibrated measurements depending on the calibration collection type. 0 means no calibration was done. For calibration types RFP1 & RRP1, return value is '1'. For calibration types RFP2 & RRP2, return value is '2'. For calibration types TRFP & TRRP, return value is '4'. For calibration types FP2P & RP2P, return value is '5'.
[:SENSe]:VVM:CORRection:COLLect:ABORt
Title:
Abort Calibration
Description:
Aborts all steps of the RF calibration
[:SENSe]:VVM:CORRection:COLLect[:ACQuire] <OPEN|SHORt|LOAD|THRU>,<numeric_value>
Title:
Perform Calibration Step
Description:
Command performs a calibration step with the given two parameters.
For cal step OPEN|SHORt|LOAD|THRU, use port numbers 1 and 2. For cal step THRU, use 1 for forward path, 2 for reverse path.
Please note that port number 2 is unavailable for certain models. Only port number 1 will be accessible for those models.
Parameter(s):
<OPEN|SHORt|LOAD|THRU>,<numeric_value>
[:SENSe]:VVM:CORRection:COLLect:ACQuire:STATus? <OPEN|SHORt|LOAD|THRU>,<numeric_value>
Title:
Calibration Step Status
Description:
Query returns 1 if a specified cal step is completed. Otherwise, query
returns 0. If no query parameters are provided, then the last cal step
status is returned. If no cal was performed, then the query returns 0.
For cal step OPEN|SHORt|LOAD|THRU, use
port numbers 1 and 2. For cal step THRU, use 1 for forward path, 2 for reverse path.
Please note that port number 2 is unavailable for certain models. Only port number 1 will be accessible for those models.
Parameter(s):
<OPEN|SHORt|LOAD|THRU>,<numeric_value>
[:SENSe]:VVM:CORRection:COLLect:CKIT:PORT<n>:CATalog?
Title:
Cal Kit Catalog For The Selected Port
Description:
Query returns the available calibration kits for the selected port. The available ports depend on the calibration collection type.
Please note that PORT2 is unavailable for certain models. Only PORT1 will be accessible for those models.
PORT Suffix Range:
1-2, Default = 1
Default Value:
OSLN50,OSLN50-1,OSLN50A-8,OSLN50A-18,TOSLN50A-8,TOSLN50A-18,22N50,22N75,26N50,26N75
[:SENSe]:VVM:CORRection:COLLect:CKIT:PORT<n>:INFormation?
Title:
Calibration Kit Data
Description:
Query returns the calibration kit data as a comma-delimited string with description-value pairs for the selected port.
The available ports depend on the calibration collection type and the model.
Please note that PORT2 is unavailable for certain models. Only PORT1 will be accessible for those models.
PORT Suffix Range:
1-2, Default = 1
[:SENSe]:VVM:CORRection:COLLect:CKIT:PORT<n>[:SELect] <string>
[:SENSe]:VVM:CORRection:COLLect:CKIT:PORT<n>[:SELect]?
Title:
Set Calibration Kit
Description:
Command sets the calibration kit for the selected port. The available ports depend on the calibration collection type and the model.
Please note that PORT2 is unavailable for certain models. Only PORT1 will be accessible for those model.for those models.
Before setting the calibration kit, make sure the device is set to the appropriate connector type (refer [:SENSe]:VVM:CORRection:COLLect:PORT:CONNector).
A mismatch between the connector type and the given calibration kit will result in a command error.
Parameter(s):
<string>
PORT Suffix Range:
1-2, Default = 1
Default Value:
OSLN50
[:SENSe]:VVM:CORRection:COLLect:INFormation?
Title:
Calibration Information
Description:
This command returns information about the current and active calibration settings. The response is formatted as a nested JSON array of name and value pairs. Following is an example of the response: [ {"CurrentSettings":[ {"name":"Date","value":"30 Sep 2020"}, {"name":"Time","value":"14:51:29"}, {"name":"Internal Temperature","value":"60.78 C / 141.404 F"}, {"name":"Valid Cal Window","value":"--"}, {"name":"Cal Status","value":"--"}, {"name":"Cal Type","value":"Full Reflection - S11"}, {"name":"Cal Method","value":"SOLT"}, {"name":"Cal Line Type","value":"Coax"}, {"name":"Cal Kit Port 1","value":"OSLK50"}, {"name":"Cal Kit Port 2","value":"OSLK50"}, {"name":"CW Frequency","value":"0.03 MHz"}, {"name":"IFBW","value":"0.001 MHz"}, {"name":"Source Power Level Port 1","value":"0 dBm"}, {"name":"Source Power Level Port 2","value":"0 dBm"}, {"ActiveCalSettings":[ {"name":"Date","value":"--"}, {"name":"Time","value":"--"}, {"name":"Internal Temperature","value":"--"}, {"name":"Valid Cal Window","value":"--"}, {"name":"Cal Status","value":"--"}, {"name":"Cal Type","value":"--"}, {"name":"Cal Method","value":"--}, {"name":"Cal Line Type","value":"--"}, {"name":"Cal Kit Port 1","value":"--"}, {"name":"Cal Kit Port 2","value":"--"}, {"name":"CW Frequency","value":"--"}, {"name":"IFBW","value":"--"}, {"name":"Source Power Level Port 1","value":"--"}, {"name":"Source Power Level Port 2","value":"--"}, ] For settings that are not available, the value will be "--".
[:SENSe]:VVM:CORRection:COLLect:INFormation:FACTory:INFormation?
Title:
Factory Calibration Header Query
Description:
This command returns the factory calibration header information as ASCII of JSON array with the following information:
[ {"CalibrationInfo":[ {"name":"Date","value":"30 Sep 2020"}, {"name":"Time","value":"14:51:29"}, {"name":"Internal Temperature","value":"60.78 C / 141.404 F"}]}, ]\
[:SENSe]:VVM:CORRection:COLLect:INFO:STATus?
Title:
Calibration Status
Description:
Query returns 0 if calibration is not in progress 1 if calibration is in progress 2 if calibration was aborted 3 if cal-coefficients are being calculated 4 if calibration has completed.
[:SENSe]:VVM:CORRection:COLLect:INITialize
Title:
Reset Calibration Step
Description:
This command resets the calibration steps for the selected cal type. The command must be issued at the start of a user calibration prior to issuing the component data acquisition commands. Issuing this command will also abort the thru update. See also :SENSe:CORRection:COLLect:ACQuire:DATA?
[:SENSe]:VVM:CORRection:COLLect:LOAD
Title:
Calibration Load Step
Description:
Perform 'Load' step of calibration.
[:SENSe]:VVM:CORRection:COLLect:OPEN
Title:
Calibration Open Step
Description:
Perform 'Open' step of calibration.
[:SENSe]:VVM:CORRection:COLLect:PORT<n>:CONNector:CATalog?
Title:
Connector Catalog
Description:
Command returns a string containing every accepted connector type.
Please note that PORT2 is unavailable for certain models. Only PORT1 will be accessible for those models.
PORT Suffix Range:
1-2, Default = 1
[:SENSe]:VVM:CORRection:COLLect:PORT<n>:DCONnector <MK|MN|MC|M716|MS|MV|M4P310|FK|FN|FC|F716|FS|FV|F4P310>
[:SENSe]:VVM:CORRection:COLLect:PORT<n>:DCONnector?
Title:
DUT Connector Type
Description:
Sets or queries the DUT connector type for the indicated port. The available connector types varies by the current Cal Method and Line Type setup. A list of available connector types can be retrieved using the command :SENSe:VVM:CORRection:COLLect:CONNector:CATalog? The DUT connector type is the opposite gender of the port connector type that sets or queries using :SENSe:VVM:CORRection:COLLect:PORT:CONNector. Available connector types are: Connector Type Description MK K(male) MN N(male) MV V(male) MS SMA(male) MC TNC(male) M716 716(male) M4P310 4.3-10(male) FK K(female) FN N(female) FV V(female) FS SMA(female) FC TNC(female) F716 716(female) F4P310 4.3-10(female) Please note that PORT2 is unavailable for certain models. Only PORT1 will be accessible for those models.
Parameter(s):
<MK|MN|MC|M716|MS|MV|M4P310|FK|FN|FC|F716|FS|FV|F4P310>
Query Return:
MK|MN|MC|M716|MS|MV|M4P310|FK|FN|FC|F716|FS|FV|F4P310
PORT Suffix Range:
1-2, Default = 1
Default Value:
MN
[:SENSe]:VVM:CORRection:COLLect:SAVE
Title:
Perform Calibration
Description:
Complete an RF Cal and perform coefficient calculation.
[:SENSe]:VVM:CORRection:COLLect:SHORt
Title:
Calibration Short Step
Description:
Perform 'Short' step of calibration.
[:SENSe]:VVM:CORRection:COLLect:TUPDate
Title:
Setup For Thru Update
Description:
This command allows for a thru calibration step to be re-performed.
It only applies for calibrations with thru steps and applies only if that supporting calibration is currently enabled. The cal step information will be updated to be that of the thru calibration step.
[:SENSe]:VVM:CORRection:COLLect:TYPE <RFP1|RRP1|TRFP|FP2P>
[:SENSe]:VVM:CORRection:COLLect:TYPE?
Title:
Calibration Collection Type
Description:
Sets and queries the calibration collection type.
Parameter(s):
<RFP1|RRP1|TRFP|FP2P>
Query Return:
RFP1|RRP1|TRFP|FP2P
Default Value:
RFP1
[:SENSe]:VVM:CORRection:COLLect:TYPE:ACTive?
Title:
Active Calibration Type
Description:
Gets the current active calibration type. Please refer to the command :SENSe:VVM:CORRection:COLLect:TYPE for a description of the available calibration type. Note that this command will return 'NONE' if no calibration is currently active.
Query Return:
RFP1|FP2P|RRP1|TRFP|RFP2|RP2P|RRP2|TRRP|NONE
Default Value:
NONE
[:SENSe]:VVM:CORRection[:STATe] <0 | 1 | ON | OFF>
[:SENSe]:VVM:CORRection[:STATe]?
Title:
Calibration Correction State
Description:
Sets calibration correction state. Query returns 1 if RF cal is on. Otherwise, it returns 0.
Parameter(s):
<0 | 1 | ON | OFF>
Query Return:
0 | 1
Default Value:
OFF
[:SENSe]:VVM:DISPlay:FORMat <CW|TABLe>
[:SENSe]:VVM:DISPlay:FORMat?
Title:
Display Format
Description:
Sets and queries the VVM display format.
Parameter(s):
<CW|TABLe>
Query Return:
CW|TABL
Default Value:
CW
[:SENSe]:VVM:DISPlay:RESolution <ONEDigit|TWODigit>
[:SENSe]:VVM:DISPlay:RESolution?
Title:
Display Resolution
Description:
Sets and queries the display resolution.
Parameter(s):
<ONEDigit|TWODigit>
Query Return:
ONED|TWOD
Default Value:
ONEDigit
[:SENSe]:VVM:FORMat <LMP|LNMP|VSWR|IMPedance>
[:SENSe]:VVM:FORMat?
Title:
Measurement Format
Description:
Sets and queries the VVM measurement format of the active measurement. Note that certain measurement format will be unavailable base on the measurement type set.
Parameter(s):
<LMP|LNMP|VSWR|IMPedance>
Query Return:
LMP|LNMP|VSWR|IMP
Default Value:
LMP
[:SENSe]:VVM:FREQuency:CW <numeric_value> {HZ | KHZ | MHZ | GHZ} | DEFault | MINimum | MAXimum
[:SENSe]:VVM:FREQuency:CW? [DEFault | MINimum | MAXimum]
Title:
Center Frequency
Description:
Sets and queries the center frequency.
Query Return:
Numeric (Hz)
Set Command Parameter(s):
<numeric_value> {HZ | KHZ | MHZ | GHZ} | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
Default Value:
100000000 Hz
Default Unit:
Hz
Range:
5000 Hz to 6000000000 Hz
[:SENSe]:VVM:IMPedance <numeric_value> | DEFault | MINimum | MAXimum
[:SENSe]:VVM:IMPedance? [DEFault | MINimum | MAXimum]
Title:
Reference Impedance
Description:
Command sets the reference impedance in Ohms. Query returns the reference impedance in Ohms.
Query Return:
Numeric
Set Command Parameter(s):
<numeric_value> | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
Default Value:
50
Range:
50 to 75
[:SENSe]:VVM:MEASurement:TYPE <P1T|P1R|A/B|B/A|A|B>
[:SENSe]:VVM:MEASurement:TYPE?
Title:
Measurement Type
Description:
Sets and queries the VVM active measurement type.
Parameter(s):
<P1T|P1R|A/B|B/A|A|B>
Query Return:
P1T|P1R|A/B|B/A|A|B
Default Value:
P1R
[:SENSe]:VVM:PORT<n>:RFON[:STATe] <0 | 1 | ON | OFF>
[:SENSe]:VVM:PORT<n>:RFON[:STATe]?
Title:
RF Power Output State
Description:
Command sets and queries the RF power output state of the indicated port.
Please note that PORT2 is unavailable for certain models. Only PORT1 will be accessible for those models.
Parameter(s):
<0 | 1 | ON | OFF>
Query Return:
0 | 1
PORT Suffix Range:
1-2, Default = 1
Default Value:
OFF
[:SENSe]:VVM:SWEep:IFBW <numeric_value> {HZ | KHZ | MHZ | GHZ} | DEFault | MINimum | MAXimum
[:SENSe]:VVM:SWEep:IFBW? [DEFault | MINimum | MAXimum]
Title:
IF Bandwidth
Description:
Sets and queries the IF bandwidth.
Query Return:
Numeric (Hz)
Set Command Parameter(s):
<numeric_value> {HZ | KHZ | MHZ | GHZ} | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
Default Value:
10 Hz
Default Unit:
Hz
Range:
10 Hz to 100000 Hz
[:SENSe]:VVM:TABLe:CABLe:NAME <string>,[<numeric_value>]
[:SENSe]:VVM:TABLe:CABLe:NAME? [<numeric_value>]
Title:
Cable Name
Description:
Sets or queries the cable name at a particular index of the cable table display.
The set command takes in one required parameter and one optional parameter.
The required first paramter is the cable name to set, and the optional second parameter
is the index of the cable in the table display to set. If the second paramter is not given,
the value from the [:SENSe]:VVM:DATA:TABLe:CABLe:SELect command will be used.
The query command takes in one optional parameter. The optional parameter is the
index of the cable in the table display to set. If the second paramter is not given,
the value from the [:SENSe]:VVM:DATA:TABLe:CABLe:SELect command will be used.
Set Command Parameter(s):
<string>,[<numeric_value>]
Query Command Parameter(s):
[<numeric_value>]
[:SENSe]:VVM:TABLe:CABLe:SELect <numeric_value> | DEFault | MINimum | MAXimum
[:SENSe]:VVM:TABLe:CABLe:SELect? [DEFault | MINimum | MAXimum]
Title:
Selected Table Index
Description:
Sets the selected index for the cable table display. Note that saving a measurement to the table will cause the selected index to automatically increment to the next open slot in the table starting from the slot that had just been saved. If there are no empty slots left in the table, the selected index will be kept at the index that was last saved.
Query Return:
Numeric
Set Command Parameter(s):
<numeric_value> | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
Default Value:
1
Range:
1 to 100
[:SENSe]:VVM:TABLe:CLEar [<numeric_value>]
Title:
Clear Measurement Data At Location
Description:
Clear the data at a specified cable index for the currently chosen measurement type in the cable table display.
Accepts an optional numeric parameter dictating the index of the table display to clear the data at.
If no value is provided, the value from the [:SENSe]:VVM:DATA:TABLe:CABLe:SELect command will be used.
Parameter(s):
[<numeric_value>]
[:SENSe]:VVM:TABLe:CLEar:SELected
Title:
Clear Measurement Data Table
Description:
Clears the table data for the selected measurement type.
[:SENSe]:VVM:TABLe:MEMorize [<numeric_value>]
Title:
Memorize Measurement Data At Location
Description:
Memorize the data at a specified cable index for the currently chosen measurement type in the cable table display.
Accepts an optional numeric parameter dictating the index of the table display to memorize the data to.
If no value is provided, the value from the [:SENSe]:VVM:DATA:TABLe:CABLe:SELect command will be used.
Note that saving a measurement to the table will cause the selected index to automatically
increment to the next open slot in the table starting from the slot that had just been saved.
If there are no empty slots left in the table, the selected index will be kept at the index that was last saved.
Parameter(s):
[<numeric_value>]
[:SENSe]:VVM:ZERO:REFerence:CLEar
Title:
Clear Zero Reference Data
Description:
Clear the zero reference data for the current measurement. Turns off Zero Reference state.
[:SENSe]:VVM:ZERO:REFerence:SET
Title:
Set Zero Reference Data
Description:
Sets the zero reference data for the current measurement type. Turns on Zero Reference state.
[:SENSe]:VVM:ZERO:REFerence:TYPE <OPEN|SHORt>
[:SENSe]:VVM:ZERO:REFerence:TYPE?
Title:
Zero Reference Type
Description:
Sets or queries the Zero Referencing type.
Parameter(s):
<OPEN|SHORt>
Query Return:
OPEN|SHOR
Default Value:
OPEN
:SOURce:VVM:POWer <LOW|HIGH>
:SOURce:VVM:POWer?
Title:
Source Power Level
Description:
Sets and queries the source power level.
Parameter(s):
<LOW|HIGH>
Query Return:
LOW|HIGH
Default Value:
HIGH
:SOURce:VVM:POWer:MODE <HILow|DISCrete>
:SOURce:VVM:POWer:MODE?
Title:
Level Mode
Description:
Sets and queries the level mode. When level mode is set to HILow, only the :SOURce:VVM:POWer command will be avaiable for setting the power level and [:SOURce]:VVM:POWer:PORT{[1]|2}[:LEVel] will be disabled. When level mode is set to DISCrete, only [:SOURce]:VVM:POWer:PORT{[1]|2}[:LEVel] will be available to set the power level and :SOURce:VVM:POWer will be disabled.
Parameter(s):
<HILow|DISCrete>
Query Return:
HIL|DISC
Default Value:
HILow
[:SOURce]:VVM:POWer:PORT<n>[:LEVel] <numeric_value> {DBM} | DEFault | MINimum | MAXimum
[:SOURce]:VVM:POWer:PORT<n>[:LEVel]? [DEFault | MINimum | MAXimum]
Title:
Power Level
Description:
Sets or queries the power level of the indicated port.
Please note that PORT2 is unavailable for certain models. Only PORT1 will be accessible for those models.
 
Query Return:
Numeric (DBM)
Set Command Parameter(s):
<numeric_value> {DBM} | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
PORT Suffix Range:
1-2, Default = 1
Default Value:
0 dBm
Default Unit:
dBm
Range:
-45 dBm to 10 dBm
2025-03-10T09:08:38PM