DsssModAccResults

Provides methods to fetch and read the DsssModAcc measurement results.

class nirfmxwlan.dsssmodacc_results.DsssModAccResults(signal_obj)

Bases: object

Provides methods to fetch and read the DsssModAcc measurement results.

fetch_average_powers(selector_string, timeout)

Fetches the average power of various fields in the PPDU.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

preamble_average_power_mean (float):

This parameter returns the average power of the preamble field of the PPDU. When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the average preamble field power computed for each averaging count. This value is expressed in dBm.

header_average_power_mean (float):

This parameter returns the average power of the header field of the PPDU. When you set the DSSSModAcc Averaging Enabled attribute to True, this result returns the mean of the average header field power computed for each averaging count. This value is expressed in dBm.

data_average_power_mean (float):

This parameter returns the average power of the data field of the PPDU. When you set the DSSSModAcc Averaging Enabled attribute to True, this attribute returns the mean of the data field average power results computed for each averaging count. This value is expressed in dBm.

ppdu_average_power_mean (float):

This parameter returns the average power of the PPDU. When you set the DSSSModAcc Averaging Enabled attribute to True, this parameter returns the mean of the average PPDU power results computed for each averaging count. This value is expressed in dBm.

error_code (int):

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

Return type:

Tuple (preamble_average_power_mean, header_average_power_mean, data_average_power_mean, ppdu_average_power_mean, error_code)

fetch_constellation_trace(selector_string, timeout, constellation)

Fetches the constellation trace for the data field.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

• constellation (numpy.complex64) – This parameter returns the constellation of the received symbols.

Returns:

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

Return type:

int

fetch_custom_gate_powers_array(selector_string, timeout)

Fetches the average and peak power of custom gates.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

average_power_mean (float):

This parameter returns an array of average powers of the custom gates. This value is expressed in dBm. When you set the AVERAGING_ENABLED attribute to True, this parameter returns an array of the mean of the average custom gate power results computed for each averaging count.

peak_power_maximum (float):

This parameter returns an array of peak powers of the custom gates. This value is expressed in dBm. When you set the DSSSModAcc Averaging Enabled attribute to True, this parameter returns an array of the maximum of the peak custom gate power results computed for each averaging count.

error_code (int):

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

Return type:

Tuple (average_power_mean, peak_power_maximum, error_code)

fetch_decoded_header_bits_trace(selector_string, timeout)

Fetches the decoded Header bits.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

decoded_header_bits (int):

This parameter returns an array of bits in the Header field.

error_code (int):

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

Return type:

Tuple (decoded_header_bits, error_code)

fetch_decoded_psdu_bits_trace(selector_string, timeout)

Fetches the decoded PLCP service data unit (PSDU) bits.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

decoded_psdu_bits (int):

This parameter returns an array of PSDU bits obtained after demodulation and decoding.

error_code (int):

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

Return type:

Tuple (decoded_psdu_bits, error_code)

fetch_evm(selector_string, timeout)

Fetches the EVM results for the DSSSModAcc measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

rms_evm_mean (float):

This parameter returns the RMS EVM results of the burst. When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the RMS EVM computed for each averaging count. When you set the EVM_UNIT attribute to Percentage, the measurement returns this result as a percentage. When you set the DSSSModAcc EVM Unit attribute to dB, the measurement returns this result in dB.

peak_evm_80211_2016_maximum (float):

This parameter returns the peak EVM results of the burst. When you set the EVM_UNIT attribute to Percentage, the measurement returns this result as a percentage. When you set the DSSSModAcc EVM Unit attribute to dB, the measurement returns this result in dB. This measurement is performed in accordance with section 16.3.7.9 of IEEE Standard 802.11-2016. When you set the DSSSModAcc Averaging Enabled attribute to True, this result returns the maximum of the peak EVM computed for each averaging count.

peak_evm_80211_2007_maximum (float):

This parameter returns the peak EVM results of the burst. When you set the EVM_UNIT attribute to Percentage, the measurement returns this result as a percentage. When you set the DSSSModAcc EVM Unit attribute to dB, the measurement returns this result in dB. This measurement is performed in accordance with section 18.4.7.8 of IEEE Standard 802.11-2007. When you set the DSSSModAcc Averaging Enabled attribute to True, this result returns the maximum of the peak EVM computed for each averaging count.

peak_evm_80211_1999_maximum (float):

This parameter returns the peak EVM results of the burst. When you set the EVM_UNIT attribute to Percentage, the measurement returns this result as a percentage. When you set the DSSSModAcc EVM Unit attribute to dB, the measurement returns this result in dB. This measurement is performed in accordance with section 18.4.7.8 of IEEE Standard 802.11b-1999. When you set the DSSSModAcc Averaging Enabled attribute to True, this result returns the maximum of the peak EVM computed for each averaging count.

frequency_error_mean (float):

This parameter returns the carrier frequency error of the transmitter. This value is expressed in Hz. When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the carrier frequency error results computed for each averaging count.

chip_clock_error_mean (float):

This parameter returns the chip clock error result of the transmitter. This value is expressed in parts per million (ppm). When you set the DSSSModAcc Averaging Enabled attribute to True, this result returns the mean of the chip clock error computed for each averaging count.

number_of_chips_used (int):

This parameter returns the number of chips used for the DSSSModAcc measurement.

error_code (int):

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

Return type:

Tuple (rms_evm_mean, peak_evm_80211_2016_maximum, peak_evm_80211_2007_maximum, peak_evm_80211_1999_maximum, frequency_error_mean, chip_clock_error_mean, number_of_chips_used, error_code)

fetch_evm_per_chip_mean_trace(selector_string, timeout, evm_per_chip_mean)

Fetches the EVM per chip in the data field. When you set the AVERAGING_ENABLED attribute to True, this method returns the mean of the EVM per chip computed for each averaging count.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

• evm_per_chip_mean (numpy.float32) – This parameter returns an array of EVM per chip. When you set the EVM_UNIT attribute to Percentage, the measurement returns this result as a percentage. When you set the DSSSModAcc EVM Unit attribute to dB, the measurement returns this result in dB.

Returns:

x0 (float):

This parameter returns the index of the first chip.

dx (float):

This parameter returns the trace increment interval in number of chips. This value is always equal to 1.

error_code (int):

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

Return type:

Tuple (x0, dx, error_code)

fetch_iq_impairments(selector_string, timeout)

Fetches the I/Q Impairment results for the DSSSModAcc measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

iq_origin_offset_mean (float):

This parameter returns the I/Q origin offset. This value is expressed in dB. I/Q origin offset is the ratio of the mean value of the signal to the RMS value of the signal. When you set the AVERAGING_ENABLED attribute to True, this parameter returns the mean of the I/Q origin offset results computed for each averaging count.

iq_gain_imbalance_mean (float):

This parameter returns the I/Q gain imbalance results. This value is expressed in dB. I/Q gain imbalance is the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. When you set the DSSSModAcc Averaging Enabled attribute to True, this parameter returns the mean of the I/Q gain imbalance results computed for each averaging count.

iq_quadrature_error_mean (float):

This parameter returns the I/Q quadrature error. This value is expressed in degrees. Quadrature error is the deviation in angle from 90 degrees between the in-phase (I) and quadrature-phase (Q) signals. When the DSSSModAcc Averaging Enabled attribute is set to True, this parameter returns the mean of the I/Q quadrature error results computed for each averaging count.

error_code (int):

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

Return type:

Tuple (iq_origin_offset_mean, iq_gain_imbalance_mean, iq_quadrature_error_mean, error_code)

fetch_peak_powers(selector_string, timeout)

Fetches the peak power of various fields in the PPDU.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

preamble_peak_power_maximum (float):

This parameter returns the peak power of the preamble field of the PPDU. When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum of the peak preamble field power results computed for each averaging count. This value is expressed in dBm.

header_peak_power_maximum (float):

This parameter returns the peak power of the header field of the PPDU. When you set the DSSSModAcc Averaging Enabled attribute to True, this result returns the maximum of the peak header field power results computed for each averaging count. This value is expressed in dBm.

data_peak_power_maximum (float):

This parameter returns the peak power of the data field of the PPDU. When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum of the peak data field power results computed for each averaging count. This value is expressed in dBm.

ppdu_peak_power_maximum (float):

This parameter returns the peak power of the PPDU. When you set the AVERAGING_ENABLED attribute to True, this parameter returns the maximum of the peak PPDU power results computed for each averaging count. This value is expressed in dBm.

error_code (int):

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

Return type:

Tuple (preamble_peak_power_maximum, header_peak_power_maximum, data_peak_power_maximum, ppdu_peak_power_maximum, error_code)

fetch_ppdu_information(selector_string, timeout)

Fetches the PPDU information.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. This value is expressed in seconds. The default value is 10.

Returns:

data_modulation_format (enums.DsssModAccDataModulationFormat):

This parameter returns the data modulation format results of the analyzed waveform.

Name (Value)	Description
DSSS 1 Mbps (0)	Indicates that the modulation format is DSSS and the data rate is 1 Mbps.
DSSS 2 Mbps (1)	Indicates that the modulation format is DSSS and the data rate is 2 Mbps.
CCK 5.5 Mbps (2)	Indicates that the modulation format is CCK and the data rate is 5.5 Mbps.
CCK 11 Mbps (3)	Indicates that the modulation format is CCK and the data rate is 11 Mbps.
PBCC 5.5 Mbps (4)	Indicates that the modulation format is PBCC and the data rate is 5.5 Mbps.
PBCC 11 Mbps (5)	Indicates that the modulation format is PBCC and the data rate is 11 Mbps.
PBCC 22 Mbps (6)	Indicates that the modulation format is PBCC and the data rate is 22 Mbps.
PBCC 33 Mbps (7)	Indicates that the modulation format is PBCC and the data rate is 33 Mbps.

payload_length (int):

This parameter returns the payload length of the acquired burst. This value is expressed in bytes.

preamble_type (enums.DsssModAccPreambleType):

This parameter returns the detected preamble type.

Name (Value)	Description
Long (0)	Indicates that the PPDU has a long PHY preamble and header.
Short (1)	Indicates that the PPDU has a short PHY preamble and header.

locked_clocks_bit (int):

This parameter returns the value of the locked clocks bit in the Long PHY SERVICE field. A value of 1 indicates that the transmit frequency and the symbol clock are derived from the same oscillator. A value of 0 indicates that the transmit frequency and the symbol clock are derived from independent oscillators.

header_crc_status (enums.DsssModAccPayloadHeaderCrcStatus):

This parameter returns whether the header CRC is successfully passed, as defined under section 16.2.3.7 of IEEE Standard 802.11 2016.

Name (Value)	Description
Fail (0)	Indicates that the header CRC failed.
Pass (1)	Indicates that the header CRC passed.

psdu_crc_status (enums.DsssModAccPsduCrcStatus):

This parameter returns whether the PLCP service data unit (PSDU) cyclic redundancy check (CRC) has successfully passed.

Name (Value)	Description
Fail (0)	Indicates that the PSDU CRC failed.
Pass (1)	Indicates that the PSDU CRC passed.

error_code (int):

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

Return type:

Tuple (data_modulation_format, payload_length, preamble_type, locked_clocks_bit, header_crc_status, psdu_crc_status, error_code)

get_chip_clock_error_mean(selector_string)

Gets the chip clock error of the transmitter. This value is expressed in parts per million (ppm).

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the chip clock error computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the chip clock error of the transmitter. This value is expressed in parts per million (ppm).

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_custom_gate_average_power_mean(selector_string)

Gets the average power of the custom gate. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean value of the average custom gate power computed for each averaging count.

Use “gate<k>” as the Selector String to read the result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power of the custom gate. This value is expressed in dBm.

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_custom_gate_peak_power_maximum(selector_string)

Gets the peak power of the custom gate. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum value of the peak custom gate power computed for each averaging count.

Use “gate<k>” as the Selector String to query the result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power of the custom gate. This value is expressed in dBm.

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_data_average_power_mean(selector_string)

Gets the average power of the data field of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the average data field power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power of the data field of the PPDU. This value is expressed in dBm.

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_data_modulation_format(selector_string)

Gets the data modulation format results of the analyzed waveform.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Name (Value)	Description
DSSS 1 Mbps (0)	Indicates that the modulation format is DSSS and the data rate is 1 Mbps.
DSSS 2 Mbps (1)	Indicates that the modulation format is DSSS and the data rate is 2 Mbps.
CCK 5.5 Mbps (2)	Indicates that the modulation format is CCK and the data rate is 5.5 Mbps.
CCK 11 Mbps (3)	Indicates that the modulation format is CCK and the data rate is 11 Mbps.
PBCC 5.5 Mbps (4)	Indicates that the modulation format is PBCC and the data rate is 5.5 Mbps.
PBCC 11 Mbps (5)	Indicates that the modulation format is PBCC and the data rate is 11 Mbps.
PBCC 22 Mbps (6)	Indicates that the modulation format is PBCC and the data rate is 22 Mbps.
PBCC 33 Mbps (7)	Indicates that the modulation format is PBCC and the data rate is 33 Mbps.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccDataModulationFormat):

Returns the data modulation format results of the analyzed 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_data_peak_power_maximum(selector_string)

Gets the peak power of the data field of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum value of the peak data field power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power of the data field of the PPDU. This value is expressed in dBm.

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_frequency_error_mean(selector_string)

Gets the carrier frequency error of the transmitter. This value is expressed in Hz.

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the carrier frequency error computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the carrier frequency error of the transmitter. 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_header_average_power_mean(selector_string)

Gets the average power of the header field of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the average header field power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power of the header field of the PPDU. This value is expressed in dBm.

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_crc_status(selector_string)

Gets whether the header cyclic redundancy check (CRC) is successfully passed, as defined in section 16.2.3.7 of IEEE Standard 802.11 2016.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Name (Value)	Description
Fail (0)	Returns that the header CRC failed.
Pass (1)	Returns that the header CRC passed.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccPayloadHeaderCrcStatus):

Returns whether the header cyclic redundancy check (CRC) is successfully passed, as defined in section 16.2.3.7 of IEEE Standard 802.11 2016.

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_peak_power_maximum(selector_string)

Gets the peak power of the header field of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum value of the peak header field power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power of the header field of the PPDU. This value is expressed in dBm.

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_mean(selector_string)

Gets the I/Q gain imbalance. This value is expressed in dB.

I/Q gain imbalance is the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the I/Q gain imbalance computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q gain imbalance. 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_origin_offset_mean(selector_string)

Gets the I/Q origin offset. This value is expressed in dB.

I/Q origin offset is the ratio of the mean value of the signal to the RMS value of the signal. When you set this AVERAGING_ENABLED attribute to True, this result returns the mean of the I/Q origin offset computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q origin offset. 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_quadrature_error_mean(selector_string)

Gets the I/Q quadrature error. This value is expressed in degrees.

Quadrature error is the deviation in angle from 90 degrees between the in-phase (I) and quadrature-phase (Q) signals. When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the I/Q quadrature error computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q quadrature error. This value is expressed in degrees.

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_clocks_bit(selector_string)

Gets the value of the locked clocks bit in the Long PHY SERVICE field.

A value of 1 indicates that the transmit frequency and the symbol clock are derived from the same oscillator. A value of 0 indicates that the transmit frequency and the symbol clock are derived from independent oscillators.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the value of the locked clocks bit in the Long PHY SERVICE field.

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_number_of_chips_used(selector_string)

Gets the number of chips used for the DSSSModAcc measurement.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the number of chips used for the DSSSModAcc measurement.

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_payload_length(selector_string)

Gets the payload length of the acquired burst. This value is expressed in bytes.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the payload length of the acquired burst. This value is expressed in bytes.

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_peak_evm_802_11_1999_maximum(selector_string)

Gets the peak EVM of the burst. This value is expressed as percentage or in dB.

This measurement is performed in accordance with section 18.4.7.8 of IEEE Standard 802.11b-1999. When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum of the peak EVM computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak EVM of the burst. This value is expressed as percentage or 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_peak_evm_802_11_1999_mean(selector_string)

Gets the peak EVM of the burst. This value is expressed as a percentage or in dB.

This measurement is performed in accordance with section 18.4.7.8 of IEEE Standard 802.11b-1999. When you set the AVERAGING_ENABLED attribute is set to True, this result returns the mean of the peak EVM computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak EVM of the burst. This value is expressed as a percentage or 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_peak_evm_802_11_2007_maximum(selector_string)

Gets the peak EVM of the burst. This value is expressed as a percentage or in dB.

This measurement is performed in accordance with section 18.4.7.8 of IEEE Standard 802.11-2007. When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum value of the peak EVM computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak EVM of the burst. This value is expressed as a percentage or 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_peak_evm_802_11_2007_mean(selector_string)

Gets the peak EVM of the burst. This value is expressed as a percentage or in dB.

This measurement is performed in accordance with section 18.4.7.8 of IEEE Standard 802.11-2007. When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the peak EVM computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak EVM of the burst. This value is expressed as a percentage or 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_peak_evm_802_11_2016_maximum(selector_string)

Gets the peak EVM of the burst. This value is expressed as a percentage or in dB.

This measurement is performed in accordance with section 16.3.7.9 of IEEE Standard 802.11-2016. When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum value of the peak EVM computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak EVM of the burst. This value is expressed as a percentage or 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_peak_evm_802_11_2016_mean(selector_string)

Gets the peak EVM of the burst. This value is expressed as a percentage or in dB.

This measurement is performed in accordance with section 16.3.7.9 of IEEE Standard 802.11-2016. When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the peak EVM computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak EVM of the burst. This value is expressed as a percentage or 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_ppdu_average_power_mean(selector_string)

Gets the average power of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the average PPDU power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power of the PPDU. This value is expressed in dBm.

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_ppdu_peak_power_maximum(selector_string)

Gets the peak power of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum value of the peak PPDU power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power of the PPDU. This value is expressed in dBm.

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_preamble_average_power_mean(selector_string)

Gets the average power of the preamble field of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the average preamble field power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power of the preamble field of the PPDU. This value is expressed in dBm.

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_preamble_peak_power_maximum(selector_string)

Gets the peak power of the preamble field of the PPDU. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this result returns the maximum of the peak preamble field power computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power of the preamble field of the PPDU. This value is expressed in dBm.

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_preamble_type(selector_string)

Gets the detected preamble type of the acquired burst.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Name (Value)	Description
Long (0)	Indicates that the PPDU has a long PHY preamble and header.
Short (1)	Indicates that the PPDU has a short PHY preamble and header.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccPreambleType):

Returns the detected preamble type of the acquired burst.

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_psdu_crc_status(selector_string)

Indicates whether the cyclic redundancy check (CRC) of the received decoded PLCP service data unit (PSDU) has passed.

The measurement calculates the CRC over the decoded bits, excluding the last 32 bits. The measurement then compares this value with the CRC value in the received payload, which is represented by the last 32 bits of the PSDU.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Name (Value)	Description
Fail (0)	Indicates that the PSDU CRC failed.
Pass (1)	Indicates that the PSDU CRC passed.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccPsduCrcStatus):

Indicates whether the cyclic redundancy check (CRC) of the received decoded PLCP service data unit (PSDU) has passed.

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_rms_evm_mean(selector_string)

Gets the RMS EVM of the burst. This value is expressed as a percentage or in dB.

When you set the AVERAGING_ENABLED attribute to True, this result returns the mean of the RMS EVM computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the RMS EVM of the burst. This value is expressed as a percentage or 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_rms_magnitude_error_mean(selector_string)

Gets the RMS magnitude error of the received constellation, which is the RMS level of the one minus the magnitude error of the received constellation symbols. This value is expressed as a percentage.

When you set this AVERAGING_ENABLED attribute to True, this result returns the mean of the RMS magnitude error computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the RMS magnitude error of the received constellation, which is the RMS level of the one minus the magnitude error of the received constellation symbols. This value is expressed as a percentage.

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_rms_phase_error_mean(selector_string)

Gets the RMS phase error of the received constellation, which is the RMS level of difference between the ideal and the actual values of the phase of the received constellation symbols. This value is expressed in degrees.

When you set this AVERAGING_ENABLED attribute to True, this result returns the mean of the RMS phase error computed for each averaging count.

You do not need to use a selector string to read this result for default signal and result instance. Refer to the Selector String topic for information about the string syntax for named signals and results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the RMS phase error of the received constellation, which is the RMS level of difference between the ideal and the actual values of the phase of the received constellation symbols. This value is expressed in degrees.

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)