Skip to content

NI RFSG Events Attributes

Greg Stoll edited this page Nov 11, 2021 · 2 revisions

Events Attributes

NIRFSG_ATTR_EXPORTED_CONFIGURATION_SETTLED_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150129 ViString R/W N/A None None

Description

Specifies the destination terminal for exporting the Configuration Settled event. To set this attribute, the NI-RFSG device must be in the Configuration state.

Defined Values:

NIRFSG_VAL_DO_NOT_EXPORT_STR The signal is not exported.
NIRFSG_VAL_PXI_TRIG0_STR PXI trigger line 0.
NIRFSG_VAL_PXI_TRIG1_STR PXI trigger line 1.
NIRFSG_VAL_PXI_TRIG2_STR PXI trigger line 2.
NIRFSG_VAL_PXI_TRIG3_STR PXI trigger line 3.
NIRFSG_VAL_PXI_TRIG4_STR PXI trigger line 4.
NIRFSG_VAL_PXI_TRIG5_STR PXI trigger line 5.
NIRFSG_VAL_PXI_TRIG6_STR PXI trigger line 6.
NIRFSG_VAL_PXIE_DSTARC_STR PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.
NIRFSG_VAL_TRIG_OUT_STR TRIG IN/OUT terminal.
Supported Devices: PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Events

PFI Lines

PXI Trigger Lines

NIRFSG_ATTR_CONFIGURATION_SETTLED_EVENT_TERMINAL_NAME

Numeric Value Data
type
Access Coercion High Level Functions
1150194 ViString RO None None

Description

Returns the name of the fully qualified signal name as a string.

Supported Devices: PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841

Default Values:

PXIe-5654/5654 with PXIe-5696: /ModuleName/ConfigurationSettledEvent, where ModuleName is the name of your device in MAX.

PXIe-5830/5831/5832: /BasebandModule/ao/0/ConfigurationSettledEvent, where BasebandModule is the name of the baseband module of your device in MAX.

PXIe-5820/5840/5841: /ModuleName/ao/0/ConfigurationSettledEvent, where ModuleName is the name of your device in MAX.

Related Topics

Events

Syntax for Terminal Names

NIRFSG_ATTR_EXPORTED_DONE_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150063 ViString R/W N/A None niRFSG_ExportSignal

Description

Specifies the destination terminal for exporting the Done event. To set this attribute, the NI-RFSG device must be in the Configuration state.

Defined Values:

NIRFSG_VAL_DO_NOT_EXPORT_STR The signal is not exported.
NIRFSG_VAL_PFI0_STR The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.
NIRFSG_VAL_PFI1_STR The signal is exported to the PFI 1 connector.
NIRFSG_VAL_PFI4_STR The signal is exported to the PFI 4 connector.
NIRFSG_VAL_PFI5_STR The signal is exported to the PFI 5 connector.
NIRFSG_VAL_PXI_TRIG0_STR The signal is exported to the PXI trigger line 0.
NIRFSG_VAL_PXI_TRIG1_STR The signal is exported to the PXI trigger line 1.
NIRFSG_VAL_PXI_TRIG2_STR The signal is exported to the PXI trigger line 2.
NIRFSG_VAL_PXI_TRIG3_STR The signal is exported to the PXI trigger line 3.
NIRFSG_VAL_PXI_TRIG4_STR The signal is exported to the PXI trigger line 4.
NIRFSG_VAL_PXI_TRIG5_STR The signal is exported to the PXI trigger line 5.
NIRFSG_VAL_PXI_TRIG6_STR The signal is exported to the PXI trigger line 6.
NIRFSG_VAL_PXIE_DSTARC_STR The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Triggers

Events

PFI Lines

PXI Trigger Lines

NIRFSG_ATTR_DONE_EVENT_TERMINAL_NAME

Numeric Value Data
type
Access Coercion High Level Functions
1150113 ViString RO None niRFSG_GetTerminalName

Description

Returns the name of the fully qualified signal name as a string.

Default Values:

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/DoneEvent, where AWGName is the name of your associated AWG module in MAX.

PXIe-5830/5831/5832: /BasebandModule/ao/0/DoneEvent, where BasebandModule is the name of the baseband module of your device in MAX.

PXIe-5820/5840/5841: /ModuleName/ao/0/DoneEvent, where ModuleName is the name of your device in MAX.

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Events

Syntax for Terminal Names

Marker

NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR

Numeric Value Data
type
Access Coercion High Level Functions
1150206 ViInt32 R/W None None

Description

Specifies the output behavior for the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.

Defined Values:

NIRFSG_VAL_PULSE Specifies the Marker Event output behavior as pulse.
NIRFSG_VAL_TOGGLE Specifies the Marker Event output behavior as toggle.
Default Value: NIRFSG_VAL_PULSE

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Marker Events

NIRFSG_ATTR_EXPORTED_MARKER_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150064 ViString R/W N/A None niRFSG_ExportSignal

Description

Specifies the destination terminal for exporting the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.

Defined Values:

NIRFSG_VAL_DO_NOT_EXPORT_STR The signal is not exported.
NIRFSG_VAL_PFI0_STR The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.
NIRFSG_VAL_PFI1_STR The signal is exported to the PFI 1 connector.
NIRFSG_VAL_PFI4_STR The signal is exported to the PFI 4 connector.
NIRFSG_VAL_PFI5_STR The signal is exported to the PFI 5 connector.
NIRFSG_VAL_PXI_TRIG0_STR The signal is exported to PXI trigger line 0.
NIRFSG_VAL_PXI_TRIG1_STR The signal is exported to PXI trigger line 1.
NIRFSG_VAL_PXI_TRIG2_STR The signal is exported to PXI trigger line 2.
NIRFSG_VAL_PXI_TRIG3_STR The signal is exported to PXI trigger line 3.
NIRFSG_VAL_PXI_TRIG4_STR The signal is exported to PXI trigger line 4.
NIRFSG_VAL_PXI_TRIG5_STR The signal is exported to PXI trigger line 5.
NIRFSG_VAL_PXI_TRIG6_STR The signal is exported to PXI trigger line 6.
NIRFSG_VAL_PXIE_DSTARC_STR The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Marker Events

PFI Lines

PXI Trigger Lines

Pulse

NIRFSG_ATTR_MARKER_EVENT_PULSE_WIDTH_UNITS

Numeric Value Data
type
Access Coercion High Level Functions
1150208 ViInt32 R/W None None

Description

Specifies the pulse width units for the Marker Event. This attribute is valid only when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_PULSE.

To set this attribute, the NI-RFSG device must be in the Configuration state.

Defined Values:

NIRFSG_VAL_SECONDS Specifies the Marker Event pulse width units as seconds.
NIRFSG_VAL_SAMPLE_CLOCK_PERIODS Specifies the Marker Event pulse width units as Sample Clock periods.
Default Value: NIRFSG_VAL_SECONDS

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Marker Events

NIRFSG_ATTR_MARKER_EVENT_PULSE_WIDTH

Numeric Value Data
type
Access Coercion High Level Functions
1150207 ViReal64 R/W None None

Description

Specifies the pulse width value for the Marker Event. Use the NIRFSG_ATTR_MARKER_EVENT_PULSE_WIDTH_UNITS attribute to set the units for the pulse width value. This attribute is valid only when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_PULSE.

To set this attribute, the NI-RFSG device must be in the Configuration state.

Default Value: 200 ns

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Marker Events

NIRFSG_ATTR_MARKER_EVENT_TERMINAL_NAME

Numeric Value Data
type
Access Coercion High Level Functions
1150115 ViString RO None niRFSG_GetTerminalName

Description

Returns the name of the fully qualified signal name as a string.

Default Values:

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/MarkerXEvent, where AWGName is the name of your associated AWG module in MAX and X is Marker Event 0 through 3.

PXIe-5830/5831/5832: /BasebandModule/ao/0/MarkerXEvent, where BasebandModule is the name of the baseband module of your device in MAX and X is Marker Event 0 through 3.

PXIe-5820/5840/5841: /ModuleName/ao/0/MarkerXEvent, where ModuleName is the name of your device in MAX and X is Marker Event 0 through 3.

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Events

Syntax for Terminal Names

Toggle

NIRFSG_ATTR_MARKER_EVENT_TOGGLE_INITIAL_STATE

Numeric Value Data
type
Access Coercion High Level Functions
1150209 ViInt32 R/W None None

Description

Specifies the initial state for the Marker Event when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_TOGGLE.

To set this attribute, the NI-RFSG device must be in the Configuration state.

Defined Values:

NIRFSG_VAL_DIGITAL_LOW Specifies the initial state of the Marker Event toggle behavior as digital low.
NIRFSG_VAL_DIGITAL_HIGH Specifies the initial state of the Marker Event toggle behavior as digital high.
Default Value: NIRFSG_VAL_DIGITAL_LOW

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Marker Events

NIRFSG_ATTR_EXPORTED_STARTED_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150065 ViString R/W N/A None niRFSG_ExportSignal

Description

Specifies the destination terminal for exporting the Started event. To set this attribute, the NI-RFSG device must be in the Configuration state.

Defined Values:

NIRFSG_VAL_DO_NOT_EXPORT_STR The signal is not exported.
NIRFSG_VAL_PFI0_STR The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.
NIRFSG_VAL_PFI1_STR The signal is exported to the PFI 1 connector.
NIRFSG_VAL_PFI4_STR The signal is exported to the PFI 4 connector.
NIRFSG_VAL_PFI5_STR The signal is exported to the PFI 5 connector.
NIRFSG_VAL_PXI_TRIG0_STR The signal is exported to the PXI trigger line 0.
NIRFSG_VAL_PXI_TRIG1_STR The signal is exported to the PXI trigger line 1.
NIRFSG_VAL_PXI_TRIG2_STR The signal is exported to the PXI trigger line 2.
NIRFSG_VAL_PXI_TRIG3_STR The signal is exported to the PXI trigger line 3.
NIRFSG_VAL_PXI_TRIG4_STR The signal is exported to the PXI trigger line 4.
NIRFSG_VAL_PXI_TRIG5_STR The signal is exported to the PXI trigger line 5.
NIRFSG_VAL_PXI_TRIG6_STR The signal is exported to the PXI trigger line 6.
NIRFSG_VAL_PXIE_DSTARC_STR The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.
Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Events

PFI Lines

PXI Trigger Lines

NIRFSG_ATTR_STARTED_EVENT_TERMINAL_NAME

Numeric Value Data
type
Access Coercion High Level Functions
1150112 ViString RO None niRFSG_GetTerminalName

Description

Returns the name of the fully qualified signal name as a string.

Default Values:

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/StartedEvent, where AWGName is the name of your associated AWG module in MAX.

PXIe-5830/5831/5832: /BasebandModule/ao/0/StartedEvent, where BasebandModule is the name of the baseband module of your device in MAX.

PXIe-5820/5840/5841: /ModuleName/ao/0/StartedEvent, where ModuleName is the name of your device in MAX.

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Events

Syntax for Terminal Names

Timer

NIRFSG_ATTR_TIMER_EVENT_INTERVAL

Numeric Value Data
type
Access Coercion High Level Functions
1150100 ViReal64 R/W None None

Description

Specifies the time before the timer emits an event after the task is started and specifies the time interval between Timer events after the first event.

Note Note  For the PXIe-5820/5840/5841, this attribute must be set for the timer to start. If you do not set this attribute, the timer is disabled.
Units: seconds (s)

Default Value: 0

Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Events

Table of Contents

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