NI RFSG Calibration Functions - ni/grpc-device GitHub Wiki
- niRFSG_ClearSelfCalibrateRange
- niRFSG_SelfCal
- niRFSG_SelfCalibrateRange
- niRFSG_GetSelfCalibrationDateAndTime
- niRFSG_GetSelfCalibrationTemperature
- niRFSG_GetExternalCalibrationLastDateAndTime
ViStatus niRFSG_ClearSelfCalibrateRange (ViSession vi);
Clears the data obtained from the niRFSG_SelfCalibrateRange function.
Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841
| Input | ||
|---|---|---|
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. |
| 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 instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
| :- | :- | :- |
ViStatus niRFSG_SelfCal (ViSession vi);
Performs an internal self-calibration on the device and associated modules that support self-calibration. If the calibration is successful, new calibration data and constants are stored in the onboard nonvolatile memory of the module.
 |
Note If there is an existing NI-RFSA 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 niRFSA_Commit or niRFSA_Initiate. |
|---|---|
| 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. |
Supported Devices: PXI-5610, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
| Input | ||
|---|---|---|
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. |
| 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 instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
| :- | :- | :- |
ViStatus niRFSG_SelfCalibrateRange (ViSession vi, ViInt64 stepsToOmit, ViReal64 minFrequency, ViReal64 maxFrequency, ViReal64 minPowerLevel, ViReal64 maxPowerLevel);
Self-calibrates all configurations within the specified frequency and peak power level limits.
Self-calibration range data is valid until you restart the system or call the niRFSG_ClearSelfCalibrateRange function.
NI recommends that no external signals are present on the RF In or IQ In ports during the calibration.
|
Note This function does not update self-calibration date and temperature. |
|---|---|
| For best results, NI recommends that you perform self-calibration without omitting any steps. However, if certain aspects of performance are less important for your application, you can omit certain steps for faster calibration. |
|
Note If there is an existing NI-RFSA session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this function runs. |
|---|
|
Note If there is an existing NI-RFSA 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 niRFSA_Commit or niRFSA_Initiate. |
|---|---|
| Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841 |
| Input | ||
|---|---|---|
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. |
| stepsToOmit | ViInt64 |
Specifies which calibration steps to skip during the self-calibration process. The default value is an empty array, which indicates that no calibration steps are omitted. Defined Values: |
| NIRFSG_VAL_SELF_CAL_OMIT_NONE | No calibration steps are omitted. |
|---|---|
| NIRFSG_VAL_SELF_CAL_LO_SELF_CAL | Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted. |
| NIRFSG_VAL_SELF_CAL_POWER_LEVEL_ACCURACY | Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted. |
| NIRFSG_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. |
| NIRFSG_VAL_SELF_CAL_IMAGE_SUPPRESSION | Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted. |
| NIRFSG_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT | Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. |
|
Default Value: NIRFSG_VAL_SELF_CAL_OMIT_NONE |
||
|---|---|---|
| minFrequency | ViReal64 | Specifies the minimum frequency to calibrate. |
| maxFrequency | ViReal64 | Specifies the maximum frequency to calibrate. |
| minPowerLevel | ViReal64 | Specifies the minimum power level to calibrate. |
| maxPowerLevel | ViReal64 | Specifies the maximum power level to calibrate. |
| 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 instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
| :- | :- | :- |
ViStatus niRFSG_GetSelfCalibrationDateAndTime (ViSession vi, ViInt32 module, ViInt32* year, ViInt32* month, ViInt32* day, ViInt32* hour, ViInt32* minute, ViInt32* second);
Returns the date and time of the last successful self-calibration. The time returned is 24-hour local time. For example, if the device was calibrated at 2:30 PM, this function returns 14 for the hours parameter and 30 for the minutes parameter.
Supported Devices: PXI-5610, PXIe-5644/5645/5646, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
| Input | ||
|---|---|---|
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. |
| Module | ViInt32* | Specifies from which stand-alone module to retrieve the last successful self-calibration date and time. |
| Output | ||
| Name | Type | Description |
| year | ViInt32* | Returns the year of the last successful calibration. |
| month | ViInt32* | Returns the month of the last successful calibration. |
| day | ViInt32* | Returns the day of the last successful calibration. |
| hour | ViInt32* | Returns the hour of the last successful calibration. |
| minute | ViInt32* | Returns the minute of the last successful calibration. |
| second | ViInt32* | Returns the second of the last successful calibration. |
| 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 instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
| :- | :- | :- |
ViStatus niRFSG_GetSelfCalibrationTemperature (ViSession vi, ViInt32 module, ViReal64* temperature);
Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.
Supported Devices: PXI-5610, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841
| Input | ||
|---|---|---|
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. |
| Module | ViInt32 |
Specifies from which stand-alone module to retrieve the last successful self-calibration temperature. Defined Values: |
| NIRFSG_VAL_PRIMARY_MODULE | The stand-alone device or the main module in a multi-module device. |
|---|---|
| NIRFSG_VAL_AWG | The AWG associated with the primary module. |
| NIRFSG_VAL_LO | The LO associated with the primary module. |
|
Default Value: NIRFSG_VAL_PRIMARY_MODULE |
||
|---|---|---|
| Output | ||
| Name | Type | Description |
| temperature | ViReal64* | Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration. |
| 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 instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
| :- | :- | :- |
ViStatus niRFSG_GetExternalCalibrationLastDateAndTime (ViSession vi, ViInt32* year, ViInt32* month, ViInt32* day, ViInt32* hour, ViInt32* minute, ViInt32* second);
Returns the date and time of the last successful external calibration. The time returned is 24-hour (military) local time; for example, if the device was calibrated at 2:30 PM, this function returns 14 for the hours parameter and 30 for the minutes parameter.
Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841
| Input | ||
|---|---|---|
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. |
| Output | ||
| Name | Type | Description |
| year | ViInt32* | Returns the year of the last successful calibration. |
| month | ViInt32* | Returns the month of the last successful calibration. |
| day | ViInt32* | Returns the day of the last successful calibration. |
| hour | ViInt32* | Returns the hour of the last successful calibration. |
| minute | ViInt32* | Returns the minute of the last successful calibration. |
| second | ViInt32* | Returns the second of the last successful calibration. |
| 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 instrument driver function to determine if an error occurred. To obtain a text description of the error code, call the niRFSG_GetError function. The general meaning of the status code is as follows: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |
| :- | :- | :- |