WLAN Generation

Defines a root class which is used to identify and control wlan signal generation configuration.

class nirfmxwlangen.wlangen.Session(toolkit_compatibility_version, session_name=None, *, grpc_options=None)[source]

Bases: object

Defines a root class which is used to identify and control wlan signal generation configuration.

channel_number_to_carrier_frequency(frequency_band, channel_bandwidth, channel_number, secondary_factor, channel_starting_factor)[source]

Calculates the carrier frequency according to the numbering scheme by converting a set of input parameters, including the channel number, for IEEE 802.11a/b/g/j/n/p, IEEE 802.11ac, IEEE 802.11ah, IEEE 802.11af, and IEEE P802.11ax/D8.0 standards.

Parameters:

frequency_band (int) –
Specifies whether to use the 2.4 GHz or the 5 GHz band. The default value is NIWLANG_VAL_FREQUENCY_BAND_2p4GHZ .

Value

Description

NIWLANG_VAL_FREQUENCY_BAND_2p4GHZ (0)

Specifies a frequency band of 2.4 GHz.

NIWLANG_VAL_FREQUENCY_BAND_5GHZ (1)

Specifies a frequency band of 5 GHz.
channel_bandwidth (float) – Specifies the channel bandwidth Valid values are 5 MHz, 10 MHz, 20 MHz, and 40 MHz. This value is expressed in Hz.
channel_number (int) – Specifies the offset of the center frequency above the starting frequency of the channel. When you set the channel_bandwidth parameter to 40 MHz, the channel_number parameter is the primary channel number and the corresponding channel center frequency is the primary channel center frequency. This value is expressed in increments of 5 MHz.
secondary_factor (int) –
Specifies whether the secondary channel is above or below the primary channel when you set the channel_bandwidth parameter to 40 MHz. The WLAN Generation creates a 40 MHz channel by combining the primary channel and the secondary channel, where the channels have a bandwidth of 20 MHz.The secondary channel number is given by the following formula: secondary channel number = primary channel number + (4 *secondary factor)

The secondary channel center frequency is given by the following formula: secondary channel center frequency (Hz) = channel starting frequency (Hz) + (secondary channel number * 5 MHz)

Valid values are -1 and +1.
channel_starting_factor (float) – Specifies the value used to define the baseline frequency. The channel start frequency is given by the following formula: channel starting frequency (Hz) = (channel starting factor * 500 kHz)

Returns:

carrier_frequency (float):: Returns the carrier frequency. This value is expressed in Hz. This function calculates the carrier frequency using the following equation: Carrier frequency (Hz) = channel starting frequency (Hz) + (channel number * 5 MHz).
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (carrier_frequency, error_code)

channel_number_to_carrier_frequency_802_11_abgjpn(channel_starting_frequency, channel_bandwidth, channel_number, secondary_factor)[source]

Calculates the carrier frequency of 802.11a/b/g/j/p/n channels according to sections 16.4.6, 17.4.6, 18.3.8.4, and 20.3.15 of IEEE Standard 802.11-2012.

Parameters:

channel_starting_frequency (float) – Specifies the starting frequency of the frequency band. This value is expressed in Hz.
channel_bandwidth (float) – Specifies the channel bandwidth You can choose a 5 MHz, 10 MHz, 20 MHz, or 40 MHz channel. This value is expressed in Hz.
channel_number (int) – Specifies the offset of the center frequency, in increments of 5 MHz, above the starting frequency of the channel.
secondary_factor (int) –
Specifies whether the secondary channel is above or below the primary channel when you set the channel_bandwidth parameter to 40 MHz. The WLAN Generation creates a 40 MHz channel by combining the primary channel and the secondary channel, each with a 20 MHz bandwidth.

The value of -1 indicates that the secondary channel is below the primary channel whereas the value of +1 indicates that the secondary channel is above the primary channel. Valid values are -1 and +1.

Returns:

carrier_frequency (float):

Returns the carrier frequency. This value is expressed in Hz. The function calculates the carrier frequency using the following equation: Carrier frequency (Hz) = channel starting frequency (Hz) + (channel number * 5 MHz)

When you set the channel_bandwidth parameter to 40 MHz, the channel_number parameter is the primary channel number. The function calculates the carrier frequency using the following equation:

carrier frequency (Hz) = channel starting frequency (Hz) + (channel number * 5 MHz)+ (Secondary factor * 20 MHz)

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (carrier_frequency, error_code)

channel_number_to_carrier_frequency_802_11_ac(channel_starting_frequency, channel_number)[source]

Calculates carrier frequency of 802.11ac channels according to section 22.3.14 of IEEE Standard 802.11ac-2013.

Parameters:

channel_starting_frequency (float) – Specifies the start frequency of the frequency band. This value is expressed in Hz.
channel_number (int) – Specifies the offset of the center frequency above the starting frequency of the channel. This value is expressed in increments of 5 MHz.

Returns:

carrier_frequency (float):

Returns the carrier frequency. This value is expressed in Hz. The function calculates the carrier frequency using the following equation:

Carrier frequency (Hz) = channel starting frequency (Hz) + (channel number * 5 MHz)

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (carrier_frequency, error_code)

channel_number_to_carrier_frequency_802_11_af(channel_starting_frequency, channel_bandwidth, channel_number, tvht_mode)[source]

Calculates the carrier frequency of 802.11af channels, as defined in section 23.3.14 of IEEE Standard 802.11af-2013.

Parameters:

channel_starting_frequency (float) –
Specifies the start frequency of the frequency band. The default value is 45 MHz. The channel start frequency is given by the following formula:

Channel Starting Frequency (Hz) = Channel Starting Factor * 500 kHz This value is expressed in Hz.
channel_bandwidth (float) – Specifies the channel bandwidth used for transmitting the signal. The default value is 6 MHz. This value is expressed in Hz.
channel_number (int) – Specifies the offset of the center frequency, in increments of the channel bandwidth used for transmitting the signal. This value is expressed in Hz. The default value is 1 MHz.

tvht_mode (enums.TvhtMode, int) –

Specifies the mode of the 802.11af signal transmission.

The default value is NIWLANG_VAL_TVHT_MODE_4 .

Value	Description
NIWLANG_VAL_TVHT_MODE_1 (0)	Specifies the TVHT mode representing a single Basic Channel Unit (BCU).
NIWLANG_VAL_TVHT_MODE_2C (1)	Specifies the TVHT mode representing two contiguous BCUs.
NIWLANG_VAL_TVHT_MODE_2N (2)	Specifies the TVHT mode representing two noncontiguous BCUs.
NIWLANG_VAL_TVHT_MODE_4C (3)	Specifies the TVHT mode representing four contiguous BCUs.
NIWLANG_VAL_TVHT_MODE_4N (4)	Specifies the TVHT mode representing two noncontiguous frequency segments, each of which are composed of two BCUs.

Returns:

carrier_frequency (float):: Returns the carrier frequency. This value is expressed in Hz. The function calculates the carrier frequency using the following equation: carrier frequency (Hz) = channel starting frequency (Hz) + (TVHT_W * channel number ) + channel center frequency correction (Hz) where channel center frequency correction (Hz) is used to adjust the carrier frequency in the different TVHT modes. It is 0 for NIWLANG_VAL_TVHT_MODE_1 and NIWLANG_VAL_TVHT_MODE_2N , 0.5 * TVHT_W for NIWLANG_VAL_TVHT_MODE_2C and NIWLANG_VAL_TVHT_MODE_4N and 1.5 * TVHT_W for NIWLANG_VAL_TVHT_MODE_4C .
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (carrier_frequency, error_code)

channel_number_to_carrier_frequency_802_11_ah(channel_starting_frequency, channel_number)[source]

Calculates the carrier frequency of 802.11ah channels according to section 22.3.13 of IEEE P802.11ah/D1.3.

Parameters:

channel_starting_frequency (float) – Specifies the start frequency of the frequency band. This value is expressed in Hz.
channel_number (int) – Specifies the offset of the center frequency above the starting frequency of the channel. This value is expressed in increments of 5 MHz.

Returns:

carrier_frequency (float):

Returns the carrier frequency. This value is expressed in Hz. The function calculates the carrier frequency using the following formula:

carrier frequency (Hz) = channel starting frequency (Hz) + (channel number * 0.5 MHz)

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (carrier_frequency, error_code)

channel_number_to_carrier_frequency_802_11_ax(channel_starting_frequency, channel_number)[source]

Calculates the carrier frequency of the 802.11ax channels.

Parameters:

channel_starting_frequency (float) – Specifies the start frequency of the frequency band. This value is expressed in Hz.
channel_number (int) – Specifies the offset of the center frequency, in increments of 5 MHz, above the start frequency of the channel. The default value is 1.

Returns:

carrier_frequency (float):

Returns the carrier frequency. This value is expressed in Hz. The function calculates the carrier frequency using the following formula:

carrier frequency (Hz) = channel starting frequency (Hz) + (channel number * 5 MHz)

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (carrier_frequency, error_code)

close()[source]: Closes the wlan generation session and releases resources associated with that session. Call this function once for each uniquely named session that you have created..

create_and_write_waveforms_to_file(file_path, file_operation)[source]

Creates waveforms according to the properties configured in an niWLAN generation session and saves the waveforms to a file. In addition to creating the waveform, this function also saves the HEADROOM and IQ_RATE attributes for each waveform. The function reads the RF_BLANKING_MARKER_POSITIONS attribute and saves the value to the file. The RF_BLANKING_MARKER_POSITIONS attribute stored in the file is applicable to all waveforms stored in the file. Additionally, this function saves the SIGNAL_BANDWIDTH attribute for each waveform, which is computed as:

Signal Bandwidth = 2* {(Channel Bandwidth/2) + |Max Carrier Frequency Offset|}

Parameters:

file_path (string) – Specifies the absolute path to the TDMS file to which the WLAN Generation writes the waveforms.

file_operation (enums.FileOperationMode, int) –

Specifies the operation to perform on the file. The default value is NIWLANG_VAL_FILE_OPERATION_MODE_CREATE_OR_REPLACE .

Value	Description
NIWLANG_VAL_FILE_OPERATION_MODE_OPEN (0)	Opens an existing file to write the niWLANG settings.
NIWLANG_VAL_FILE_OPERATION_MODE_OPEN_OR_CREATE (1)	Opens an existing file or creates a new file if the file does not exist.
NIWLANG_VAL_FILE_OPERATION_MODE_CREATE_OR_REPLACE (2)	Creates a new file or replaces a file if it exists.
NIWLANG_VAL_FILE_OPERATION_MODE_CREATE (3)	Creates a new file.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

create_mimo_waveforms_complex_f64(reset, waveforms)[source]

Creates WLAN I/Q data for multiple channels and returns the data as an array of complex waveforms. This function returns one frame, including the idle interval, at a time.

For multiframe generation, set the reset parameter to NIWLANG_VAL_FALSE and run the function in a loop for the specified number of times or until the done parameter is NIWLANG_VAL_TRUE.

Use this function if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM.

Parameters:

reset (int) – Specifies whether to reset the internal states in the created waveform. Set this parameter to NIWLANG_VAL_TRUE for the first frame of the generation or if you want to reset the pseudonoise (PN) seed.
waveforms (numpy.complex128) – Returns the WLAN I/Q data. The waveforms are written sequentially in the array. Allocate an array at least as large as numberOfTxChains times individualWaveformSize for this parameter.

Returns:

t0 (float):: Returns the starting time. The size of this array must be at least equal to value of the numberOfTxChains parameter. This value is expressed in seconds.
dt (float):: Returns the time interval between baseband I/Q samples. The size array must be at least equal to value of the number_of_tx_chains parameter. This value is expressed in seconds.
done (bool):: Indicates whether the function has generated all data. If you generate multiple frames, you can include this function in a while loop and use the done parameter as the terminating condition.
error_code (int):: 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 the function to determine if an error occurred. To obtain a text description of the status code, call the get_error_string() function.

Return type:

Tuple (t0, dt, done, error_code)

create_trigger_frame_msdu(channel_string)[source]

Creates 802.11ax, 802.11be or 802.11bn trigger frame MSDU bits according to the configuration you specify. You must set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM and the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU to configure this function.

Parameters:

channel_string (string) – Set this parameter to “” (empty string) or NULL.

Returns:

generation_done (bool):: Indicates whether the function has generated all the data.
trigger_frame_msdu_bits (int):: Returns an array of the encoded bits trace.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (generation_done, trigger_frame_msdu_bits, error_code)

create_waveform_complex_f64(reset, waveform)[source]

Creates WLAN I/Q data and returns the data as a complex waveform. This function returns one frame, including the idle interval, at a time. For multi-frame generation, set the reset parameter to NIWLANG_VAL_FALSE and run the function in a loop for the specified number of times or until the done parameter is NIWLANG_VAL_TRUE.

Use this function if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM.

Parameters:

reset (bool) – Specifies whether to reset the internal states in the created waveform. Set this parameter to NIWLANG_VAL_TRUE for the first frame of the generation or if you want to reset the pseudonoise (PN) seed.
waveform (numpy.complex128) – Returns the WLAN I/Q data. This parameter must be at least the size of the

Returns:

t0 (float):: Returns the starting time. This value is expressed in seconds.
dt (float):: Returns the time interval between baseband I/Q samples. This value is expressed in seconds.
done (bool):: Indicates whether the function has generated all the data. If you generate multiple frames, you can include this function in a while loop and use the done parameter as the terminating condition.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (t0, dt, done, error_code)

get_2xldpc_enabled(channel_string)[source]

Gets whether to enable 2xLDPC for 802.11bn MU PPDU and 802.11bn TB PPDU signals.

You must use the following active channel string formats to configure this attribute.

Standard Attribute Value	Active Channel String Format
80211BN MIMOOFDM	“userx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU

The default value is NIWLANG_VAL_FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TwoxLdpcEnabled):: Specifies whether to enable 2xLDPC for 802.11bn MU PPDU and 802.11bn TB PPDU signals.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_80211ah_preamble_type(channel_string)[source]

Gets the preamble type of packet if you set the STANDARD attribute to 80211AH MIMO OFDM as defined in section 24.3.8.2 of IEEE Standard P802.11ah/D1.3.

The default value is NIWLANG_VAL_80211AH_PREAMBLE_TYPE_SHORT.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PreambleType80211ah):: Specifies the preamble type of packet if you set the STANDARD attribute to 80211AH MIMO OFDM as defined in section 24.3.8.2 of IEEE Standard P802.11ah/D1.3.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_80211n_plcp_frame_format(channel_string)[source]

Gets the format of the physical layer convergence protocol (PLCP) frame structure. The frame structure determines the arrangement of preambles, header (SIGNAL field), and payload in a frame as defined in section 20.3.2 of IEEE Standard 802.11n-2009.

The default value is NIWLANG_VAL_80211N_PLCP_FRAME_FORMAT_MIXED.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PlcpFrameFormat80211n):: Specifies the format of the physical layer convergence protocol (PLCP) frame structure. The frame structure determines the arrangement of preambles, header (SIGNAL field), and payload in a frame as defined in section 20.3.2 of IEEE Standard 802.11n-2009.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_actual_headroom(channel_string)[source]

Gets the actual headroom that the WLAN Generation applies to the waveform. This value is expressed in dB. Use an active channel string to query this attribute for a transmit channel.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM you must use an empty active channel string to query this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, you must use a ‘channelx’ active channel string to query this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, you must use ‘[segmenty/]channelx’ as the active channel string to query this attribute. ‘[segment0/]’ is optional if the NUMBER_OF_SEGMENTS attribute is set to 1. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use ‘[segmenty/]channelx’ as the active channel string to query this attribute. ‘[segment0/]’ is optional if the NUMBER_OF_SEGMENTS attribute is set to 1. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use ‘channelx’ as the active channel string when the MULTI_SEGMENT_GENERATION_MODE attribute is set to NIWLANG_VAL_SINGLE_GENERATOR.

Refer to the Configuring Active Channels (LabWindows/CVI) help topic for more information about configuring active channels.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Returns the actual headroom that the WLAN Generation applies to the waveform. This value is expressed in dB. Use an active channel string to query this attribute for a transmit channel.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_actual_ofdm_data_rate(channel_string)[source]

Gets the OFDM data rate depending upon the values of the CHANNEL_BANDWIDTH and OFDM_DATA_RATE attributes, only if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, or if you set the NON_HT_MODULATION_MODE attribute to NIWLANG_VAL_NON_HT_MODULATION_MODE_ON. This value is expressed in Mbps. For more information about the OFDM data rate, refer to section 17.2.3.3 of IEEE Standard 802.11-2007.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Returns the OFDM data rate depending upon the values of the CHANNEL_BANDWIDTH and OFDM_DATA_RATE attributes, only if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, or if you set the NON_HT_MODULATION_MODE attribute to NIWLANG_VAL_NON_HT_MODULATION_MODE_ON. This value is expressed in Mbps. For more information about the OFDM data rate, refer to section 17.2.3.3 of IEEE Standard 802.11-2007.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_all_iq_impairments_enabled(channel_string)[source]

Gets whether to apply I/Q impairments such as I DC offset, Q DC offset, quadrature skew, and I/Q gain imbalance to the waveform.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AllIQImpairmentsEnabled):: Specifies whether to apply I/Q impairments such as I DC offset, Q DC offset, quadrature skew, and I/Q gain imbalance to the waveform.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_ampdu_enabled(channel_string)[source]

Gets whether all medium access control (MAC) protocol data units (MPDUs) are transmitted as aggregate-MPDU (A-MPDU).

This attribute is applicable only if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM and the NON_HT_MODULATION_MODE attribute to NIWLANG_VAL_NON_HT_MODULATION_MODE_OFF.

The default value is NIWLANG_VAL_TRUE, if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM.

The default value is NIWLANG_VAL_TRUE, if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpduEnabled):: Specifies whether all medium access control (MAC) protocol data units (MPDUs) are transmitted as aggregate-MPDU (A-MPDU).
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_headroom_enabled(channel_string)[source]

Gets whether the WLAN Generation calculates the headroom or uses a user-defined value. For multiframe generation, the WLAN Generation uses the headroom calculated on the first frame to scale the waveform. NI recommends that you do not set this attribute to NIWLANG_VAL_TRUE for multiframe generation because variation of the peak-to-average power ratio (PAPR) across frames may lead to excessive clipping. To avoid excessive clipping, set this attribute to NIWLANG_VAL_TRUE and use the default values for the HEADROOM attribute.

The default value is NIWLANG_VAL_TRUE.

Use this attribute only if you set the COMPATIBILITY_VERSION attribute to NIWLANG_VAL_COMPATIBILITY_VERSION_030000, NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or NIWLANG_VAL_COMPATIBILITY_VERSION_060000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoHeadroomEnabled):: Specifies whether the WLAN Generation calculates the headroom or uses a user-defined value. For multiframe generation, the WLAN Generation uses the headroom calculated on the first frame to scale the waveform. NI recommends that you do not set this attribute to NIWLANG_VAL_TRUE for multiframe generation because variation of the peak-to-average power ratio (PAPR) across frames may lead to excessive clipping. To avoid excessive clipping, set this attribute to NIWLANG_VAL_TRUE and use the default values for the HEADROOM attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_payload_data_length_mode(channel_string)[source]

Gets whether to use the value specified in PAYLOAD_DATA_LENGTH attribute or automatically compute the data length of the MPDUs in an AMPDU. The default value is NIWLANG_VAL_AUTO_PAYLOAD_DATA_LENGTH_MODE_DISABLED.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoPayloadDataLengthMode):: Specifies whether to use the value specified in PAYLOAD_DATA_LENGTH attribute or automatically compute the data length of the MPDUs in an AMPDU. The default value is NIWLANG_VAL_AUTO_PAYLOAD_DATA_LENGTH_MODE_DISABLED.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_average_power_reference(channel_string)[source]

Gets the portions of the packet used to compute the average power value to apply waveform power scaling and additive white Gaussian noise (AWGN). This attribute is valid when you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM and the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_ELR_PPDU.

The default value is NIWLANG_VAL_AVERAGE_POWER_REFERENCE_NON_BOOSTED_FIELDS.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AveragePowerReference):: Specifies the portions of the packet used to compute the average power value to apply waveform power scaling and additive white Gaussian noise (AWGN). This attribute is valid when you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM and the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_ELR_PPDU.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_awgn_enabled(channel_string)[source]

Gets whether to introduce additive white Gaussian noise (AWGN) to the baseband waveform. the WLAN Generation uses the value specified in the CARRIER_TO_NOISE_RATIO attribute to add the AWGN.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AwgnEnabled):: Specifies whether to introduce additive white Gaussian noise (AWGN) to the baseband waveform. the WLAN Generation uses the value specified in the CARRIER_TO_NOISE_RATIO attribute to add the AWGN.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_bss_color(channel_string)[source]

Gets the identifier of the BSS (Basic Service Set) from which the 802.11ax PPDU, 802.11be PPDU and 802.11bn PPDU are transmitted.

The default value is 63. The valid values are 0 to 63, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the identifier of the BSS (Basic Service Set) from which the 802.11ax PPDU, 802.11be PPDU and 802.11bn PPDU are transmitted.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_burst_start_locations(channel_string)[source]

Gets the array of sample positions of start of the burst, within the waveform.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Returns the array of sample positions of start of the burst, within the waveform.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_burst_stop_locations(channel_string)[source]

Gets the array of sample positions of end of the burst, within the waveform.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Returns the array of sample positions of end of the burst, within the waveform.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_carrier_frequency(channel_string)[source]

Gets the carrier frequency for signal generation. This value is expressed in Hz. If you set the MULTI_SEGMENT_GENERATION_MODE attribute to NIWLANG_VAL_SINGLE_GENERATOR, you must set this attribute for each segment using the active channel string ‘segmenty’.

The default value is 2.412 GHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the carrier frequency for signal generation. This value is expressed in Hz. If you set the MULTI_SEGMENT_GENERATION_MODE attribute to NIWLANG_VAL_SINGLE_GENERATOR, you must set this attribute for each segment using the active channel string ‘segmenty’.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_carrier_frequency_offset(channel_string)[source]

Gets the offset in the center frequency of the complex baseband signal from the Carrier Frequency. This value is expressed in Hz.

You must use the following active channel string formats to configure this attribute.

Standard Attribute Attribute	Active Channel String Format
80211AC MIMOOFDM, 80211AF MIMOOFDM	“segmentx”
80211A/G OFDM, 80211J OFDM, 80211P OFDM, 80211B/G DSSS, 80211G DSSSOFDM, 80211N MIMOOFDM, 80211AH MIMOOFDM, 80211AF MIMOOFDM	“” (empty string)
80211AX MIMOOFDM	“segmentx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211AX MIMOOFDM	“[userx]/segmenty”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BE MIMOOFDM	“” (empty string), if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211BE MIMOOFDM	“[userx]”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BN MIMOOFDM	“” (empty string), if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_ELR_PPDU
80211BN MIMOOFDM	“[userx]”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)

The default value is 0. Valid value is -(1/2) * IQ Rate to (1/2) * IQ Rate, inclusive, where IQ Rate is the value of the IQ_RATE attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the offset in the center frequency of the complex baseband signal from the Carrier Frequency. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_carrier_to_noise_ratio(channel_string)[source]

Gets the carrier-to-noise ratio (CNR)of the waveform generated. This value is expressed in dB. Noise bandwidth is equal to the value of the IQ_RATE attribute. the WLAN Generation ignores the CARRIER_TO_NOISE_RATIO attribute if you set the AWGN_ENABLED attribute to NIWLANG_VAL_TRUE.

Standard Attribute Attribute	Active Channel String Format
80211A/G OFDM, 80211J OFDM, 80211P OFDM, 80211B DSSS, 80211G DSSSOFDM	“” (empty string)
80211N MIMOOFDM, 80211AH MIMOOFDM	“channelx”
80211AC MIMOOFDM, 80211AF MIMOOFDM	“segmentx/channely”
80211AX MIMOOFDM	“segmentx/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211AX MIMOOFDM	“[userx]/segmenty/channelz”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BE MIMOOFDM	“channelx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211BE MIMOOFDM	“[userx]/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BN MIMOOFDM	“channelx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_ELR_PPDU
80211BN MIMOOFDM	“[userx]/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)

The default value is 50. Valid values are -100 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the carrier-to-noise ratio (CNR)of the waveform generated. This value is expressed in dB. Noise bandwidth is equal to the value of the IQ_RATE attribute. the WLAN Generation ignores the CARRIER_TO_NOISE_RATIO attribute if you set the AWGN_ENABLED attribute to NIWLANG_VAL_TRUE.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_channel_bandwidth(channel_string)[source]

Gets the channel width used for transmitting the signal. This value is expressed in Hz.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, the channel bandwidth must be equal to 20 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211J_OFDM, the channel bandwidth must be equal to 10 MHz or 20 MHz. NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, the channel bandwidth must be equal to 5 MHz, 10 MHz, or 20 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM, the channel bandwidth must be either 20 MHz or 40 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, the channel bandwidth must be either 20 MHz, or 40 MHz, or 80 MHz, or 160 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, the channel bandwidth must be either 20 MHz, or 40 MHz, or 80 MHz, or 160 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, the channel bandwidth must be either 20 MHz, or 40 MHz, or 80 MHz, or 160 MHz or 320 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, the channel bandwidth must be either 20 MHz, or 40 MHz, or 80 MHz, or 160 MHz or 320 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, the channel bandwidth must be equal to 1MHz, 2 MHz, 4 MHz, 8 MHz, or 16 MHz. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, the channel bandwidth must be equal to 6 MHz, 7 MHz or 8 MHz. For OFDM signals, channel bandwidth determines the number of pilot and data subcarriers used. the WLAN Generation ignores the CHANNEL_BANDWIDTH attribute for other values of the STANDARD attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the channel width used for transmitting the signal. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_channelization(channel_string)[source]

Gets the 320 MHz channelization value if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_OFDM or NIWLANG_VAL_STANDARD_80211BN_OFDM. As defined in section 36.3.24.2 of IEEE P802.11be/D7.0 for 320 MHz channel. 320 MHz-1 consists of 320 MHz channels with channel center frequency numbers 31, 95 and 159. 320 MHz-2 consists of 320 MHz channels with channel center frequency numbers 63, 127 and 191.

The default value is NIWLANG_VAL_CHANNEL_320MHZ_1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.Channelization):: Specifies the 320 MHz channelization value if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_OFDM or NIWLANG_VAL_STANDARD_80211BN_OFDM. As defined in section 36.3.24.2 of IEEE P802.11be/D7.0 for 320 MHz channel. 320 MHz-1 consists of 320 MHz channels with channel center frequency numbers 31, 95 and 159. 320 MHz-2 consists of 320 MHz channels with channel center frequency numbers 63, 127 and 191.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_compatibility_version(channel_string)[source]

Indicates the compatibilityVersion parameter of the open_session() function.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CompatibilityVersion):: Indicates the compatibilityVersion parameter of the open_session() function.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cyclic_time_shift(channel_string)[source]

Gets the value of Cyclic Time Shift applied to each Transmit Chain signals.

This attribute is applicable only if the MAPPING_MATRIX_TYPE attribute is set to NIWLANG_VAL_MAPPING_MATRIX_TYPE_DIRECT, NIWLANG_VAL_MAPPING_MATRIX_TYPE_HADAMARD or NIWLANG_VAL_MAPPING_MATRIX_TYPE_FOURIER and standard is set to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, and PPDU_TYPE is set to NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_MU_PPDU, NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU, or NIWLANG_VAL_PPDU_TYPE_ELR_PPDU.

This attribute is not applicable if PPDU_TYPE is set to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and MNIWLANG_MAPPING_MATRIX_TYPE is set to NIWLANG_VAL_MAPPING_MATRIX_TYPE_USER_SPECIFIC.

The default value is 0. The supported range for this attribute is -32 us to 32 us. You must use Active Channel String as Channelx for all standards to set this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the value of Cyclic Time Shift applied to each Transmit Chain signals.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_distribution_bandwidth(channel_string)[source]

Gets the bandwidth across which RU subcarriers are spread, when you set RU Type attribute to dRU.

This attribute is applicable only for 802.11bn TB PPDU.

You must use the following active channel string formats to configure this attribute.

Standard Attribute Value	Active Channel String Format
80211BN MIMOOFDM	“userx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU

The default value is 20M.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the bandwidth across which RU subcarriers are spread, when you set RU Type attribute to dRU.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dsss_data_rate(channel_string)[source]

Gets the data rate for the direct sequence spread spectrum (DSSS) payload, as defined in IEEE Standard 802.11b-1999 and the extended rate physical layer-packet binary convolutional coding (ERP -PBCC) mode, as defined in IEEE Standard 802.11g-2003. This value is expressed in Mbps.

Configure this attribute only if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BG_DSSS.

The default value is NIWLANG_VAL_DSSS_DATA_RATE_1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssDataRate):: Specifies the data rate for the direct sequence spread spectrum (DSSS) payload, as defined in IEEE Standard 802.11b-1999 and the extended rate physical layer-packet binary convolutional coding (ERP -PBCC) mode, as defined in IEEE Standard 802.11g-2003. This value is expressed in Mbps.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dsss_preamble_type(channel_string)[source]

Gets whether to use a long or short preamble for direct sequence spread spectrum (DSSS) and DSSS-OFDM packets, as defined in IEEE Standard 802.11b-1999.

Configure this attribute only if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BG_DSSS or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM.

The default value is NIWLANG_VAL_PREAMBLE_TYPE_LONG_PREAMBLE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssPreambleType):: Specifies whether to use a long or short preamble for direct sequence spread spectrum (DSSS) and DSSS-OFDM packets, as defined in IEEE Standard 802.11b-1999.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dsss_window_length(channel_string)[source]

Gets the window length for direct spread spectrum signals. This value is expressed in seconds. If you do not want windowing, set this attribute to 0.

This attribute provides power ramp-up and ramp-down for the entire burst.

Refer to the Windowing help topic for more information about windowing for DSSS signals.

The default value is 2 microseconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the window length for direct spread spectrum signals. This value is expressed in seconds. If you do not want windowing, set this attribute to 0.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dual_carrier_modulation_enabled(channel_string)[source]

Gets whether the dual carrier modulation (DCM) is applied to the data part of the 802.11ax signals or not. The attribute can be set to NIWLANG_VAL_TRUE only when MCS index is 0, 1, 3, or 4 and number of spatial streams is 1 or 2.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, use an empty string as the string format, if the PPDU_TYPE attribute is set to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and ‘userx’ as the active channel string format, if the PPDU_TYPE attribute is set to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU to configure this attribute.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DualCarrierModulationEnabled):: Specifies whether the dual carrier modulation (DCM) is applied to the data part of the 802.11ax signals or not. The attribute can be set to NIWLANG_VAL_TRUE only when MCS index is 0, 1, 3, or 4 and number of spatial streams is 1 or 2.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_error_string(error_code)[source]

Gets the description of a driver error code.

Parameters:: error_code (int) – Specifies an error or warning code.
Returns:: Contains the error description.
Return type:: string

get_fec_coding_type(channel_string)[source]

Gets the type of forward error correction (FEC) coding to use if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, as defined in section 20.3.11.3 of IEEE Standard 802.11n-2009.

You must use the following active channel string formats to configure this attribute.

Standard Attribute Value	Active Channel String Format
80211N MIMOOFDM, 80211AF MIMOOFDM	“” (empty string)
80211AC MIMOOFDM	“”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU
80211AC MIMOOFDM	“userx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211AX MIMOOFDM	“” (empty string), if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU
80211AX MIMOOFDM	“userx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU
80211BE MIMOOFDM	“userx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU
80211BN MIMOOFDM	“userx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU
80211BN MIMOOFDM	“” (empty string), if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU

The default value is NIWLANG_VAL_FEC_CODING_TYPE_LDPC, if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, and is NIWLANG_VAL_FEC_CODING_TYPE_BCC otherwise.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.FecCodingType):: Specifies the type of forward error correction (FEC) coding to use if you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, as defined in section 20.3.11.3 of IEEE Standard 802.11n-2009.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_frame_duration(channel_string)[source]

Gets the duration of a generated frame excluding idle interval. This attribute is applicable only if you set NIWLANG_PAYLOAD_AUTO_DATA_LENGTH attribute to NIWLANG_VAL_AUTO_PAYLOAD_DATA_LENGTH_MODE_FRAME_DURATION. When the value of FRAME_DURATION results in fractional NUMBER_OF_DATA_SYMBOLS, and if it results in generated frame duration less than 5.484 milliseconds, the number of data symbols is rounded to the next highest integer, otherwise, the number of symbols is rounded to the next lowest integer. The default value is 1 millisecond. Valid values are 100 microseconds to 5.484 milliseconds. Set Function: niWLANG_SetFrameDuration

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the duration of a generated frame excluding idle interval. This attribute is applicable only if you set NIWLANG_PAYLOAD_AUTO_DATA_LENGTH attribute to NIWLANG_VAL_AUTO_PAYLOAD_DATA_LENGTH_MODE_FRAME_DURATION. When the value of FRAME_DURATION results in fractional NUMBER_OF_DATA_SYMBOLS, and if it results in generated frame duration less than 5.484 milliseconds, the number of data symbols is rounded to the next highest integer, otherwise, the number of symbols is rounded to the next lowest integer. The default value is 1 millisecond. Valid values are 100 microseconds to 5.484 milliseconds. Set Function: niWLANG_SetFrameDuration
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fullscale_backoff(channel_string)[source]

Gets the additional scaling factor applied to the waveform when you set the AUTO_HEADROOM_ENABLED attribute to NIWLANG_VAL_TRUE. This value is expressed in dB.

The WLAN Generation ignores this attribute, if you set AUTO_HEADROOM_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is 2.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the additional scaling factor applied to the waveform when you set the AUTO_HEADROOM_ENABLED attribute to NIWLANG_VAL_TRUE. This value is expressed in dB.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_guard_interval_type(channel_string)[source]

Gets the type of guard interval (cyclic prefix) in an OFDM symbol.

The following table lists the guard interval length values for different standards.

Standard Attribute Value	Bandwidth (MHz)	1/4th Guard Interval Length	1/8th Guard Interval Length	1/16th Guard Interval Length
80211N MIMOOFDM	All	0.8 microseconds	0.4 microseconds	N.A
80211AC MIMOOFDM	All	0.8 microseconds	0.4 microseconds	N.A
80211AH MIMOOFDM	All	8 microseconds	4 microseconds	N.A
80211AF MIMOOFDM	6,7	6 microseconds	3 microseconds	N.A
80211AF MIMOOFDM	8	4.5 microseconds	2.25 microseconds	N.A
80211AX MIMOOFDM, 80211BE MIMOOFDM, 80211BN MIMOOFDM	All	3.2 microseconds	1.6 microseconds	0.8 microseconds

The default value is NIWLANG_VAL_GUARD_INTERVAL_TYPE_ONE_BY_FOUR.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.GuardIntervalType):: Specifies the type of guard interval (cyclic prefix) in an OFDM symbol.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_he_sig_b_compression_mode(channel_string)[source]

Gets how HE-SIG-B Compression value is set for 802.11ax signals. If attribute is set to NIWLANG_VAL_HE_SIG_B_COMPRESSION_MODE_MANUAL, HE-SIG-B Compression will be set as per the SIG_COMPRESSION_ENABLED attribute value.

The default value is NIWLANG_VAL_HE_SIG_B_COMPRESSION_MODE_AUTO.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HESigBCompressionMode):: Specifies how HE-SIG-B Compression value is set for 802.11ax signals. If attribute is set to NIWLANG_VAL_HE_SIG_B_COMPRESSION_MODE_MANUAL, HE-SIG-B Compression will be set as per the SIG_COMPRESSION_ENABLED attribute value.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_he_sig_b_dual_carrier_modulation_enabled(channel_string)[source]

Gets whether the dual carrier modulation (DCM) is applied on the HE-SIG-B field of 802.11ax signals or not. The attribute can be set to NIWLANG_VAL_TRUE only when HE-SIG-B MCS index is 0, 1, 3 or 4.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HESigBDualCarrierModulationEnabled):: Specifies whether the dual carrier modulation (DCM) is applied on the HE-SIG-B field of 802.11ax signals or not. The attribute can be set to NIWLANG_VAL_TRUE only when HE-SIG-B MCS index is 0, 1, 3 or 4.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_he_sig_b_mcs_index(channel_string)[source]

Gets the value of the modulation and coding scheme (MCS) index of the HE-SIG-B field of 802.11ax signal when you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU.

The default value is 0. The valid values are 0 to 5, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the value of the modulation and coding scheme (MCS) index of the HE-SIG-B field of 802.11ax signal when you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_header_encoder_enabled(channel_string)[source]

Gets whether to enable convolutional encoding of the OFDM SIGNAL field, as defined in section 17.3.5.5 of IEEE Standard 802.11a-1999.

Configure the HEADER_ENCODER_ENABLED attribute only when you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HeaderEncoderEnabled):: Specifies whether to enable convolutional encoding of the OFDM SIGNAL field, as defined in section 17.3.5.5 of IEEE Standard 802.11a-1999.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_header_interleaver_enabled(channel_string)[source]

Gets whether to enable interleaving for the OFDM SIGNAL field, as defined in section 17.3.5.6 of IEEE Standard 802.11a-1999.

Configure this attribute only when you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HeaderInterleaverEnabled):: Specifies whether to enable interleaving for the OFDM SIGNAL field, as defined in section 17.3.5.6 of IEEE Standard 802.11a-1999.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_headroom(channel_string)[source]

Gets the headroom per transmit channel. This value is expressed in dB. This value represents the maximum peak-to-average power ratio (PAPR) allowed in the generated signal.

the WLAN Generation clips any portion of the signal that exceeds the peak power corresponding to this value. the WLAN Generation ignores this attribute if you set the AUTO_HEADROOM_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the AUTO_HEADROOM_ENABLED attribute to NIWLANG_VAL_TRUE and you do not specify the HEADROOM attribute, the WLAN Generation uses default values based on the STANDARD attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, the headroom applied on the signal with respect to the average power computed is based on the AVERAGE_POWER_REFERENCE attribute.

If you specify a value that is more than the actual PAPR of the signal, there is loss of dynamic range of the digital-to-analog converter (DAC). If you specify a value that is less than the actual PAPR of the signal, the WLAN Generation clips the generated signal.

In WLAN Generation version NIWLANG_VAL_COMPATIBILITY_VERSION_020000, the HEADROOM attribute was called NIWLANG_MAX_EXPECTED_PAPR. To get the same behavior of this attribute as in NIWLANG_VAL_COMPATIBILITY_VERSION_020000, you must set the AUTO_HEADROOM_ENABLED attribute to NIWLANG_VAL_TRUE in NIWLANG_VAL_COMPATIBILITY_VERSION_030000, NIWLANG_VAL_COMPATIBILITY_VERSION_040000, NIWLANG_VAL_COMPATIBILITY_VERSION_050000, or NIWLANG_VAL_COMPATIBILITY_VERSION_060000.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, you must use an empty string as the active channel string to configure this attribute. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, you must use ‘channelx’ as the active channel string to configure this attribute. If you set the STANDARD attribute to NIWLANG_VAL_80211AF_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, you must use ‘[segmenty/]channelx’ as the active channel string to configure this attribute. ‘segment0/’ is optional if the NUMBER_OF_SEGMENTS attribute is set to 1. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use ‘[segmenty/]channelx’ as the active channel string to configure this attribute. ‘[segment0/]’ is optional if the NUMBER_OF_SEGMENTS attribute is set to 1. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use ‘channelx’ as the active channel string when the MULTI_SEGMENT_GENERATION_MODE attribute is set to NIWLANG_VAL_SINGLE_GENERATOR.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BG_DSSS, the default value is 5. Otherwise, the default value is 12.

Refer to the Configuring Active Channels (LabWindows/CVI) topic for more information about configuring active channels.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the headroom per transmit channel. This value is expressed in dB. This value represents the maximum peak-to-average power ratio (PAPR) allowed in the generated signal.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_hybrid_lo_sharing_mode(channel_string)[source]

Gets whether to enable configuration for sharing of local oscillator (LO) signal in star plus daisy-chained way for multiple PXIe-5842. This attribute is queried as part of the niWLANG_RFSGConfigureFrequencySingleLO function.

The default value is NIWLANG_VAL_HYBRID_LO_SHARING_MODE_DISABLED.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HybridLOSharingMode):: Specifies whether to enable configuration for sharing of local oscillator (LO) signal in star plus daisy-chained way for multiple PXIe-5842. This attribute is queried as part of the niWLANG_RFSGConfigureFrequencySingleLO function.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_i_dc_offset(channel_string)[source]

Gets the value of the DC offset in the in-phase (I) channel as a percentage of the RMS magnitude of the unaltered I channel.

Standard Attribute Attribute	Active Channel String Format
80211A/G OFDM, 80211J OFDM, 80211P OFDM, 80211B DSSS, 80211G DSSSOFDM	“” (empty string)
80211N MIMOOFDM, 80211AH MIMOOFDM	“channelx”
80211AC MIMOOFDM, 80211AF MIMOOFDM	“segmentx/channely”
80211AX MIMOOFDM	“segmentx/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211AX MIMOOFDM	“[userx]/segmenty/channelz”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BE MIMOOFDM	“channelx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211BE MIMOOFDM	“[userx]/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BN MIMOOFDM	“channelx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_ELR_PPDU
80211BN MIMOOFDM	“[userx]/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)

The default value is 0. Valid values are -100 to +100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the value of the DC offset in the in-phase (I) channel as a percentage of the RMS magnitude of the unaltered I channel.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_idle_interval(channel_string)[source]

Gets the interframe spacing for signal generation. This value is expressed in seconds. If you set the IDLE_INTERVAL_MODE attribute to NIWLANG_VAL_IDLE_INTERVAL_MODE_SPLIT, the WLAN Generation places half of the interframe spacing on either side of the burst. If you set the IDLE_INTERVAL_MODE attribute to NIWLANG_VAL_IDLE_INTERVAL_MODE_POST_BURST, the WLAN Generation places the interframe spacing at the end of the waveform. The waveform contains zeros for the duration of the interframe spacing.

Tip: For higher values of idle interval, LabVIEW may run out of memory. For a large idle interval, you can create a small idle waveform and generate the waveform multiple times using scripting.

The default value is 100 microseconds. Valid values are 0 to 1, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the interframe spacing for signal generation. This value is expressed in seconds. If you set the IDLE_INTERVAL_MODE attribute to NIWLANG_VAL_IDLE_INTERVAL_MODE_SPLIT, the WLAN Generation places half of the interframe spacing on either side of the burst. If you set the IDLE_INTERVAL_MODE attribute to NIWLANG_VAL_IDLE_INTERVAL_MODE_POST_BURST, the WLAN Generation places the interframe spacing at the end of the waveform. The waveform contains zeros for the duration of the interframe spacing.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_idle_interval_mode(channel_string)[source]

Gets how the idle interval is placed in the generated waveform. You cannot set this attribute to NIWLANG_VAL_IDLE_INTERVAL_MODE_SPLIT if you set the RF_BLANKING_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is NIWLANG_VAL_IDLE_INTERVAL_MODE_SPLIT.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IdleIntervalMode):: Specifies how the idle interval is placed in the generated waveform. You cannot set this attribute to NIWLANG_VAL_IDLE_INTERVAL_MODE_SPLIT if you set the RF_BLANKING_ENABLED attribute to NIWLANG_VAL_TRUE.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_interference_mitigation_pilots_enabled(channel_string)[source]

Gets whether Interference Mitigation (IM) Pilots are added in the data field of the PPDU for the generated 802.11bn signal or not.

The default value is NIWLANG_VAL_INTERFERENCE_MITIGATION_PILOTS_ENABLED_FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.InterferenceMitigationPilotsEnabled):: Specifies whether Interference Mitigation (IM) Pilots are added in the data field of the PPDU for the generated 802.11bn signal or not.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_gain_imbalance(channel_string)[source]

Gets the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. This value is expressed in dB.

If you set this attribute to a large value, there may be loss of dynamic range at the digital-to-analog converter (DAC).

I/Q gain imbalance follows the definition shown in the following equation:

I’ = I - (gamma) * sin(phi) * Q + I0 Q’ = (gamma) * cos(phi) * Q + Q0 where gamma = 10^(I/Q gain imbalance/20) phi is the quadrature skew I is the in-phase component of the waveform before applying impairments Q is the quadrature component of the waveform before applying impairments I’ is the in-phase component of the waveform after applying impairments Q’ is the quadrature component of the waveform before applying impairments I0 is the (RMS value of I) * (I DC Offset)/100 Q0 is the (RMS value of Q) * (Q DC Offset)/100

Standard Attribute Attribute	Active Channel String Format
80211A/G OFDM, 80211J OFDM, 80211P OFDM, 80211B DSSS, 80211G DSSSOFDM	“” (empty string)
80211N MIMOOFDM, 80211AH MIMOOFDM	“channelx”
80211AC MIMOOFDM, 80211AF MIMOOFDM	“segmentx/channely”
80211AX MIMOOFDM	“segmentx/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211AX MIMOOFDM	“[userx]/segmenty/channelz”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BE MIMOOFDM	“channelx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU
80211BE MIMOOFDM	“[userx]/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)
80211BN MIMOOFDM	“channelx”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_ELR_PPDU
80211BN MIMOOFDM	“[userx]/channely”, if you set the PPDU Type attribute to NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU (userx is optional if you want to apply to all users)

The default value is 0. Valid values are -6 to +6, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. This value is expressed in dB.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_rate(channel_string)[source]

Gets the recommended sample rate for the current signal configuration. This value is expressed in samples per second. The dt parameter of the created waveform is the inverse of the recommended sample rate.

If you set the usewaveformdtforIQrate parameter of the niRFSG_Write_Arb_Waveform function to False, wire the IQ_RATE attribute to the NIRFSG_IQ_RATE attribute. This value is expressed in samples per second. Get Function: niWLANG_GetIQRate

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Returns the recommended sample rate for the current signal configuration. This value is expressed in samples per second. The dt parameter of the created waveform is the inverse of the recommended sample rate.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_waveform_size(channel_string)[source]

Gets the size of the generated I/Q waveform. This value is expressed in samples.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Returns the size of the generated I/Q waveform. This value is expressed in samples.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_l_sig_length(channel_string)[source]

Gets the value of the UL-LENGTH field in the trigger frame that is used for 802.11ax Trigger-Based PPDU and 802.11be Trigger-Based PPDU generation.

The default value is -1, which indicates that the value of UL-LENGTH is derived from the payload settings.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the value of the UL-LENGTH field in the trigger frame that is used for 802.11ax Trigger-Based PPDU and 802.11be Trigger-Based PPDU generation.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_ldpc_extra_symbol_segment(channel_string)[source]

Gets the value of the LDPC extra symbol segment field in the trigger frame which is used for 802.11ax Trigger-Based PPDU, 802.11be Trigger-Based PPDU and 802.11bn Trigger-Based PPDU generation.

The default value is -1, which indicates that the value of the LDPC extra symbol segment field is derived from the payload settings.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the value of the LDPC extra symbol segment field in the trigger frame which is used for 802.11ax Trigger-Based PPDU, 802.11be Trigger-Based PPDU and 802.11bn Trigger-Based PPDU generation.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_lo_frequency_offset(channel_string)[source]

Gets the LO frequency offset to be used when you set the LO_FREQUENCY_OFFSET_MODE attribute to NIWLANG_VAL_LO_FREQUENCY_OFFSET_MODE_USER_DEFINED.

The default value is 0 Hz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the LO frequency offset to be used when you set the LO_FREQUENCY_OFFSET_MODE attribute to NIWLANG_VAL_LO_FREQUENCY_OFFSET_MODE_USER_DEFINED.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_lo_frequency_offset_mode(channel_string)[source]

Gets how the LO frequency offset is derived to configure frequency on the NI RF vector signal generators and the NI synthesizers in the rfsg_configure_frequency_single_lo() and niWLANG_RFSGConfigureFrequencyMultipleLO functions. the WLAN Generation ignores this attribute if you do not use PXIe-5840, PXIe-5841, PXIe-5841 with PXIe-5655, PXIe-5646, PXIe-5830, or PXIe-5831 devices.

The default value is NIWLANG_VAL_LO_FREQUENCY_OFFSET_MODE_AUTO.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LOFrequencyOffsetMode):: Specifies how the LO frequency offset is derived to configure frequency on the NI RF vector signal generators and the NI synthesizers in the rfsg_configure_frequency_single_lo() and niWLANG_RFSGConfigureFrequencyMultipleLO functions. the WLAN Generation ignores this attribute if you do not use PXIe-5840, PXIe-5841, PXIe-5841 with PXIe-5655, PXIe-5646, PXIe-5830, or PXIe-5831 devices.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_lo_sharing_enabled(channel_string)[source]

Gets whether to enable configuration for sharing of local oscillator (LO) signal for multiple NI RF vector signal generators and NI RF vector signal transceivers, or both. This attribute is queried as part of the rfsg_configure_multiple_device_synchronization() function.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LOSharingEnabled):: Specifies whether to enable configuration for sharing of local oscillator (LO) signal for multiple NI RF vector signal generators and NI RF vector signal transceivers, or both. This attribute is queried as part of the rfsg_configure_multiple_device_synchronization() function.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_lo_splitter_loss(channel_string)[source]

Gets the array of splitter loss values in dB for corresponding array of splitter loss frequencies in Hz if Hybrid LO Sharing Mode is set to Mode0.

The default is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the array of splitter loss values in dB for corresponding array of splitter loss frequencies in Hz if Hybrid LO Sharing Mode is set to Mode0.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_lo_splitter_loss_frequency(channel_string)[source]

Gets the array of splitter loss frequencies in Hz for corresponding array of splitter loss values in dB if Hybrid LO Sharing Mode is set to Mode0.

The default is an empty array.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the array of splitter loss frequencies in Hz for corresponding array of splitter loss values in dB if Hybrid LO Sharing Mode is set to Mode0.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_locked_clock_bit_enabled(channel_string)[source]

Gets whether to enable the Locked Clock Bit flag for the direct sequence spread spectrum (DSSS) header, as defined in sections 18.2.3.4 and 18.2.3.11 of IEEE Standard 802.11b-1999, and section 19.3.2.1 of IEEE Standard 802.11g-2003.

Configure this attribute only when you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BG_DSSS or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LockedClockBitEnabled):: Specifies whether to enable the Locked Clock Bit flag for the direct sequence spread spectrum (DSSS) header, as defined in sections 18.2.3.4 and 18.2.3.11 of IEEE Standard 802.11b-1999, and section 19.3.2.1 of IEEE Standard 802.11g-2003.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_ltf_size(channel_string)[source]

Gets the HE-LTF, EHT-LTF and UHR-LTF symbol size in 802.11ax, 802.11be and 802.11bn signals, respectively. IEEE Standards 802.11ax, 802.11be and 802.11bn specify the following combinations of the HE-LTF/EHT-LTF/UHR-LTF symbol size and the GUARD_INTERVAL attribute.

PPDU Type Attribute Value	LTF Size Attribute Value	Guard Interval Type Attribute Value
NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU	NIWLANG_VAL_LTF_SIZE_4X	1/4
NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU	NIWLANG_VAL_LTF_SIZE_2X	1/8
NIWLANG_VAL_PPDU_TYPE_SU_PPDU, NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU	NIWLANG_VAL_LTF_SIZE_2X, NIWLANG_VAL_LTF_SIZE_4X, NIWLANG_VAL_LTF_SIZE_1X	1/16
NIWLANG_VAL_PPDU_TYPE_MU_PPDU	NIWLANG_VAL_LTF_SIZE_4X	1/4
NIWLANG_VAL_PPDU_TYPE_MU_PPDU	NIWLANG_VAL_LTF_SIZE_2X	1/8
NIWLANG_VAL_PPDU_TYPE_MU_PPDU	NIWLANG_VAL_LTF_SIZE_2X, NIWLANG_VAL_LTF_SIZE_4X	1/16
NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU	NIWLANG_VAL_LTF_SIZE_4X	1/4
NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU	NIWLANG_VAL_LTF_SIZE_2X, NIWLANG_VAL_LTF_SIZE_1X	1/8
NIWLANG_VAL_PPDU_TYPE_ELR_PPDU	NIWLANG_VAL_LTF_SIZE_2X	1/8

The default value is NIWLANG_VAL_LTF_SIZE_AUTO.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LtfSize):: Specifies the HE-LTF, EHT-LTF and UHR-LTF symbol size in 802.11ax, 802.11be and 802.11bn signals, respectively. IEEE Standards 802.11ax, 802.11be and 802.11bn specify the following combinations of the HE-LTF/EHT-LTF/UHR-LTF symbol size and the GUARD_INTERVAL attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address1(channel_string)[source]

Gets the Address1 field as defined in section 7.1.3 of IEEE Standard 802.11-2007 and IEEE Standard 802.11n-2009, section 8.2.4 of IEEE Standard 802.11ac-2013 and IEEE P802.11ah/D1.3, section 9.2.4 of IEEE P802.11ax/D8.0, section 9.2.4 of IEEE P802.11be/D7.0, and section 9.2.4 of IEEE P802.11bn/D1.2. The length of this field is defined by the MAC_ADDRESS1 Length attribute if you set the MAC_FRAME_FORMAT attribute to NIWLANG_VAL_MAC_FRAME_FORMAT_SHORT; otherwise, the length is six bytes. If this field is a MAC address, it is represented with the least significant byte in the leftmost position and each byte is represented with the least significant bit in the rightmost position.

For example, the medium access control (MAC) address 12-34-56-78-9A-BC is represented by the number 0 x 123456789ABC.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, you must use an empty string to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use an empty string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_FALSE, or use the ‘mpdux’ active channel string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use the following active channel string formats to configure this attribute: An empty string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. ‘mpdux’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE, or use the ‘mpdux’ active channel string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, use the following active channel string formats to configure this attribute: Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, use ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, use the following active channel string formats to configure this attribute: ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is 0x0. Valid values are 0x0 to 0xFFFFFFFFFFFF. For values outside this range, the WLAN Generation uses the least significant six bytes.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the Address1 field as defined in section 7.1.3 of IEEE Standard 802.11-2007 and IEEE Standard 802.11n-2009, section 8.2.4 of IEEE Standard 802.11ac-2013 and IEEE P802.11ah/D1.3, section 9.2.4 of IEEE P802.11ax/D8.0, section 9.2.4 of IEEE P802.11be/D7.0, and section 9.2.4 of IEEE P802.11bn/D1.2. The length of this field is defined by the MAC_ADDRESS1 Length attribute if you set the MAC_FRAME_FORMAT attribute to NIWLANG_VAL_MAC_FRAME_FORMAT_SHORT; otherwise, the length is six bytes. If this field is a MAC address, it is represented with the least significant byte in the leftmost position and each byte is represented with the least significant bit in the rightmost position.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address1_enabled(channel_string)[source]

Gets whether to enable the Address1 field of the medium access control (MAC) header.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, you must use an empty string to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use an empty string active channel string format if you set the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if you set the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use the following active channel string formats to configure this attribute: An empty string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘mpdux’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, use the following active channel string formats to configure this attribute: Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, use ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, use the following active channel string formats to configure this attribute: ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.MacAddress1Enabled):: Specifies whether to enable the Address1 field of the medium access control (MAC) header.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address1_length(channel_string)[source]

Gets the length of Address1 field when the MAC_FRAME_FORMAT attribute is set to NIWLANG_VAL_MAC_FRAME_FORMAT_SHORT.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use the following active channel string formats to configure this attribute. An empty string active channel string format if you set the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE.

The default value is 2. Valid values are 2 and 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the length of Address1 field when the MAC_FRAME_FORMAT attribute is set to NIWLANG_VAL_MAC_FRAME_FORMAT_SHORT.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address2(channel_string)[source]

Gets the Address2 field as defined in section 7.1.3 of IEEE Standard 802.11-2007 and IEEE Standard 802.11n-2009, section 8.2.4 of IEEE Standard 802.11ac-2013 and IEEE P802.11ah/D1.3, section 9.2.4 of IEEE P802.11ax/D8.0, section 9.2.4 of IEEE P802.11be/D7.0, and section 9.2.4 of IEEE P802.11bn/D1.2.

The length of this field is defined by the MAC_ADDRESS2_LENGTH attribute if you set the MAC_FRAME_FORMAT attribute to NIWLANG_VAL_MAC_FRAME_FORMAT_SHORT; otherwise, the length is six bytes. If this field is a MAC address, it is represented with the least significant byte in the leftmost position and each byte is represented with the least significant bit in the rightmost position.

For example, the medium access control (MAC) address 12-34-56-78-9A-BC is represented by the number 0 x 123456789ABC.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, you must use an empty string to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use an empty string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use the following active channel string formats to configure this attribute: An empty string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘mpdux’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, use the following active channel string formats to configure this attribute: Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, use ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, use the following active channel string formats to configure this attribute: ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is 0x0. Valid values are 0x0 to 0xFFFFFFFFFFFF. For values outside this range, the WLAN Generation uses the least significant six bytes.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the Address2 field as defined in section 7.1.3 of IEEE Standard 802.11-2007 and IEEE Standard 802.11n-2009, section 8.2.4 of IEEE Standard 802.11ac-2013 and IEEE P802.11ah/D1.3, section 9.2.4 of IEEE P802.11ax/D8.0, section 9.2.4 of IEEE P802.11be/D7.0, and section 9.2.4 of IEEE P802.11bn/D1.2.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address2_enabled(channel_string)[source]

Gets whether to enable the Address2 field of the medium access control (MAC) header.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, you must use an empty string to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use an empty string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use the following active channel string formats to configure this attribute: An empty string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘mpdux’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, use the following active channel string formats to configure this attribute: Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, use ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, use the following active channel string formats to configure this attribute: ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is NIWLANG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.MacAddress2Enabled):: Specifies whether to enable the Address2 field of the medium access control (MAC) header.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address2_length(channel_string)[source]

Gets the length of Address2 field if you set the MAC_FRAME_FORMAT attribute to NIWLANG_VAL_MAC_FRAME_FORMAT_SHORT.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use the following active channel string formats to configure this attribute. An empty string active channel string format if you set the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE.

The default value is 2. Valid values are 2 and 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the length of Address2 field if you set the MAC_FRAME_FORMAT attribute to NIWLANG_VAL_MAC_FRAME_FORMAT_SHORT.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address3(channel_string)[source]

Gets the six-byte Address3 field as defined in section 7.1.3 of IEEE Standard 802.11-2007 and IEEE Standard 802.11n-2009, section 8.2.4 of IEEE Standard 802.11ac-2013 and IEEE P802.11ah/D1.3, section 9.2.4 of IEEE P802.11ax/D8.0, section 9.2.4 of IEEE P802.11be/D7.0, and section 9.2.4 of IEEE P802.11bn/D1.2.

This field is represented with the least significant byte in the leftmost position, and each byte is represented with the least significant bit in the rightmost position.

For example, the medium access control (MAC) address 12-34-56-78-9A-BC is represented by the number 0x123456789ABC.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, you must use an empty string to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use an empty string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use the following active channel string formats to configure this attribute: An empty string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘mpdux’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, use the following active channel string formats to configure this attribute: Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, use ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, use the following active channel string formats to configure this attribute: ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is 0x0. Valid values are 0x0 to 0xFFFFFFFFFFFF. For values outside this range, the WLAN Generation uses the least significant six bytes.

If you set the PAYLOAD_MAC_FRAME_TYPE attribute to NIWLANG_VAL_PAYLOAD_FRAME_TYPE_TRIGGER_FRAME, the WLAN Generation ignores this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the six-byte Address3 field as defined in section 7.1.3 of IEEE Standard 802.11-2007 and IEEE Standard 802.11n-2009, section 8.2.4 of IEEE Standard 802.11ac-2013 and IEEE P802.11ah/D1.3, section 9.2.4 of IEEE P802.11ax/D8.0, section 9.2.4 of IEEE P802.11be/D7.0, and section 9.2.4 of IEEE P802.11bn/D1.2.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address3_enabled(channel_string)[source]

Gets whether to enable the Address3 field of the medium access control (MAC) header.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM, you must use an empty string to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211N_MIMO_OFDM or NIWLANG_VAL_STANDARD_80211AH_MIMO_OFDM, you must use an empty string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if the AMPDU_ENABLED attribute is set to NIWLANG_VAL_TRUE, to configure this attribute.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AC_MIMO_OFDM, you must use the following active channel string formats to configure this attribute: An empty string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘mpdux’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AF_MIMO_OFDM, use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE, or use the ‘mpdux’ active channel string if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211AX_MIMO_OFDM, use the following active channel string formats to configure this attribute: Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_SU_PPDU or NIWLANG_VAL_PPDU_TYPE_EXTENDED_RANGE_SU_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use the ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BE_MIMO_OFDM, use ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

If you set the STANDARD attribute to NIWLANG_VAL_STANDARD_80211BN_MIMO_OFDM, use the following active channel string formats to configure this attribute: ‘userx/mpduy’ as the active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_MU_PPDU or NIWLANG_VAL_PPDU_TYPE_TRIGGER_BASED_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE. Use an empty string active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_FALSE. Use the ‘mpdux’ active channel string format if you set the PPDU_TYPE attribute to NIWLANG_VAL_PPDU_TYPE_ELR_PPDU and the AMPDU_ENABLED attribute to NIWLANG_VAL_TRUE.

The default value is NIWLANG_VAL_TRUE. If you set the PAYLOAD_MAC_FRAME_TYPE attribute to NIWLANG_VAL_PAYLOAD_FRAME_TYPE_TRIGGER_FRAME, the WLAN Generation ignores this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.MacAddress3Enabled):: Specifies whether to enable the Address3 field of the medium access control (MAC) header.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mac_address4(channel_string)[source]

Gets the six-byte Address4 field as defined in section 7.1.3 of IEEE Standard 802.11-2007 and IEEE Standard 802.11n-2009, section 8.2.4 of IEEE Standard 802.11ac-2013 and IEEE P802.11ah/D1.3, section 9.2.4 of IEEE P802.11ax/D8.0, section 9.2.4 of IEEE P802.11be/D7.0, and section 9.2.4 of IEEE P802.11bn/D1.2.