RF General Settings SCPI Command Reference

SCPI command reference for RF General Settings and Mandatory commands.

*CAL


        Usage:
        *CAL?
Query Response:
        <CalibrationResult>
      

Description

Performs an internal partial self-calibration on all RF chains. Self-calibration may take up to 10 minutes per chain.
Partial self-calibration results are saved in the Instrument session and therefore are lost upon reboot.
During execution, the instrument is unresponsive in all virtual instruments. Extend the Visa timeout before sending this command to ensure receiving a response from the command when it has completed.

Availability

Query

Execution Mode

Sequential
Parameter: <CalibrationResult>

Description

Result of the performed self-calibration.
            0 : Self-calibration has completed without errors.
            -1: Self-calibration resulted in an error.

Datatype

Enumeration

*CLS


        Usage:
        *CLS
      

Description

Clear Status

This command clears all status data structures in the device. these registers are:

* Standard Event Service Register
* Operation Status Event Register
* Questionable Status Event Register
* Error/Event Queue

Availability

Command

Execution Mode

Sequential

*ESE


        Usage:
        *ESE[?] <RegisterValue>
Query Response:
        <RegisterValue>
      

Description

Standard Event Status Enable Register

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <RegisterValue>

Default Value

0

Range

[0:255]

*ESR


        Usage:
        *ESR?
Query Response:
        <RegisterValue>
      

Description

Standard Event Status Register Query

Availability

Query

Execution Mode

Sequential
Parameter: <RegisterValue>

*IDN


        Usage:
        *IDN?
Query Response:
        <InstrumentVendor>,<InstrumentModel>,<InstrumentSerial>,<InstrumentFirmwareRevision>
      

Description

Instrument Identification

Availability

Query

Execution Mode

Sequential
Parameter: <InstrumentVendor>
Parameter: <InstrumentModel>
Parameter: <InstrumentSerial>
Parameter: <InstrumentFirmwareRevision>

*OPC


        Usage:
        *OPC[?]
Query Response:
        
      

Description

Operation Complete Command

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential

*OPT


        Usage:
        *OPT?
Query Response:
        <Option_1>,<Avaliable_1>{,<Option_n>,<Avaliable_n>}
      

Description

Returns all the options that the instrument can have and the status of them.

Availability

Query

Execution Mode

Sequential
Parameter: <Option>

Description

Instrument option.

Datatype

String
Parameter: <Avaliable>

Description

0 : The specified option is currently not available in the instrument.
1 : The specified option is currently available in the instrument.

Datatype

Boolean

*RST


        Usage:
        *RST
      

Description

Reset Instrument

Availability

Command

Execution Mode

Sequential

*SRE


        Usage:
        *SRE[?] <RegisterValue>
Query Response:
        <RegisterValue>
      

Description

Service Request Enable Register

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <RegisterValue>

Default Value

0

Range

[0:255]

*STB


        Usage:
        *STB?
Query Response:
        <RegisterValue>
      

Description

Status Byte Register

Availability

Query

Execution Mode

Sequential
Parameter: <RegisterValue>

*TES


        Usage:
        *TES?
Query Response:
        <SelfTestResult>
      

Description

Exeute device selftest. This command has the functionality of *TST and will be renamed to that in a later release.

Availability

Query

Execution Mode

Sequential
Parameter: <SelfTestResult>

Description

Number returned indicates which selftests failed. 0 is the result of a passed test.
            1 : Internal looptest failed.
            2 : Internal Broadcast looptest failed.

Datatype

Integer32

*TST


        Usage:
        *TST?
Query Response:
        <TestResult>
      

Description

Executes the internal Self-Test(s).
WTS-IS uses in this instrument version the *TES command instead

Availability

Query

Execution Mode

Sequential
Parameter: <TestResult>

*WAI


        Usage:
        *WAI
      

Description

Wait-to-Continue Command

Makes Instrument wait until all pending operations are completed before executing commands following *WAI command.

Availability

Command

Execution Mode

Sequential

CALibration:RF:AUTOmatic:TEMPerature


        Usage:
        CALibration:RF:AUTOmatic:TEMPerature[?] <TemperatureChange>
Query Response:
        <TemperatureChange>
      

Description

Specifies the temperature drift value for which the AutoCalibration takes effect.

Availability

Command/Query

Execution Mode

Command: Overlapped
Query: Overlapped
Parameter: <TemperatureChange>

Description

Calibration executes only if the current instrument temperature exceeds the temperature at previous calibration by a value greater or equal to the value specified by this parameter.

Datatype

Double

Default Value

2.00

Range

[0.00:Inf]

Unit

C

CALibration:RF:AUTOmatic:TIME


        Usage:
        CALibration:RF:AUTOmatic:TIME[?] <TimeRange>
Query Response:
        <TimeRange>
      

Description

Specifies the time interval value for which AutoCalibration takes effect.

Availability

Command/Query

Execution Mode

Command: Overlapped
Query: Overlapped
Parameter: <TimeRange>

Description

Maximum allowed time interval, in hours, between internal self-calibration executions. Self-calibration executes if the time since the last self-calibration exceeds the value specified by this parameter. The value of this parameter does not change when *RST is called.

Datatype

Integer32

Default Value

24

Range

[0:2147483647]

CALibration:RF:FULL


        Usage:
        CALibration:RF:FULL
      

Description

Performs an internal self-calibration on all RF chains. Self-calibration may take up to 10 minutes per chain. The self-calibration data of each chain is stored on the nonvolatile memory of the module. If the chain has External LO, an extra LO alignment is performed.
After completion of this command a *RST is REQUIRED in all running Virtual Instruments.
During execution, the instrument is unresponsive in all virtual instruments. Send *OPC? to the instrument to query when it has concluded the calibration. The expected return is 1 or Visa timeout. Extend the Visa timeout to reduce the number of *OPC? sent.

Availability

Command

Execution Mode

Sequential

CALibration:RF:INITiate


        Usage:
        CALibration:RF:INITiate <TargetPortName>
      

Description

Conditionally initiates internal partial self-calibration of hardware associated with the <TargetPortName>. Calibration only executes if the temperature drift or elapsed time since last calibration exceeds a specified value. The same physical hardware may be used on several ports, so the actual hardware may have been calibrated by execution of calibration on another port.
To execute all ports, leave the parameter blank. Calibration can take up to 10 minutes per chain.
Partial self-calibration results are saved in the Instrument session and therefore are lost upon reboot.
During execution, the instrument is unresponsive in all virtual instruments. Send *OPC? to the instrument to query when it has concluded the calibration. The expected return is 1 or visa timeout. Extend the Visa timeout to reduce the number of *OPC? sent.

Availability

Command

Execution Mode

Sequential
Parameter: <TargetPortName>

Description

Name of the port on which to initiate calibration.

Datatype

String

Default Value

""

CALibration:RF:LATest[:INTernal]


        Usage:
        CALibration:RF:LATest[:INTernal]?
Query Response:
        <LastCalibrationInfo[n]>
      

Description

Returns the time and RF hardware temperature of the last executed internal calibration.

Availability

Query

Execution Mode

Sequential
Parameter: <LastCalibrationInfo[n]>

CALibration:RF:LATest:ADJustment


        Usage:
        CALibration:RF:LATest:ADJustment?
Query Response:
        <AdjustmentDateTime>
      

Description

Returns the time that the instrument was last adjusted.

Availability

Query

Execution Mode

Sequential
Parameter: <AdjustmentDateTime>

CALibration:RF:LATest:CERTification


        Usage:
        CALibration:RF:LATest:CERTification?
Query Response:
        <CertificationDateTime>
      

Description

Returns the time when instrument performance was evaluated in a calibration lab.

Availability

Query

Execution Mode

Sequential
Parameter: <CertificationDateTime>

CALibration:RF:NEEDed


        Usage:
Command:
        
Query:
        CALibration:RF:NEEDed? <PortName>
Query Response:
        <IsCalibrationNeeded>
      

Description

Returns if the specified port needs to be calibrated.
Example: CALibration:RF:NEEDed? 'PORT0'

Availability

Query

Execution Mode

Sequential
Parameter: <PortName>

Description

Name of the physical port to query calibration status for.

Datatype

String
Parameter: <IsCalibrationNeeded>

Description

Returns the status of the calibration of the chain used on the given port.
0 : Calibration is not currently needed.
1: Calibration is needed.

Datatype

Boolean

DEBug:VISA[:ENABle]


        Usage:
        DEBug:VISA[:ENABle]
      

Description

Availability

Command

Execution Mode

Overlapped

INSTrument:FACTory:DATE


        Usage:
        INSTrument:FACTory:DATE?
Query Response:
        <FactoryDateTime>
      

Description

Returns the factory date and time.

Availability

Query

Execution Mode

Sequential
Parameter: <FactoryDateTime>

MEMory:CATalog:TABLe


        Usage:
        MEMory:CATalog:TABLe?
Query Response:
        <BytesAvailable>,<BytesUsed>,<Table[n]>
      

Description

Queries for defined tables in memory.

Availability

Query

Execution Mode

Overlapped
Parameter: <BytesAvailable>

Description

Number of bytes available for table creation.

Datatype

Double
Parameter: <BytesUsed>

Description

Number of bytes used by tables.

Datatype

Double
Parameter: <Table[n]>

Description

List of table names currently defined in memory.

Datatype

String

MEMory:TABLe:DEFine


        Usage:
        MEMory:TABLe:DEFine <TableName>,<NumberOfPoints>
      

Description

Defines a new table in memory and specifies the table size, in points.

Availability

Command

Execution Mode

Sequential
Parameter: <TableName>

Description

Name of the table to create.

Datatype

String

Default Value

"AttTable"
Parameter: <NumberOfPoints>

Description

Number of points (frequency, attenuation, power) in the table. All entries in the table initialize with '0.00'.

Datatype

Integer32

Default Value

1

Range

[1:2147483647]

MEMory:TABLe:DELete[:NAME]


        Usage:
        MEMory:TABLe:DELete[:NAME] <TableName>
      

Description

Deletes a specified table from memory.

Availability

Command

Execution Mode

Overlapped
Parameter: <TableName>

Description

Name of the table to delete.

Datatype

String

Default Value

""

MEMory:TABLe:DELete:ALL


        Usage:
        MEMory:TABLe:DELete:ALL
      

Description

Deletes all tables defined in memory.

Availability

Command

Execution Mode

Overlapped

MEMory:TABLe:FREQuency


        Usage:
Command:
        MEMory:TABLe:FREQuency <TableName>,<FrequencyList[n]>
Query:
        MEMory:TABLe:FREQuency? <TableName>
Query Response:
        <FrequencyList[n]>
      

Description

Specifies the frequency values of the table.

Availability

Command/Query

Execution Mode

Command: Overlapped
Query: Sequential
Parameter: <TableName>

Description

Name of the table to access.

Datatype

String

Default Value

AttTable
Parameter: <FrequencyList[n]>

Description

List containing the frequency values. The size of the list must match the currently defined number of points for the table.
The order of the list should follow the order of the corresponding loss and power magnitude lists.

Datatype

String

Default Value

0

Unit

Hz

MEMory:TABLe:LOSS[:MAGNitude]


        Usage:
Command:
        MEMory:TABLe:LOSS[:MAGNitude] <TableName>,<AttenuationList[n]>
Query:
        MEMory:TABLe:LOSS[:MAGNitude]? <TableName>
Query Response:
        <AttenuationList[n]>
      

Description

Specifies the attenuation values of the table.

Availability

Command/Query

Execution Mode

Command: Overlapped
Query: Sequential
Parameter: <TableName>

Description

Name of the table to access.

Datatype

String

Default Value

AttTable
Parameter: <AttenuationList[n]>

Description

List containing the loss magnitude (attenuation) values. The size of the list must match the currently defined number of points for the table.
The order of the list should follow the order of the corresponding frequency and power magnitude lists.

Datatype

String

Default Value

AttTable

Unit

dB

MEMory:TABLe:POINts


        Usage:
Command:
        MEMory:TABLe:POINts <TableName>,<NumberOfPoints>
Query:
        MEMory:TABLe:POINts? <TableName>
Query Response:
        <NumberOfPoints>
      

Description

Specifies or changes the number of points in a given table. The currently defined values in the table are preserved for the length of the list. If the new list size is longer, new entries are created and initialized with '0.00'. If the new list size is shorter, the exceeding values are discarded.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <TableName>

Description

Name of the table to access.

Datatype

String

Default Value

AttTable
Parameter: <NumberOfPoints>

Description

Number of points (frequency, attenuation, power) defined for the table.

Datatype

Integer32

Default Value

1

MMEMory:DELete


        Usage:
        MMEMory:DELete <FileName>
      

Description

Removes a file from the specified mass storage device.

Availability

Command

Execution Mode

Overlapped
Parameter: <FileName>

Description

Name of the file to delete.

Datatype

String

Default Value

""

MMEMory:LOAD:TABLe


        Usage:
        MMEMory:LOAD:TABLe <TableName>,<FileName>
      

Description

Loads a specified table from a given file into memory. The file must contain the specified table.

Availability

Command

Execution Mode

Sequential
Parameter: <TableName>

Description

Name of the table to load.

Datatype

String

Default Value

""
Parameter: <FileName>

Description

Name of the file from which to load the table.

Datatype

String

Default Value

""

MMEMory:STORe:TABLe


        Usage:
        MMEMory:STORe:TABLe <TableName>,<FileName>
      

Description

Stores in memory a specified table from a given file.

Availability

Command

Execution Mode

Overlapped
Parameter: <TableName>

Description

Name of the table to store.

Datatype

String

Default Value

""
Parameter: <FileName>

Description

Name of the file to which to store the table.

Datatype

String

Default Value

""

ROUTe:RF:PORT:CATalog


        Usage:
        ROUTe:RF:PORT:CATalog?
Query Response:
        <LogicalPortName_1>,<PortType_1>{,<LogicalPortName_n>,<PortType_n>}
      

Description

Queries for a list of currently defined port names.

Availability

Query

Execution Mode

Overlapped
Parameter: <LogicalPortName>

Description

List of currently defined port names.

Datatype

String
Parameter: <PortType>

Description

Type of port (RFSA or RFSG).

Datatype

String

ROUTe:RF:PORT:DEFine


        Usage:
Command:
        ROUTe:RF:PORT:DEFine <LogicalPortname>,<PhysicalPort>
Query:
        ROUTe:RF:PORT:DEFine? <LogicalPortname>
Query Response:
        <PhysicalPort>
      

Description

Assigns a user-specified logical port name to a given physical port. Use logical port names to associate correction tables to ports, which improves descriptions of system connections and signal paths. Logical port definitions are not stored permanently and are deleted after an instrument restart.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <LogicalPortname>

Description

Name of the logical port.

Datatype

String

Default Value

none
Parameter: <PhysicalPort>

Description

Physical port for which the logical port is connected.

Datatype

String

Default Value

none

ROUTe:RF:PORT:DELete[:NAME]


        Usage:
        ROUTe:RF:PORT:DELete[:NAME] <LogicalPortName>
      

Description

Deletes a specified logical port name binding. This command deletes both RFSA and RFSG port names.

Availability

Command

Execution Mode

Overlapped
Parameter: <LogicalPortName>

Description

Logical port name to delete.

Datatype

String

Default Value

""

ROUTe:RF:PORT:DELete:ALL


        Usage:
        ROUTe:RF:PORT:DELete:ALL
      

Description

Deletes all user-defined port name bindings, and frees all names created by the PORT command. This command deletes both RFSA and RFSG port names.

Availability

Command

Execution Mode

Overlapped

ROUTe:RF:PORT:LOSS[:MAGNitude][:POINt]


        Usage:
Command:
        
Query:
        ROUTe:RF:PORT:LOSS[:MAGNitude][:POINt]? <PortName>,<Frequency>
Query Response:
        <PathlossSA>,<PathlossSG>
      

Description

Returns the pathloss for a logical RF port at the specified frequency.
ROUTe:RF:PORT:LOSS:[MAGNitude]:[POINt] <PortName>, <Frequency>

Availability

Query

Execution Mode

Sequential
Parameter: <PortName>

Description

Logical port name.

Datatype

String
Parameter: <Frequency>

Description

Frequency at which the pathloss is returned.

Datatype

Double
Parameter: <PathlossSA>

Description

The pathloss of the SA in dB.

Datatype

Double
Parameter: <PathlossSG>

Description

The pathloss of the SG in dB.

Datatype

Double

ROUTe:RFSA:PORT:CATalog


        Usage:
        ROUTe:RFSA:PORT:CATalog?
Query Response:
        <PortNames[n]>
      

Description

Queries for a list of the currently defined RFSA port names.

Availability

Query

Execution Mode

Overlapped
Parameter: <PortNames[n]>

Description

List of port names currently defined for RFSA.

Datatype

String

ROUTe:RFSA:PORT:DEFine


        Usage:
Command:
        ROUTe:RFSA:PORT:DEFine <LogicalPortname>,<PhysicalPort>
Query:
        ROUTe:RFSA:PORT:DEFine? <LogicalPortname>
Query Response:
        <PhysicalPort>
      

Description

Assigns a user-specified logical port name to a given physical RFSA port. Use logical port names to associate correction tables to ports, which improves descriptions of system connections and signal paths.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <LogicalPortname>

Description

Name of the logical port.

Datatype

String

Default Value

none
Parameter: <PhysicalPort>

Description

Physical port for which the logical port is connected.

Datatype

String

Default Value

none

ROUTe:RFSA:PORT:DELete[:NAME]


        Usage:
        ROUTe:RFSA:PORT:DELete[:NAME] <LogicalPortName>
      

Description

Deletes a specified RFSA port name binding.

Availability

Command

Execution Mode

Overlapped
Parameter: <LogicalPortName>

Description

Logical RFSA port name to delete.

Datatype

String

Default Value

""

ROUTe:RFSA:PORT:DELete:ALL


        Usage:
        ROUTe:RFSA:PORT:DELete:ALL
      

Description

Deletes all user-defined port name bindings for any RFSA port, and frees all names created by the PORT command.

Availability

Command

Execution Mode

Overlapped

ROUTe:RFSA:PORT:LOSS[:MAGNitude][:POINt]


        Usage:
Command:
        
Query:
        ROUTe:RFSA:PORT:LOSS[:MAGNitude][:POINt]? <PortName>,<Frequency>
Query Response:
        <PathlossSA>
      

Description

Returns the pathloss for a logical RFSA port at the specified frequency.
ROUTe:RFSA:PORT:LOSS:[MAGNitude]:[POINt] <PortName>, <Frequency>

Availability

Query

Execution Mode

Sequential
Parameter: <PortName>

Description

Logical port name.

Datatype

String
Parameter: <Frequency>

Description

Frequency at which the pathloss is returned.

Datatype

Double
Parameter: <PathlossSA>

Description

The pathloss of the SA in dB.

Datatype

Double

ROUTe:RFSG:PORT:CATalog


        Usage:
        ROUTe:RFSG:PORT:CATalog?
Query Response:
        <PortNames[n]>
      

Description

Queries for a list of the currently defined RFSG port names.

Availability

Query

Execution Mode

Overlapped
Parameter: <PortNames[n]>

Description

List of port names currently defined for RFSG.

Datatype

String

ROUTe:RFSG:PORT:DEFine


        Usage:
Command:
        ROUTe:RFSG:PORT:DEFine <LogicalPortname>,<PhysicalPort>
Query:
        ROUTe:RFSG:PORT:DEFine? <LogicalPortname>
Query Response:
        <PhysicalPort>
      

Description

Assigns a user-specified logical port name to a given physical RFSG port. Use logical port names to associate correction tables to ports, which improves descriptions of system connections and signal paths.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <LogicalPortname>

Description

Name of the logical port.

Datatype

String

Default Value

none
Parameter: <PhysicalPort>

Description

Physical port for which the logical port is connected.

Datatype

String

Default Value

none

ROUTe:RFSG:PORT:DELete[:NAME]


        Usage:
        ROUTe:RFSG:PORT:DELete[:NAME] <LogicalPortName>
      

Description

Deletes a specified RFSG port name binding.

Availability

Command

Execution Mode

Overlapped
Parameter: <LogicalPortName>

Description

Logical RFSG port name to delete.

Datatype

String

Default Value

""

ROUTe:RFSG:PORT:DELete:ALL


        Usage:
        ROUTe:RFSG:PORT:DELete:ALL
      

Description

Deletes all user-defined port name bindings for any RFSG port, and frees all names created by the PORT command.

Availability

Command

Execution Mode

Overlapped

ROUTe:RFSG:PORT:LOSS[:MAGNitude][:POINt]


        Usage:
Command:
        
Query:
        ROUTe:RFSG:PORT:LOSS[:MAGNitude][:POINt]? <PortName>,<Frequency>
Query Response:
        <PathlossSG>
      

Description

Returns the pathloss for a logical RFSG port at the specified frequency.
ROUTe:RFSG:PORT:LOSS:[MAGNitude]:[POINt] <PortName>, <Frequency>

Availability

Query

Execution Mode

Sequential
Parameter: <PortName>

Description

Logical port name.

Datatype

String
Parameter: <Frequency>

Description

Frequency at which the pathloss is returned.

Datatype

Double
Parameter: <PathlossSG>

Description

The pathloss of the SG in dB.

Datatype

Double

SYSTem:ERRor[:NEXT]


        Usage:
        SYSTem:ERRor[:NEXT]?
Query Response:
        <ErrorMessages[n]>
      

Description

Availability

Query

Execution Mode

Sequential
Parameter: <ErrorMessages[n]>

SYSTem:ERRor:ALL


        Usage:
        SYSTem:ERRor:ALL?
Query Response:
        <ErrorMessages[n]>
      

Description

All error messages.

Availability

Query

Execution Mode

Sequential
Parameter: <ErrorMessages[n]>

SYSTem:ERRor:CODE[:NEXT]


        Usage:
        SYSTem:ERRor:CODE[:NEXT]?
Query Response:
        <ErrorCode>
      

Description

SYSTem:ERRor:CODE[:NEXT]? queries the error/event queue for the next item and
removes it from the queue. The response returns only the error/event code number omitting
the string. Except for the shortened response, the query operates identically to
SYSTem:ERRor[:NEXT]?

Availability

Query

Execution Mode

Sequential
Parameter: <ErrorCode>

SYSTem:ERRor:CODE:ALL


        Usage:
        SYSTem:ERRor:CODE:ALL?
Query Response:
        <AllErrorCodes[n]>
      

Description

SYSTem:ERRor:CODE:ALL? queries the error/event queue for all the unread items and
removes them from the queue. The response returns a comma separated list of only the
error/event code numbers in FIFO order. If the queue is empty, the response is 0.
Note: If the queue is not empty, the 0 is not sent.

Availability

Query

Execution Mode

Sequential
Parameter: <AllErrorCodes[n]>

SYSTem:ERRor:COUNt


        Usage:
        SYSTem:ERRor:COUNt?
Query Response:
        <ErrorCount>
      

Description

SYSTem:ERRor:COUNt? queries the error/event queue for the number of unread items. As
errors and events may occur at any time, more items may be present in the queue at the time
it is actually read.
Note: If the queue is empty, the response is 0.

Availability

Query

Execution Mode

Sequential
Parameter: <ErrorCount>

SYSTem:HARDware<i>[:PXI]


        Usage:
        SYSTem:HARDware<i>[:PXI]?
Query Response:
        <PxiChassis>,<PxiChassisProductModel>,<PxiSlotNumber_1>,<PxiHardwareProduct_1>{,<PxiSlotNumber_n>,<PxiHardwareProduct_n>}
      

Description

Queries for information about the PXI chassis and its contents.

Availability

Query

Execution Mode

Overlapped
Parameter: <PxiChassis>

Description

PXI chassis number.

Datatype

String
Parameter: <PxiChassisProductModel>

Description

PXI chassis product model.

Datatype

String
Parameter: <PxiSlotNumber>

Description

PXI slot number.

Datatype

Integer32
Parameter: <PxiHardwareProduct>

Description

Product identified in the specific PXI slot.

Datatype

String

SYSTem:HARDware<i>:PXI<i>:INFormation


        Usage:
        SYSTem:HARDware<i>:PXI<i>:INFormation?
Query Response:
        <PxiHwProduct>,<Resource>,<SerialNumber>,<FirmwareRevision>,<CurrentTemperature>
      

Description

Queries for information about the hardware in a specified PXI slot.

Availability

Query

Execution Mode

Overlapped
Parameter: <PxiHwProduct>

Description

Hardware product name.

Datatype

String
Parameter: <Resource>

Description

System assigned resource name.

Datatype

String
Parameter: <SerialNumber>

Description

Product serial number, if applicable.

Datatype

String
Parameter: <FirmwareRevision>

Description

Product firmware revision, if applicable.

Datatype

String
Parameter: <CurrentTemperature>

Description

Current module temperature, if applicable.

Datatype

Double

SYSTem:HARDware<i>:PXI<i>:TEMPerature


        Usage:
        SYSTem:HARDware<i>:PXI<i>:TEMPerature?
Query Response:
        <HardwareProduct>,<ResourceName>,<Temperature>
      

Description

Returns the temperature for the device in the PXI<i> slot number.

Availability

Query

Execution Mode

Overlapped
Parameter: <HardwareProduct>

Description

Hardware product name.

Datatype

String
Parameter: <ResourceName>

Description

System assigned resource name.

Datatype

String
Parameter: <Temperature>

Description

Current module temperature, if applicable.

Datatype

Double

SYSTem:HARDware<i>:RESet


        Usage:
        SYSTem:HARDware<i>:RESet
      

Description

Forces the instrument to a full reset of its internal hardware. This affects all ivirtual instrument sessions and requires a *RST of all used virtual insturment after this command completes.

Availability

Command

Execution Mode

Sequential

SYSTem:HEALth


        Usage:
        SYSTem:HEALth?
Query Response:
        <SystemHealth>,<ResourceName_1>,<SensorType_1>,<CurrentValue_1>,<OutOfLimit_1>{,<ResourceName_n>,<SensorType_n>,<CurrentValue_n>,<OutOfLimit_n>}
      

Description

Reads the current system health.

Availability

Query

Execution Mode

Sequential
Parameter: <SystemHealth>

Description

Overall system health result.
0 : System health ok.
1 : System health out of spec.

Datatype

String
Parameter: <ResourceName>

Description

Resource name.

Datatype

String
Parameter: <SensorType>

Description

Type of health sensor.

Datatype

String
Parameter: <CurrentValue>

Description

Current value of the resource health sensor.

Datatype

Double
Parameter: <OutOfLimit>

Description

Result of health evaluation of the health sensor value.
0 : Status ok.
1 : Status failed.

Datatype

Boolean

SYSTem:INSTrument:CONNection<i>:TYPE


        Usage:
        SYSTem:INSTrument:CONNection<i>:TYPE[?] <ConnectionType>
Query Response:
        <ConnectionType>
      

Description

Changes the type of the current connection session.
This commands requires a restart.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <ConnectionType>

Description

Sets the type of connection for the given connection index. Changes take affect after the next instrument restart.
            If the session changes, the session parameters are set to their default values.
            VXI11: Sets the connetion to one of type VXI-11.
            SOCKET: Sets the connection to one of type Raw TCPIP socket.

Datatype

Enumeration

Default Value

VXI11

Range

VXI11 | SOCKET

SYSTem:INSTrument:CONNection<i>:UI:ENABle


        Usage:
        SYSTem:INSTrument:CONNection<i>:UI:ENABle[?] <UiEnable>
Query Response:
        <UiEnable>
      

Description

Enables or disables UI updates for a given virtual instrument.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <UiEnable>

Description

0|OFF : Disable UI updates.
            1|ON : Enable UI updates.

Datatype

Boolean

Default Value

1

Range

0 | 1 | OFF | ON

SYSTem:INSTrument:COUNt


        Usage:
        SYSTem:INSTrument:COUNt[?] <NumberOfLogicalInstruments>
Query Response:
        <NumberOfLogicalInstruments>
      

Description

Changes the number of connection sessions in the instrument.
This command requires a restart.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <NumberOfLogicalInstruments>

Default Value

1

Range

[1:16]

SYSTem:INSTrument:LICenses


        Usage:
        SYSTem:INSTrument:LICenses?
Query Response:
        <LicenceName_1>,<ActivationStatus_1>{,<LicenceName_n>,<ActivationStatus_n>}
      

Description

Returns all the licenses that the instrument has and the status of them.

Availability

Query

Execution Mode

Sequential
Parameter: <LicenceName>

Description

Name of the license.

Datatype

String
Parameter: <ActivationStatus>

Description

0 : The specified license is currently not activated in the instrument.
1 ::The specified option is currently activated in the instrument.

Datatype

Boolean

SYSTem:INSTrument:PERSonalities


        Usage:
        SYSTem:INSTrument:PERSonalities?
Query Response:
        <Personality_1>,<LoadStatus_1>{,<Personality_n>,<LoadStatus_n>}
      

Description

Returns all the personalities that the instrument has and the status of them.

Availability

Query

Execution Mode

Sequential
Parameter: <Personality>

Description

Name of the instrument personality.

Datatype

String
Parameter: <LoadStatus>

Description

0 : The specified personality is currently not loaded in the instrument.
1 ::The specified personality is currently loaded in the instrument.

Datatype

Boolean

SYSTem:INSTrument:REPort


        Usage:
        SYSTem:INSTrument:REPort <Name>
      

Description

Writes a system report zip file to <\Users\Public\Documents\National Instruments\RFmxDebug> on the WTS.

Availability

Command

Execution Mode

Sequential
Parameter: <Name>

Description

The file name of the report file without an extension. If the file already exists, it is overwritten.

Datatype

String

Default Value

""SystemReport""

SYSTem:PROCess:HANDle:COUNt


        Usage:
        SYSTem:PROCess:HANDle:COUNt?
Query Response:
        <HandleCount>
      

Description

Returns the amount of LabVIEW open handles for the WTS Software process.

Availability

Query

Execution Mode

Overlapped
Parameter: <HandleCount>

SYSTem:PROCess:MEMory:WSET


        Usage:
        SYSTem:PROCess:MEMory:WSET?
Query Response:
        <WorkingSetMemory>
      

Description

Returns the working set memory, in bytes, of the WTS Software.

Availability

Query

Execution Mode

Overlapped
Parameter: <WorkingSetMemory>

Description

Returns the working set memory, in bytes, of the calling process.

Datatype

Double

SYSTem:RESTart


        Usage:
        SYSTem:RESTart
      

Description

Forces a restart of the WTS Software.

Availability

Command

Execution Mode

Overlapped

SYSTem:RESTart:NEEDed


        Usage:
        SYSTem:RESTart:NEEDed?
Query Response:
        <RestartRequredFlag>
      

Description

Checks if the instrument software requires a restart.

Availability

Query

Execution Mode

Sequential
Parameter: <RestartRequredFlag>

Description

This flag is set to 1 if any parameter that requires an instrument restart is changed.
            0 : Restart not required.
            1 : Restart is required.

Datatype

Boolean

SYSTem:RF:CORRection:CSET[:SELect]


        Usage:
        SYSTem:RF:CORRection:CSET[:SELect] <PortName>,<TableName>
      

Description

Specifies the active correction table to use for a specified port name. This table is applied to the generator path and the analyzer path.

Availability

Command

Execution Mode

Sequential
Parameter: <PortName>

Description

Name of the port with which to use the correction table. This value can be a physical or a logical port name.

Datatype

String

Default Value

"Port0"
Parameter: <TableName>

Description

Name of correction table to use with the specified <PortName>.

Datatype

String

Default Value

"default"

SYSTem:RF:CTOut:FREQuency


        Usage:
        SYSTem:RF:CTOut:FREQuency[?] <LoFrequency>
Query Response:
        <LoFrequency>
      

Description

Sets the frequency of the Cal Tone Out signal.

Availability

Command/Query

Execution Mode

Command: Overlapped
Query: Overlapped
Parameter: <LoFrequency>

Default Value

1.000000000000000E+009

Range

[6.000000000000000E+007:6.000000000000000E+009]

Unit

Hz

SYSTem:RF:CTOut:STATe


        Usage:
        SYSTem:RF:CTOut:STATe[?] <LoEnable>
Query Response:
        <LoEnable>
      

Description

Enables or disables the Cal Tone Out ouput to the front of the WTS. In a VST system, this is the LO Out terminal.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <LoEnable>

Default Value

0

Range

0 | 1 | OFF | ON

SYSTem:RF:ELOScillator


        Usage:
        SYSTem:RF:ELOScillator[?] <ExternalOscillatorStatus>
Query Response:
        <ExternalOscillatorStatus>
      

Description

On systems that have external oscillator (PXIe-5653), this flag can force to use the internal oscillator of the instrument. This is mostly used for debug purposes or for pathloss calibration and tasks where the external oscillator does not provide better accuracy.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <ExternalOscillatorStatus>

Description

Set the status to ON or OFF. A system with an external oscillator always uses it by default.

Datatype

Boolean

Default Value

1

Range

0 | 1 | OFF | ON

SYSTem:RF:GSETtings:VERSion


        Usage:
        SYSTem:RF:GSETtings:VERSion?
Query Response:
        <PersonalityVersion>,<FrameworkVersion>
      

Description

Queries for the version of the RF General Settings personality.

Availability

Query

Execution Mode

Overlapped
Parameter: <PersonalityVersion>

Description

Version of the SCPI personality.

Datatype

String
Parameter: <FrameworkVersion>

Description

Version of the execution framework.

Datatype

String

SYSTem:RF:REFerence:FREQuency:SOURce


        Usage:
        SYSTem:RF:REFerence:FREQuency:SOURce[?] <ReferenceSource>
Query Response:
        <ReferenceSource>
      

Description

Specifies the frequency reference source currently in use.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <ReferenceSource>

Description

INTERNAL: Selects the 'best' internal frequency reference in the instrument. Includes
            a) OnboardClock : Locks the instrument to the LocalOscillator Source onboard clock frequency reference.
            b) PXI_Clk  : Locks the instrument to the PXI backplane Clock frequency reference.
            If the WTS hardware has OCXO timing C\card, then this clock is selected. To the individual modules this is 'seen' as RefIn but to the user, this is an internal component. These WTS hardwares do not support external reference.
            
            EXTERNAL: Selects the external frequency reference connected to the instrument.
            a) RefIn : Connects the external signal to Instruments REF IN/OUT connector.
            b)ClkIn : Instrument locks to an external 10MHz signal.

Datatype

String

Default Value

"INTERNAL"

SYSTem:RF:REFerence:LOCKed


        Usage:
        SYSTem:RF:REFerence:LOCKed?
Query Response:
        <ReferenceLocked>
      

Description

[No Implementation]

Availability

Query

Execution Mode

Overlapped
Parameter: <ReferenceLocked>

SYSTem:RFSA:CORRection:CSET[:SELect]


        Usage:
        SYSTem:RFSA:CORRection:CSET[:SELect] <PortName>,<TableName>
      

Description

Specifies the active correction table for a specified RFSA port name.

Availability

Command

Execution Mode

Sequential
Parameter: <PortName>

Description

Name of the RFSA port to use with the correction table. This value can be a physical or a logical port name.

Datatype

String

Default Value

""
Parameter: <TableName>

Description

Name of the correction table to use with <PortName>.

Datatype

String

Default Value

""

SYSTem:RFSA:ELOScillator


        Usage:
        SYSTem:RFSA:ELOScillator[?] <ExternalOscillatorStatus>
Query Response:
        <ExternalOscillatorStatus>
      

Description

On systems that have an external oscillator, this flag can force the signal analyzer(s) to use the internal oscillator of the instrument. You can use this to decouple the SA center frequency and SG center frequency in shared LO systems.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <ExternalOscillatorStatus>

Description

Set status to ON or OFF. A system with external oscillator uses it by default.

Datatype

Boolean

Default Value

1

Range

0 | 1 | ON | OFF

SYSTem:RFSG:CONCurrency:CONText<i>


        Usage:
        SYSTem:RFSG:CONCurrency:CONText<i>[?] <ContextName>,<JoinTime>,<Portname>
Query Response:
        <ContextName>,<JoinTime>,<Portname>
      

Description

Configures the broadcasting context. It holds information about the port name to use and about the join time to wait for other clients.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <ContextName>

Description

A unique name that describes the broadcasting context.

Datatype

String

Default Value

""
Parameter: <JoinTime>

Description

Maximum time in seconds to wait for other clients to join the broadcasting group.

Datatype

Double

Default Value

0.000000000000000E+000

Range

[0.000000000000000E+000:Inf]
Parameter: <Portname>

Description

Configures on which port the signal in this connection session is generated. This information is required for the concurrency management to decide if it can be joined with other signal generations. For MIMO signal generations the port names have to be given separated by a vertical bar, e.g. Port0|Port4. These ports must be located on different switch banks.

Datatype

String

Default Value

""

SYSTem:RFSG:CONCurrency:NCONtexts


        Usage:
        SYSTem:RFSG:CONCurrency:NCONtexts[?] <NumberOfBroadcastingContexts>
Query Response:
        <NumberOfBroadcastingContexts>
      

Description

Configures the number of broadcasting contexts which can be configured in SYSTEM:RFSG:CONCurrency:CONText<i> afterwards.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <NumberOfBroadcastingContexts>

Description

Configures the number of broadcasting contexts. These contexts can be configured afterwards.

Datatype

Integer32

Default Value

0

Range

[0:100]

SYSTem:RFSG:CONCurrency:TESTrun


        Usage:
        SYSTem:RFSG:CONCurrency:TESTrun <Action>,<ContextName>
      

Description

Starts and ends broadcasting-enabled sections in the testplan. First configure a broadcasting context, then enable it using this command. If in other connection sessions the same contextname is configured, this command waits for this other client to join.

Availability

Command

Execution Mode

Sequential
Parameter: <Action>

Description

Tells the concurrency management if a potential broadcasting segment starts or ends. Possible values are START and END.

Datatype

Enumeration

Default Value

START

Range

START | END
Parameter: <ContextName>

Description

Tells the concurrency management which broadcasting context to start or end.

Datatype

String

Default Value

""

SYSTem:RFSG:CORRection:CSET[:SELect]


        Usage:
        SYSTem:RFSG:CORRection:CSET[:SELect] <PortName>,<TableName>
      

Description

Specifies the active correction table for a specified RFSG port name.

Availability

Command

Execution Mode

Sequential
Parameter: <PortName>

Description

Name of the RFSG port to use with the correction table. This value can be a physical or a logical port name.

Datatype

String

Default Value

"Port0"
Parameter: <TableName>

Description

Name of the correction table to use with <PortName>.

Datatype

String

Default Value

"default"

SYSTem:RFSG:HARDware:OWNership:ACQuisition:TOUT


        Usage:
        SYSTem:RFSG:HARDware:OWNership:ACQuisition:TOUT[?] <ReleaseTime>
Query Response:
        <ReleaseTime>
      

Description

This is an advanced command.  Configures the RFSG lock self release time. Increase this value if two clients want to use the same RFSG hardware but one of them uses it for a long time. If the release time value is too short, the instrument errors out for the waiting client.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <ReleaseTime>

Description

RFSG lock release time in ms. The default value is 1 minute (=60sec).

Datatype

Integer32

Default Value

60

Range

[0:3600]

Unit

Sec

SYSTem:RFSG:HARDware:OWNership:DURation


        Usage:
        SYSTem:RFSG:HARDware:OWNership:DURation[?] <DurationTime>
Query Response:
        <DurationTime>
      

Description

This is an advanced command. If a testplan turns ON SG and does not turn OFF, set this time to autorelease to share it with other sessions. By default, this number is very large to make it work like a traditional SG.

Availability

Command/Query

Execution Mode

Command: Sequential
Query: Sequential
Parameter: <DurationTime>

Description

RFSG ownership duration. This means that if turned ON, the SG turns OFF automatically with NO ERROR after this amount of time. The default value is 1.6 hours (=6000Sec).

Datatype

Integer32

Default Value

6000

Range

[1:2147484]

Unit

Sec

SYSTem:VERSion


        Usage:
        SYSTem:VERSion?
Query Response:
        <ScpiVersion>
      

Description

Version of SCPI supported

Availability

Query

Execution Mode

Sequential
Parameter: <ScpiVersion>