NI RFSG General Functions - ni/grpc-device GitHub Wiki
- niRFSG_init
- niRFSG_ConfigureRF
- niRFSG_Initiate
- niRFSG_CheckGenerationStatus
- niRFSG_Abort
- niRFSG_close
ViStatus niRFSG_init (ViRsrc resourceName, ViBoolean idQuery, ViBoolean resetDevice, ViSession* vi);
Opens a session to the device you specify as the resourceName and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG function calls.
Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
NI-RFSG Instrument Driver Programming Flow
| Input | ||
|---|---|---|
| Name | Type | Description |
| resourceName | ViRsrc | Specifies the resource name of the device to initialize. For NI-DAQmx devices, the syntax is the device name specified in MAX. Typical default names for NI-DAQmx devices in MAX are Dev2 or PXISlot2. You can rename an NI-DAQmx device in MAX. You can also specify the name of an IVI logical name configured with the IVI Configuration utility. Refer to the IVI topic of the Measurement & Automation Explorer Help for more information. |
 |
Note NI-RFSG device names are not case-sensitive. However, all IVI names, such as logical names, are case-sensitive. If you use an IVI logical name, make sure the name is identical to the name shown in the IVI Configuration Utility. |
|---|
| :- | :- | :- |
|idQuery|ViBoolean|Specifies whether you want NI-RFSG to perform an ID query.
Defined Values: |
| VI_TRUE (1) | Perform ID query. |
|---|---|
| VI_FALSE (0) | Do not perform ID query. |
| :- | :- | :- |
|reset|ViBoolean|Specifies whether you want to reset the NI-RFSG device during the initialization procedure.
Defined Values:|
| VI_TRUE (1) | Reset device. |
|---|---|
| VI_FALSE (0) | Do not reset device. |
| :- | :- | :- | |Output||| |Name|Type|Description| |vi|ViSession*|Returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG function calls. |
| 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_ConfigureRF (ViSession vi, ViReal64 frequency, ViReal64 powerLevel);
Configures the frequency and power level of the RF output signal. The PXI-5670/5671 and PXIe-5672 device must be in the Configuration state before calling this function. The PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E, and PXIe-5830/5831/5832/5840/5841 device can be in the Configuration or Generation state when you call this function.
Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841
Related Topics
NI-RFSG Instrument Driver Programming Flow
| 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. |
| frequency | ViReal64 | Specifies the frequency of the generated RF signal, in hertz. For arbitrary waveform generation, this parameter specifies the center frequency of the signal. Units: hertz (Hz) |
| powerLevel | ViReal64 | Specifies either the average power level or peak power level of the generated RF signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute. Units: dBm |
| 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_Initiate (ViSession vi);
Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state. If the settings have not been committed to the device before you call this function, they are committed by this function. The operation returns when the RF output signal settles. To return to the Configuration state, call the niRFSG_Abort function.
Supported Devices: PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
NI-RFSG Instrument Driver Programming Flow
| 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_CheckGenerationStatus (ViSession vi, ViBoolean* isDone);
Checks the status of the generation. Call this function to check for any errors that might occur during the signal generation or to check whether the device has finished generating.
Supported Devices: PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
NI-RFSG Instrument Driver Programming Flow
Stopping Pear-to-Peer Generation
| 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 |
| isDone | ViBoolean* | Returns information about the completion of signal generation. Defined Values: |
| VI_TRUE | Signal generation is complete. |
|---|---|
| VI_FALSE | Signal generation is occurring. |
| :- | :- | :- |
| 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_Abort (ViSession vi);
Stops signal generation.
Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
NI-RFSG Programming State Model
| 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_close (ViSession vi);
Aborts any signal generation in progress and destroys the instrument driver session.
|
Note After calling this function, you cannot use NI-RFSG again until you call the niRFSG_init function or the niRFSG_InitWithOptions function. |
|---|---|
| Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841 |
Related Topics
NI-RFSG Instrument Driver Programming Flow
NI-RFSG Programming State Model
| 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 |
| :- | :- | :- |