Specifying Setting Parameters

Each sweep settings file must contain the following top-level required parameters and can contain one or more of the optional parameters. You specify the settings parameters for individual sweeps inside a measurement point in the list table.

Parameter Name Description Data Type Required or Optional
Revision

Specifies the version of the file format this sweep setting file follows. The valid values are 0.5 or 0.6.

 Number Required
VectorSweepSettings

Specifies a table listing sweep settings that can be applied for a vector calibration or measurement. This contains tables that conform to the List Sweep format. The indexes into this table are the names of the sweeps. The Vector Sweep Settings Parameters section lists valid values for all vector sweep types.

Only parameters in the Simple Vector Sweep Point Parameters table below support the mmWave subsystem.

 Table Optional
SourceCalibrationSettings

Specifies a table listing sweep settings that can be applied for source calibration. This contains tables that conform to the List Sweep format. The indexes into this table are the names of the sweeps. The Source Sweep Settings Parameters section lists valid values for all source sweep types.

These parameters do not support the mmWave subsystem.

 Table Optional
ReceiverCalibrationSettings

Specifies a table listing sweep settings that can be applied for receiver calibration. This contains tables that conform to the List Sweep format. The indexes into this table are the names of the sweeps. The Receiver Sweep Settings Parameters section lists valid values for all receiver sweep types.

These parameters do not support the mmWave subsystem.

 Table Optional
Note RFPM currently supports 0.5 and 0.6 sweep settings.

All sweep types use the List Sweep format to specify the calibration or measurement parameters. These settings are required for all sweep types.

Parameter Name Description Data Type
type Specifies the type of sweep. The valid value is list. String
list Specifies a table where each entry conforms to one of the sweep point types. All the points in this list must be the same type. For example, if this list sweep is contained in a VectorSweepSettings table you can only use points listed in the Simple Vector Sweep Point or Override Vector Sweep Point parameter tables. Table

Vector Sweep Settings Parameters

Table 1. Simple Vector Sweep Point Parameters
Parameter Name Description Data Type Required or Optional
freq Specifies the frequency for a measurement point. Number Required for first point in a list.
portPower

Specifies the output power used during measurement to drive the DUT and for which to calibrate. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for measurement or calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the measurement. If de-embedding is enabled this power is adjusted down to the blind mate plane defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector.

Number or Table Required for first point in a list.
referenceLevel Specifies the reference level used during measurement at the DUT and for which to calibrate. All receivers in a measurement use the same reference level. If de-embedding is enabled this reference level is adjusted to the plane defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector. If you define referenceLevel as a table data type, you must have the same number of elements as portPower. Number or Table Optional
IFBW Specifies the intermediate frequency bandwidth. Number Optional
Note For fields that can be a number, all entries must be a number. If any field is a table, all entries must be tables.
Table 2. Override Vector Sweep Point Parameters
Parameter Name Description Data Type Required or Optional
freq

Specifies the frequency inside a measurement point.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
portPower

Specifies the output power used during measurement to drive the DUT and for which to calibrate. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for measurement or calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the measurement.  If de-embedding is enabled this power is adjusted down to the blind mate plane defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
referenceLevel Specifies the reference level used during measurement at the DUT and for which to calibrate. All receivers in a measurement use the same reference level. If de-embedding is enabled this reference level is adjusted to the plane defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector. If you define referenceLevel as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
IFBW

Specifies the intermediate frequency bandwidth.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
RFSAReferenceLevel

Specifies the reference level sent directly to NI-RFSA during a measurement or vector calibration. The receiver in a measurement or vector calibration uses the same NI-RFSA reference level across all ports part of the same sweep. This setting is not impacted by de-embedding. The reference plane for RFSAReferenceLevel is always at the port of the analyzer. If you define RFSAreferenceLevel as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
5530_TXPath

Specifies the transmit path of the NI-RFPM switch device. The valid values are DIRECT, GAIN, and LOOP. If you define 5530_TXPath as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 String or Table Required for first point in a list.
5530_RXPath

Specifies the receive path of the NI-RFPM switch device. The valid values are DIRECT, GAIN, and LOOP. If you define 5530_RXPath as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 String or Table Required for first point in a list.
calibrationSettings

Indicates the start of the list of parameters that are specific to calibration. The Vector Calibration Settings table lists valid parameters.

This parameter does not support the mmWave subsystem.

 Table Required for first point in a list.
Table 3. Vector Calibration Settings
Parameter Name Description Data Type Required or Optional
IFBW

Specifies the intermediate frequency bandwidth used during calibration.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
vectorCal_Power

Specifies the power to use during vector calibration. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
vectorCal_Power_powerMeter

Specifies the power to use for calibration with the power meter. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
scalarCal_Power_sourceCal

Specifies the power to use during the source calibration portion of calibration. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.

Source Sweep Settings Parameters

Table 4. Simple Source Sweep Parameters
Parameter Name Description Data Type Required or Optional
freq

Specifies the frequency inside a measurement point.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
portPower

Specifies the output power at the DUT for which to perform calibration. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. If de-embedding is enabled, this power is adjusted down to the blind mate defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
Table 5. Override Source Sweep Point Parameters
Parameter Name Description Data Type Required or Optional
freq

Specifies the frequency inside a measurement point.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
portPower

Specifies the output power at the DUT for which to perform calibration. If the input is a number, the same power is used for each port. If the input is a table, the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. If de-embedding is enabled, this power is adjusted down to the blind mate plane defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
referenceLevel
Note For a source calibration, set referenceLevel equal to RFSAReferenceLevel for proper operation.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
RFSAReferenceLevel

Specifies the reference level sent directly to NI-RFSA during a vector calibration. The receiver in a vector calibration uses the same NI-RFSA reference level used during the vector portion of the calibration across all ports of the same sweep. This setting is not impacted by de-embedding. The reference plane for RFSAReferenceLevel is always at the port of the analyzer. If you define RFSA referenceLevel as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
5530_TXPath

Specifies the transmit path of the NI-RFPM switch device. The valid values are DIRECT, GAIN, and LOOP. If you define 5530_TXPath as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 String or Table Required for first point in a list.
5530_RXPath

Specifies the receive path of the NI-RFPM switch device. The valid values are DIRECT, GAIN, and LOOP. If you define 5530_RXPath as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 String or Table Required for first point in a list.
calibrationSettings

Indicates the start of the list of parameters that are specific to calibration. The Source Calibration Settings table lists valid parameters.

This parameter does not support the mmWave subsystem.

 Table Required for first point in a list.
Table 6. Source Calibration Settings
Parameter Name Description Data Type Required or Optional
IFBW

Specifies the intermediate frequency bandwidth used during the vector calibration to determine the source scalar offset.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
vectorCal_Power

Specifies the power to use during vector calibration. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
vectorCal_Power_powerMeter

Specifies the power to use during the calibration of the power meter. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
scalarCal_Power_sourceCal

Specifies the power to use during the source calibration portion of calibration. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.

Receiver Sweep Settings Parameters

Table 7. Simple Receiver Sweep Parameters
Parameter Name Description Data Type Required or Optional
freq

Specifies the frequency inside a measurement point.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
referenceLevel

Specifies the reference level at the DUT for which to perform a calibration. All receivers use the same reference level during the scalar portion of the calibration, similar to the vector calibration.  If de-embedding is enabled this reference level is adjusted down to the blind mate plane defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector. If you define referenceLevel as a Table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 Number or Table Optional
Table 8. Override Receiver Sweep Point Parameters
Parameter Name Description Data Type Required or Optional
freq

Specifies the frequency inside a measurement point.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
referenceLevel

Specifies the reference level at the DUT for which to perform a calibration. All receivers use the same reference level during the scalar portion of the calibration, similar to the vector calibration.  If de-embedding is enabled this reference level is adjusted down to the blind mate plane defined by the de-embedding file. If you define referenceLevel as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
RFSAReferenceLevel

Specifies the reference level sent directly to NI-RFSA during a vector calibration. The receiver in a vector calibration uses the same NI-RFSA reference level used during the vector portion of the calibration across all ports of the same sweep. This setting is not impacted by de-embedding. The reference plane for RFSAReferenceLevel is always at the port of the analyzer. If you define RFSAreferenceLevel as a Table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
portPower Specifies the output power at the DUT for which to perform calibration. If the input is a number, the same power is used for each port. If the input is a table, the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. If de-embedding is enabled, this power is adjusted down to the blind mate plane defined by the de-embedding file. Otherwise it is at the plane of the blind mate connector.
Note   For a receiver calibration, set portPower equal to scalarCal_Power_receiver for proper operation.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
5530_TXPath

Specifies the transmit path of the NI-RFPM switch device. The valid values are DIRECT, GAIN, and LOOP. If you define 5530_TXPath as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 String or Table Required for first point in a list.
5530_RXPath

Specifies the receive path of the NI-RFPM switch device. The valid values are DIRECT, GAIN, and LOOP. If you define 5530_RXPath as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 String or Table Required for first point in a list.
5530_CouplingPath

Specifies the path through the port module to use for all receivers in the calibration. For NI-5531 ports, the valid values are COUPLED, DIRECT, and LNA. For NI-5534 ports, the valid value is COUPLED. If you define 5530_CouplingPath as a table data type, you must have the same number of elements as portPower.

This parameter does not support the mmWave subsystem.

 String or Table Required for first point in a list.
calibrationSettings

Indicates the start of the list of parameters that are specific to calibration. The Receiver Calibration Settings table lists valid parameters.

This parameter does not support the mmWave subsystem.

 Table Required for first point in a list.
Table 9. Receiver Calibration Settings
Parameter Name Description Data Type Required or Optional
IFBW

Specifies the intermediate frequency bandwidth used during the vector calibration to determine the receiver scalar offset.

This parameter does not support the mmWave subsystem.

 Number Required for first point in a list.
vectorCal_Power

Specifies the power to use during vector calibration. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
vectorCal_Power_powerMeter

Specifies the power to use during the measurement of the power meter. If the input is a number the same power is used for each port. If the input is a table the number of ports used with this sweep for measurement or calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the measurement. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.
scalarCal_Power_receiverCal

Specifies the power to use during the receiver calibration portion of calibration. If the input is a table the number of ports used with this sweep for calibration must match the number of entries in this table. Each number in the table is the power to use at one of the ports in the calibration. This setting is not impacted by de-embedding. Calibration parameters are always defined at the blind mate reference plane.

This parameter does not support the mmWave subsystem.

 Number or Table Required for first point in a list.

Formatting Parameters

The configuration settings file is processed using a Lua-based parser, and you must format it properly to avoid syntax errors. You must nest all the previous parameters except for Revision and one of the three settings table types (VectorSweepSettings, SourceCalibrationSettings, or ReceiverCalibrationSettings) underneath the list parameter. The following example shows the format of a simple vector sweep named "sweep_vector_simple": 

VectorSweepSettings["sweep_vector_simple"] =
{
   ["type"] = "list",
   -- frequency list
   ["list"] =
   {
      {
         -- Frequency to calibrate with at this point
         ["freq"] = 1*Giga,
         -- Output power in dBm at the blind mate (or DUT with deembedding enabled) during measurement or calibration for all ports
         ["portPower"] = 0,
      },
      {
         ["freq"] = 1.01*Giga,
      },
      {
         ["freq"] = 1.02*Giga,
      },
      {
         ["freq"] = 1.03*Giga,
      },
      {
         ["freq"] = 1.04*Giga,
      },
      {
         ["freq"] = 1.05*Giga,
      },
      {
         ["freq"] = 2*Giga,
      }
   }
};

You must place a comma after the closing brace of each measurement point and after you specify a value for a parameter, unless the parameter is the final parameter in the measurement point.

Note Placing a comma incorrectly results in a syntax error.

All parameters are case-sensitive and must be specified using the correct case. For example, PortPower is not valid, whereas portPower is valid. All parameters must also be surrounded by open and closed brackets as well as opening and closing quotation marks, for example, ["parameterName"], where parameterName is the name of a parameter.

Parameters may not use the + sign, but may use the - sign. For example, ["referenceLevel"] = +12 results in a syntax error. Use ["referenceLevel"] = 12 instead.

Implicitly Defined Parameters

You can use implicitly defined values for any of the parameters in a given measurement point. If you do not define a value for these parameters in any subsequent measurement point after the first measurement point, NI-RFPM uses the most recently defined value of that parameter.

Note You must define a value for all required parameters for the first point in the list. If you do not define these values, NI-RFPM returns the error NIRFPM_ERROR_SUBCOMPONENT_ERROR. Optional parameters are indicated in the Required or Optional column.

The following example shows how to use previously defined values for all parameters except the freq parameter for a simple sweep: 

VectorSweepSettings["sweep_vector_simpleWithOptional"] =
{
   ["type"] = "list",
   -- frequency list
   ["list"] =
   {
      {
         -- Frequency to calibrate with at this point
         ["freq"] = 1*Giga,
         -- Output power used during measurement or calibration
         -- The number of ports used with this sweep will need to match the number of entries in this table
         ["portPower"] =
         {
            0,  -- dBm at blind mate (or DUT with deembedding enabled) for the first port
            -5,  -- dBm at blind mate (or DUT with deembedding enabled) for the second port
         },
         -- Input reference level in dBm at blind mate (or DUT with deembedding enabled), optional
         ["referenceLevel"] = 10,
         -- IF bandwidth used during the measurement, optional
         ["IFBW"] = 1000
      },
      {
         ["freq"] = 1.01*Giga,
      },
      {
         ["freq"] = 1.02*Giga,
      },
      {
         ["freq"] = 1.03*Giga,
      },
      {
         ["freq"] = 1.04*Giga,
      },
      {
         ["freq"] = 1.05*Giga,
      },
      {
         ["freq"] = 2*Giga,
      }
   }
};

In the previous example, the first measurement point defines all required parameters, including portPower. In the remaining measurement points, only the freq parameter is specified. The values of IFBW, portPower, and referenceLevel from the first measurement point are used in the subsequent measurement points.