Skip to content

NI RFSA Calibration Functions

Jump to bottom
Greg Stoll edited this page Nov 11, 2021 · 1 revision

Calibration Functions

niRFSA_SelfCalibrate

ViStatus niRFSA_SelfCalibrate(ViSession instrumentHandle, ViInt64 stepsToOmit);

Purpose

Self-calibrates the NI-RFSA device and associated modules that support self-calibration. If self-calibration is performed successfully, the new calibration constants are stored immediately in the self-calibration area of the module EEPROM. Refer to the specifications document for your device for more information about how often to self-calibrate.

For best results, NI recommends that you perform a complete self-calibration without omitting any steps. However, if the niRFSA_IsSelfCalValid function indicates that the calibration data for a specific step is still valid, you can omit that step for faster execution.

Open NI-RFSG Session for the PXIe-5820/5830/5831/5832/5840/5841

If there is an existing NI-RFSG session open for the same PXIe-5820/5830/5831/5832/5840/5841 while this function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSG_Commit or niRFSG_Initiate.

PXIe-5841 with PXIe-5655

The PXIe-5841 maintains separate self-calibration data for both the PXIe-5841 standalone and when associated with the PXIe-5655. Use this function once for each intended configuration.

IF Flatness Step Time

  • The IF Flatness step can take approximately 15 minutes to complete on the PXIe-5665 (3.6 GHz) and approximately 25 minutes to complete on the PXIe-5665 (14 GHz).
  • The IF Flatness step can take approximately 1 minute to complete on the PXIe-5667 (3.6 GHz) and approximately 1.5 minutes to complete on the PXIe-5667 (7 GHz).
  • The IF Flatness step can take approximately 15 minutes to complete on the PXIe-5668.

Supported Devices: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

PXI-5661 Calibration

PXIe-5663/5663E Calibration

PXIe-5665 Self-Calibration

PXIe-5667 Self-Calibration

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
stepsToOmit ViInt64 Specifies which calibration steps to skip as part of the self-calibration process. A value of 0 specifies that all supported calibration steps are performed. The only valid value for the PXIe-5820/5830/5831/5832/5840/5841 is 0.

|Note|Note  To omit two or more calibration steps, specify a bitwise-OR combination of the following constants. For example, if you wanted to omit NIRFSA_VAL_SELF_CAL_IF_FLATNESS and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL, you would pass the following string to the niRFSA_SelfCalibrate function: NIRFSA_VAL_SELF_CAL_IF_FLATNESS | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL| | :- | :- |

| :- | :- | :- |

NIRFSA_VAL_SELF_CAL_OMIT_NONE No step is omitted during self-calibration.
NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT Omits the Preselector Alignment step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the preselector alignment specifications are not guaranteed.
NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE Omits the Gain Reference step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the absolute accuracy of the device is not guaranteed.
NIRFSA_VAL_SELF_CAL_IF_FLATNESS Omits the IF Flatness step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the IF flatness specifications are not guaranteed.
NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL Omits the Digitizer Self Cal step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the absolute accuracy of the device is not guaranteed.
NIRFSA_VAL_SELF_CAL_LO_SELF_CAL Omits the Local Oscillator (LO) Self Cal step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the LO phase-locked loop (PLL) may fail to lock.
NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY Not used by this function.
NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER Not used by this function.
NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION Not used by this function.
NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT Omits the Synthesizer Alignment step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the synthesizer alignment specifications are not guaranteed.
NIRFSA_VAL_SELF_CAL_DC_OFFSET Omits the DC Offset step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the DC offset specifications are not guaranteed. This step applies only to the PXIe-5820.

| :- | :- | :- |

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_SelfCalibrateRange

ViStatus niRFSA_SelfCalibrateRange (ViSession Instrument_Handle,ViInt64 Steps_To_Omit, ViReal64 Min_Frequency, ViReal64 Max_Frequency, ViReal64 Min_Reference_Level, ViReal64 Max_Reference_Level);

Purpose

Self-calibrates all configurations within the specified frequency and reference level limits.

Self-calibration range data is valid until you restart the system or call the [niRFSA_ClearSelfCalibrateRange](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearSelfCalibrateRange.html')) function.

NI recommends that no external signals are present on the RF In port while the calibration is taking place.

Note Note  This function does not update self-calibration date and temperature.
For best results, NI recommends that you perform a complete self-calibration without omitting any steps. However, if certain aspects of performance are less important for your application, you can omit that step for faster execution.
Note Note  If there is an existing NI-RFSG session open for the same PXIe-5820/5830/5831/5832/5840/5841 while this function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSG_Commit or niRFSG_Initiate.
Note Note  If there is an existing NI-RFSG session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this function runs.
Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
stepsToOmit ViInt64 Specifies which calibration steps to skip as part of the self-calibration process. A value of 0 specifies all supported calibration steps are performed.

|Note|Note  To omit two or more calibration steps, specify a bitwise-OR combination of the following constants. For example, if you wanted to omit NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL, you would pass the following string to the niRFSA_SelfCalibrate function: NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL| | :- | :- |

| :- | :- | :- |

NIRFSA_VAL_SELF_CAL_OMIT_NONE No step is omitted during self-calibration.
NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT Not used by this function.
NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE Not used by this function.
NIRFSA_VAL_SELF_CAL_IF_FLATNESS Not used by this function.
NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL Not used by this function.
NIRFSA_VAL_SELF_CAL_LO_SELF_CAL Omits the Local Oscillator (LO) Self Cal step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the LO phase-locked loop (PLL) may fail to lock.
NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY Omits the Amplitude Accuracy step. If you omit this step, the absolute accuracy of the device is not adjusted.
NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.
NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION Omits the Image Suppression step. If you omit this step, the Residual Sideband Image Performance is not adjusted.
NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT Omits the Synthesizer Alignment step. If you omit this step, the LO PLL is not adjusted. This step is not valid for the PXIe-5820.
NIRFSA_VAL_SELF_CAL_DC_OFFSET Omits the DC Offset step. This step applies only to the PXIe-5820.

| :- | :- | :- | |minFrequency|ViReal64|Specifies the minimum RF frequency in Hz.| |maxFrequency|ViReal64|Specifies the maximum RF frequency in Hz.| |minReferenceLevel|ViReal64|Specifies the minimum reference level in dBm.| |maxReferenceLevel|ViReal64|Specifies the maximum reference level in dBm.|

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_IsSelfCalValid

ViStatus niRFSA_IsSelfCalValid(ViSession instrumentHandle, ViBoolean* selfCalValid, ViInt64* validSteps);

Purpose

Indicates which calibration steps contain valid calibration data. To omit steps with valid calibration data from self-calibration, you can pass the validSteps parameter to the stepsToOmit parameter of the niRFSA_SelfCalibrate function.

Supported Devices: PXI-5661, PXIe-5663/5663E/5665/5667/5668

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
Output
Name Type Description
selfCalValid ViBoolean* Returns VI_TRUE if all the calibration data is valid and VI_FALSE if any of the calibration data is invalid.
validSteps ViInt64* Returns valid steps.

|Note|Note  If two or more calibration steps are valid, this parameter returns a bitwise-OR combination of the calibration steps. For example, if both NIRFSA_VAL_SELF_CAL_IF_FLATNESS and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL steps are valid, NI-RFSA returns the following string: NIRFSA_VAL_SELF_CAL_IF_FLATNESS | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL| | :- | :- |

| :- | :- | :- |

NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE Indicates the Gain Reference calibration data is valid. This step measures the changes in gain since the last external calibration was run.
NIRFSA_VAL_SELF_CAL_IF_FLATNESS Indicates the IF Flatness calibration data is valid. This step measures the IF response of the entire system for each of the supported IF filters.
NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL Indicates the Digitizer Self Cal calibration data is valid. This step calls for digitizer self-calibration if the digitizer is associated with the RF downconverter.
NIRFSA_VAL_SELF_CAL_LO_SELF_CAL Indicates the LO Self Cal calibration data is valid. This step calls for LO self-calibration if the LO source module is associated with the RF downconverter.
NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT Indicates the Preselector Alignment calibration data is valid. This step generates coefficients to align the preselector across the frequency range for your device.

| :- | :- | :- |

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

Calibration Utility

niRFSA_ClearSelfCalibrateRange

ViStatus niRFSA_ClearSelfCalibrateRange(ViSession vi);

Purpose

Clears the data obtained from the [niRFSA_SelfCalibrateRange](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_SelfCalibrateRange.html')) function.

Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_GetExtCalLastDateAndTime

ViStatus niRFSA_GetExtCalLastDateAndTime(ViSession vi, ViInt32* year, ViInt32* month, ViInt32* day, ViInt32* hour, ViInt32* minute);

Purpose

Returns the date and time of the last successful external calibration. The time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the hour parameter, 30 for the minute parameter, 12 for the month parameter, 31 for the day parameter, and 2010 for the year parameter.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')), [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')), or [niRFSA_InitExtCal](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_InitExtCal.html')) function and identifies a particular instrument session.
Output
Name Type Description
year ViInt32* Returns the year of the last external calibration.
month ViInt32* Returns the month of the last external calibration.
day ViInt32* Returns the day of the last external calibration.
hour ViInt32* Returns the hour of the last external calibration.
minute ViInt32* Returns the minute of the last external calibration.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_GetExtCalLastTemp

ViStatus niRFSA_GetExtCalLastTemp(ViSession vi, ViReal64* temperature);

Purpose

Returns the temperature of the last successful external calibration. The temperature is returned in degrees Celsius.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')), [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')), or [niRFSA_InitExtCal](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_InitExtCal.html')) function and identifies a particular instrument session.
Output
Name Type Description
temperature ViReal64* Returns the temperature, in degrees Celsius, of the last external calibration.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_GetExtCalRecommendedInterval

ViStatus niRFSA_GetExtCalRecommendedInterval(ViSession vi, ViInt32* months);

Purpose

Returns the recommended interval between external calibrations, in months.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')), [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')), or [niRFSA_InitExtCal](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_InitExtCal.html')) function and identifies a particular instrument session.
Output
Name Type Description
months ViInt32* Returns the recommended maximum interval between external calibrations, in months.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_GetSelfCalLastDateAndTime

ViStatus niRFSA_GetSelfCalLastDateAndTime(ViSession vi, ViInt64 selfCalibrationStep, ViInt32* year, ViInt32* month, ViInt32* day, ViInt32* hour, ViInt32* minute);

Purpose

Returns the date and time of the last successful self-calibration. The time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the hour parameter, 30 for the minute parameter, 12 for the month parameter, 31 for the day parameter, and 2010 for the year parameter.

Note Note  For the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the selfCalibrationStep parameter.
Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.
selfCalibrationStep ViInt64 Specifies the self-calibration step to query for the last successful self-calibration date and time data.
NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT Selects the Preselector Alignment self-calibration step.
NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE Selects the Gain Reference self-calibration step.
NIRFSA_VAL_SELF_CAL_IF_FLATNESS Selects the IF Flatness self-calibration step.
NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL Selects the Digitizer Self Cal self-calibration step.
NIRFSA_VAL_SELF_CAL_LO_SELF_CAL Selects the LO Self Cal self-calibration step.
NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY Selects the Amplitude Accuracy self-calibration step.
NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER Selects the Residual LO Power self-calibration step.
NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION Selects the Image Suppression self-calibration step.
NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT Selects the Synthesizer Alignment self-calibration step.
NIRFSA_VAL_SELF_CAL_DC_OFFSET Selects the DC Offset self-calibration step.

| :- | :- | :- | |Output||| |Name|Type|Description| |year|ViInt32*|Returns the year of the last external calibration. | |month|ViInt32*|Returns the month of the last external calibration. | |day|ViInt32*|Returns the day of the last external calibration. | |hour|ViInt32*|Returns the year of the last external calibration. It is expressed as an integer.| |minute|ViInt32*|Returns the minute of the last external calibration. |

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_GetSelfCalLastTemp

ViStatus niRFSA_GetSelfCalLastTemp(ViSession vi, ViInt64 selfCalibrationStep, ViReal64* temp);

Purpose

Returns the temperature, in degrees Celsius, at the last successful self-calibration.

Note Note  For the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the selfCalibrationStep parameter.
Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')) or [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')) function.

niRFSA_SetCalUserDefinedInfo

ViStatus niRFSA_SetCalUserDefinedInfo(ViSession vi, ViConstString info);

Purpose

Writes user-defined information into the onboard EEPROM.

Supported Devices: PXIe-5601/5603/5605/5606, PXIe-5693/5694/5698

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')), [niRFSA_initWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')), or [niRFSA_InitExtCal](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_InitExtCal.html')) function and identifies a particular instrument session.
info ViConstString Specifies a string containing the user-defined information. This string can be up to 21 characters long.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_GetCalUserDefinedInfo

ViStatus niRFSA_GetCalUserDefinedInfo(ViSession vi, ViChar[] info);

Purpose

Returns user-defined information from the onboard EEPROM.

Supported Devices: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5693/5694/5698

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')), [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')), or [niRFSA_InitExtCal](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_InitExtCal.html')) function and identifies a particular instrument session.
Output
Name Type Description
info ViChar[] Returns a string containing the user-defined information.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

niRFSA_GetCalUserDefinedInfoMaxSize

ViStatus niRFSA_GetCalUserDefinedInfoMaxSize(ViSession vi, ViInt32* infoSize);

Purpose

Returns the number of characters of user-defined information that can be stored in the device onboard EEPROM.

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the [niRFSA_init](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_init.html')), [niRFSA_InitWithOptions](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_initWithOptions.html')), or [niRFSA_InitExtCal](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_InitExtCal.html')) function and identifies a particular instrument session.
Output
Name Type Description
infoSize ViInt32* Returns the number of characters of user-defined information that can be stored in the device onboard EEPROM. The maximum size of the user-defined information array is 21 characters.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the [niRFSA_GetError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_GetError.html')) function. To clear the error information from NI-RFSA, call the [niRFSA_ClearError](javascript:LaunchMergedHelp('nirfsa.chm', 'rfsacref.chm', 'cviniRFSA_ClearError.html')) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

| :- | :- | :- |

Table of Contents

Home

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally