NI RFmx WLAN General Attributes - ni/grpc-device GitHub Wiki

General Attributes

RFMXWLAN_ATTR_SELECTED_PORTS

Data Type: char []
Access: read/write
Functions: RFmxWLAN_SetAttributeString
RFmxWLAN_GetAttributeString
Description: Specifies the instrument port to be configured to acquire a signal. Use RFmxInstr_GetAvailablePorts function to get the valid port names.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals.

On a MIMO session, this attribute specifies one of the initialized devices. Use 'port::(deviceName)/(channelNumber)' as the format for the selected port. To perform a MIMO measurement, you must configure the selected ports attribute for the configured number of segments and chains.

For PXIe-5830/5831/5832 devices on a MIMO session, the selected port includes the instrument port in the format 'port::(deviceName)/(channelNumber)/(instrPort)'.

Example:

port::myrfsa1/0/if1

You can use the RFmxInstr_BuildPortString function to build the selected port.

Use 'segment(m)/chain(n)' as the selector string to configure or read this attribute. You can use the RFmxWLAN_BuildChainString function to build the selector string.

Default values

Valid valuesPXIe-5830if0, if1 PXIe-5831/5832if0, if1, rf(0-1)/port(x), where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel Other devices'' (empty string)

PXIe-5830/5831/5832 if1

Other devices '' (empty string)


Get Function: RFmxWLAN_GetSelectedPorts
Set Function: RFmxWLAN_SetSelectedPorts

RFMXWLAN_ATTR_CENTER_FREQUENCY

Data Type: float64
Access: read/write
Functions: RFmxWLAN_SetAttributeF64
RFmxWLAN_GetAttributeF64
Description: Specifies the expected carrier frequency of the RF signal that needs to be acquired. This value is expressed in Hz. The signal analyzer tunes to this frequency.

You do not need to use a selector string to configure or read this attribute for the default signal instance. On a MIMO session, use 'segment(n)' along with a named or default signal instance as the selector string to configure or read this attribute. Refer to the Selector Strings topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Get Function: RFmxWLAN_GetCenterFrequency
Set Function: RFmxWLAN_SetCenterFrequency

RFMXWLAN_ATTR_REFERENCE_LEVEL

Data Type: float64
Access: read/write
Functions: RFmxWLAN_SetAttributeF64
RFmxWLAN_GetAttributeF64
Description: Specifies the reference level which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.

You do not need to use a selector string to configure or read this attribute for the default signal instance. On a MIMO session, use port::(deviceName)/(channelNumber) as a selector string to configure or read this attribute per port. If you do not specify port string, this attribute is configured for all ports. Refer to the Selector Strings topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Get Function: RFmxWLAN_GetReferenceLevel
Set Function: RFmxWLAN_SetReferenceLevel

RFMXWLAN_ATTR_EXTERNAL_ATTENUATION

Data Type: float64
Access: read/write
Functions: RFmxWLAN_SetAttributeF64
RFmxWLAN_GetAttributeF64
Description: Specifies the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.

You do not need to use a selector string to configure or read this attribute for the default signal instance. On a MIMO session, use port::(deviceName)/(channelNumber) as a selector string to configure or read this attribute per port. If you do not specify port string, this attribute is configured for all ports. Refer to the Selector Strings topic for information about the string syntax for named signals.

The default value is 0.

Get Function: RFmxWLAN_GetExternalAttenuation
Set Function: RFmxWLAN_SetExternalAttenuation

RFMXWLAN_ATTR_REFERENCE_LEVEL_HEADROOM

Data Type: float64
Access: read/write
Functions: RFmxWLAN_SetAttributeF64
RFmxWLAN_GetAttributeF64
Description: Specifies the margin RFmx adds to the RFMXWLAN_ATTR_REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the RFMXWLAN_ATTR_REFERENCE_LEVEL plus the RFMXWLAN_ATTR_REFERENCE_LEVEL_HEADROOM. If you know the input power of the signal precisely or previously included the margin in the RFMXWLAN_ATTR_REFERENCE_LEVEL, you could improve the signal-to-noise ratio by reducing the RFMXWLAN_ATTR_REFERENCE_LEVEL_HEADROOM.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals.

Supported devices: PXIe-5668, PXIe-5830/5831/5832/5840/5841.

Default values

PXIe-5668 6 dB

PXIe-5830/5831/5832/5841 1 dB

PXIe-5840 0 dB


Get Function: RFmxWLAN_GetReferenceLevelHeadroom
Set Function: RFmxWLAN_SetReferenceLevelHeadroom

RFMXWLAN_ATTR_STANDARD

Data Type: int32
Access: read/write
Functions: RFmxWLAN_SetAttributeI32
RFmxWLAN_GetAttributeI32
Description: Specifies the signal under analysis as defined in IEEE RFMXWLAN_ATTR_STANDARD 802.11.

On a MIMO session, the supported standards are 802.11n, 802.11ac, 802.11ax, and 802.11be.You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals.

The default value is RFMXWLAN_VAL_STANDARD_802_11_AG.11a/g.

Get Function: RFmxWLAN_GetStandard
Set Function: RFmxWLAN_SetStandard
Values:
RFMXWLAN_VAL_STANDARD_802_11_AG (0) Corresponds to the OFDM based PPDU formats as defined in IEEE Standard 802.11a-1999 and IEEE Standard 802.11g-2003.
RFMXWLAN_VAL_STANDARD_802_11_B (1) Corresponds to the DSSS based PPDU formats as defined in IEEE Standard 802.11b-1999.
RFMXWLAN_VAL_STANDARD_802_11_J (2) Corresponds to the OFDM based PPDU formats as defined in IEEE Standard 802.11j-2004.
RFMXWLAN_VAL_STANDARD_802_11_P (3) Corresponds to the OFDM based PPDU formats as defined in IEEE Standard 802.11p-2010.
RFMXWLAN_VAL_STANDARD_802_11_N (4) Corresponds to the OFDM based PPDU formats as defined in IEEE Standard 802.11n-2009.
RFMXWLAN_VAL_STANDARD_802_11_AC (5) Corresponds to the OFDM based PPDU formats as defined in IEEE Standard 802.11ac-2013.
RFMXWLAN_VAL_STANDARD_802_11_AX (6) Corresponds to the OFDM based PPDU formats as defined in IEEE Standard P802.11ax/D8.0.
RFMXWLAN_VAL_STANDARD_802_11_BE (7) Corresponds to the OFDM based PPDU formats as defined in IEEE Standard P802.11be/D1.3.

| :- | :- |

RFMXWLAN_ATTR_RESULT_FETCH_TIMEOUT

Data Type: float64
Access: read/write
Functions: RFmxWLAN_SetAttributeF64
RFmxWLAN_GetAttributeF64
Description: Specifies the time, in seconds, to wait before results are available in the RFmxWLAN_AttributeNode. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxWLAN Attribute Node waits until the measurement is complete.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals.

The default value is 10.

Get Function: RFmxWLAN_GetResultFetchTimeout
Set Function: RFmxWLAN_SetResultFetchTimeout
⚠️ **GitHub.com Fallback** ⚠️