NI RFSG Configuration: Configure Trigger
ViStatus niRFSG_ConfigureSoftwareStartTrigger (ViSession vi);
Configures the Start Trigger for software triggering. Refer to the niRFSG_SendSoftwareEdgeTrigger function for more information about using a software trigger. The NI-RFSG device must be in the Configuration state before calling this function.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
Start Trigger
Trigger Types
| 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_ConfigureDigitalEdgeStartTrigger (ViSession vi, ViConstString source, ViInt32 edge);
Configures the Start Trigger for digital edge triggering. The NI-RFSG device must be in the Configuration state before calling this function.
 |
Note For the PXIe-5654/5654 with PXIe-5696, the Start Trigger is valid only with a timer-based list when RF list mode is enabled. |
|---|---|
| Supported Devices: PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841 |
Related Topics
Start Trigger
Digital Edge Trigger
| 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. |
| source | ViConstString | Specifies the source terminal for the digital edge trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute to this value. |
| edge | ViInt32 | Specifies the active edge for the Start Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE attribute to this 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 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_ConfigureP2PEndpointFullnessStartTrigger (ViSession vi, ViInt64 p2pEndpointFullnessLevel);
Configures the Start Trigger to detect peer-to-peer endpoint fullness. Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the p2pEndpointFullnessLevel parameter. The NI-RFSG device must be in the Configuration state before calling this function.
|
Note Due to an additional internal FIFO in the RF signal generator, the writer peer actually writes 2,304 bytes more than the quantity of data specified by this function to satisfy the trigger level. |
|---|---|
| Supported Devices: PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841 |
Related Topics
Start Trigger
| 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. |
| p2pEndpointFullnessLevel | ViInt64 | Specifies the quantity of data in the FIFO endpoint that asserts the trigger. Units are samples per channel. The default value is -1, which allows NI-RFSG to select the appropriate fullness 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 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_DisableStartTrigger (ViSession vi);
Configures the device not to wait for a Start Trigger. This function is necessary only if you previously configured a Start Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before calling this function.
Supported Devices: PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
Start Trigger
| 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_ConfigureSoftwareScriptTrigger (ViSession vi, ViConstString triggerIdentifier);
Configures the Script Trigger for software triggering. Refer to the niRFSG_SendSoftwareEdgeTrigger function for more information about using the software Script Trigger. The NI-RFSG device must be in the Configuration state before calling this function.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
Script Trigger
Trigger Types
| 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. |
| triggerIdentifier | ViConstString | Specifies the Script Trigger to configure. |
| 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_ConfigureDigitalEdgeScriptTrigger (ViSession vi, ViConstString triggerIdentifier, ViConstString source, ViInt32 edge);
Configures the specified Script Trigger for digital edge triggering. The NI-RFSG device must be in the Configuration state before calling this function.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
Script Trigger
Digital Edge Trigger
| 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. |
| triggerIdentifier | ViConstString | Specifies the Script Trigger to configure. |
| source | ViConstString | Specifies the source terminal for the digital edge Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_SOURCE attribute to this value. |
| edge | ViInt32 | Specifies the active edge for the digital edge Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_EDGE attribute to this 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 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_ConfigureDigitalLevelScriptTrigger (ViSession vi, ViConstString Trigger_Identifier, ViConstString Source, ViInt32 Level);
Configures a specified Script Trigger for digital level triggering. The NI-RFSG device must be in the Configuration state before calling this function.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
Script Trigger
Digital Level Trigger
| 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. |
| triggerIdentifier | ViConstString | Specifies the Script Trigger to configure. |
| source | ViConstString | Specifies the trigger source terminal for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute to this value. |
| Level | ViInt32 | Specifies the active level for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_ACTIVE_LEVEL attribute to this 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 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_DisableScriptTrigger (ViSession vi, ViConstString Trigger_Identifier);
Configures the device not to wait for the specified Script Trigger. Call this function only if you previously configured a Script Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before you call this function.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
Script Trigger
| 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. |
| triggerIdentifier | ViConstString | Specifies the Script trigger to configure. |
| 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_SendSoftwareEdgeTrigger (ViSession vi, ViInt32 trigger, ViConstString triggerIdentifier);
Forces a trigger to occur. The specified trigger generates regardless of whether the trigger has been configured as a software trigger.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
Triggers
| 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. |
| trigger | ViInt32 |
Specifies the trigger to send. Defined Values: |
| NIRFSG_VAL_START_TRIGGER | Specifies the Start Trigger. |
|---|---|
| NIRFSG_VAL_SCRIPT_TRIGGER | Specifies the Script Trigger. |
| Default Value: NIRFSG_VAL_START_TRIGGER | ||
|---|---|---|
| triggerIdentifier | ViConstString |
Specifies the Script Trigger to configure. This parameter is valid only when you set the trigger parameter to NIRFSG_VAL_SCRIPT_TRIGGER. Otherwise, set the triggerIdentifier parameter to "" (empty string). Defined Values: |
| NIRFSG_VAL_SCRIPT_TRIGGER0 | Specifies Script Trigger 0. |
|---|---|
| NIRFSG_VAL_SCRIPT_TRIGGER1 | Specifies Script Trigger 1. |
| NIRFSG_VAL_SCRIPT_TRIGGER2 | Specifies Script Trigger 2. |
| NIRFSG_VAL_SCRIPT_TRIGGER3 | Specifies Script Trigger 3. |
| "" (empty string) | Does not specify a script trigger. |
| Default Value: "" (empty string) |
|---|
| 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_ConfigureDigitalEdgeConfigurationListStepTrigger (ViSession vi, ViConstString source, ViInt32 edge);
Configures the Configuration List Step trigger for digital edge triggering. The NI-RFSG device must be in the Configuration state before you call this function.
Supported Devices: PXIe-5644/5645/5646, PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
RF List Mode
Using RF List Mode
| 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. |
| source | ViConstString | Specifies the trigger source terminal for the digital edge Configuration List Step trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_CONFIGURATION_LIST_STEP_TRIGGER_SOURCE attribute to this value. Refer to this attribute for possible values. |
| edge | ViInt32 | Specifies the active edge for the digital edge Configuration List Step trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_EDGE_CONFIGURATION_LIST_STEP_TRIGGER_EDGE attribute to this 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 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_DisableConfigurationListStepTrigger (ViSession vi)
Configures the device not to receive triggers for the configuration list. The configuration list does not advance steps if this trigger is disabled. Call this function only if a previously configured trigger needs to be disabled. The NI-RFSG device must be in the Configuration state before you call this function.
Supported Devices: PXIe-5644/5645/5646, PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673, PXIe-5820/5830/5831/5832/5840/5841
Related Topics
RF List Mode
Using RF List Mode
| 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_GetTerminalName (ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViInt32 bufferSize, ViChar terminalName[]);
Returns the fully-qualified name of the specified signal. The fully-qualified name is helpful to automatically route signals in a multisegment chassis.
Supported Devices: 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
Triggers
Events
Syntax for Terminal Names
| 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. |
| signal | ViInt32 | Specifies the signal to query. Defined Values: |
| NIRFSG_VAL_START_TRIGGER | Queries the Start Trigger. |
|---|---|
| NIRFSG_VAL_SCRIPT_TRIGGER | Queries a Script Trigger. |
| NIRFSG_VAL_MARKER_EVENT | Queries a Marker Event. |
| NIRFSG_VAL_REF_CLOCK | Queries the Reference Clock. |
| NIRFSG_VAL_STARTED_EVENT | Queries the Started Event. |
| NIRFSG_VAL_DONE_EVENT | Queries the Done Event. |
| NIRFSG_VAL_CONFIGURATION_LIST_STEP_TRIGGER | Queries the Configuration List Step Trigger. |
| NIRFSG_VAL_CONFIGURATION_SETTLED_EVENT | Queries the Configuration Settled Event. |
| Name | Type | Description |
|---|---|---|
| signalIdentifier | ViConstString | Specifies which instance of the selected signal to query. This parameter is necessary when you set the signal parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the signalIdentifier parameter to "" (empty string). |
Defined Values:
| NIRFSG_VAL_SCRIPT_TRIGGER0 | Specifies Script Trigger 0. |
|---|---|
| NIRFSG_VAL_SCRIPT_TRIGGER1 | Specifies Script Trigger 1. |
| NIRFSG_VAL_SCRIPT_TRIGGER2 | Specifies Script Trigger 2. |
| NIRFSG_VAL_SCRIPT_TRIGGER3 | Specifies Script Trigger 3. |
| NIRFSG_VAL_MARKER_EVENT0 | Specifies Marker 0. |
| NIRFSG_VAL_MARKER_EVENT1 | Specifies Marker 1. |
| NIRFSG_VAL_MARKER_EVENT2 | Specifies Marker 2. |
| NIRFSG_VAL_MARKER_EVENT3 | Specifies Marker 3. |
| "" (empty string) | Does not specify a signal identifier. |
| Name | Type | Description |
|---|---|---|
| bufferSize | ViInt32 | Pass the number of bytes in the ViChar buffer you specify for the terminalName parameter. If you pass 0, you can pass VI_NULL for the terminalName parameter. |
Output
| Name | Type | Description |
|---|---|---|
| terminalName | ViChar[] | Returns the string to use as the source for other devices. |
| 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 status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function. The general meaning of the status code is as follows: |
| Value | Meaning |
|---|---|
| 0 | Success |
| Positive Values | Warnings |
| Negative Values | Errors |