TxpConfiguration

Provides methods to configure the Txp measurement.

class nirfmxwlan.txp_configuration.TxpConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Txp measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for the measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

averaging_enabled (enums.TxpAveragingEnabled, int) –

This parameter specifies whether to enable averaging for the TXP measurement. The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The measurement uses the Averaging Count parameter as the number of acquisitions over which the results are averaged.

averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

Returns:

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

Return type:

int

configure_burst_detection_enabled(selector_string, burst_detection_enabled)[source]

Configures burst detection for the TXP measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
burst_detection_enabled (enums.TxpBurstDetectionEnabled, int) –
This parameter specifies whether the measurement detects the start and the end of a WLAN packet automatically. The default value is True.

Name (Value)

Description

False (0)

Disables burst detection.

True (1)

Enables burst detection.

Returns:

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

Return type:

int

configure_maximum_measurement_interval(selector_string, maximum_measurement_interval)[source]

Configures the maximum measurement interval for the TXP measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
maximum_measurement_interval (float) – This parameter specifies the maximum measurement interval. This value is expressed in seconds. When you set the BURST_DETECTION_ENABLED attribute to True, the measurement interval used is equal to the smaller of the duration of the WLAN packet under analysis or the value you set for this parameter. The default value is 0.001.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the TXP measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Specifies whether to enable the traces to be stored and retrieved after performing the TXP 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_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to 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_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the TXP measurement.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The TXP measurement uses the TXP Averaging Count attribute as the number of acquisitions over which the TXP measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpAveragingEnabled):: Specifies whether to enable averaging for the TXP 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_burst_detection_enabled(selector_string)[source]

Gets whether the measurement detects the start and the end of a WLAN packet automatically.

When you set this attribute to True, the measurement interval used is equal to the smaller of the duration of the WLAN packet under analysis or the value you set for the MAXIMUM_MEASUREMENT_INTERVAL attribute.

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

The default value is True.

Name (Value)	Description
False (0)	Disables burst detection.
True (1)	Enables burst detection.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpBurstDetectionEnabled):: Specifies whether the measurement detects the start and the end of a WLAN packet automatically.
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_maximum_measurement_interval(selector_string)[source]

Gets the maximum measurement interval. This value is expressed in seconds.

When you set the BURST_DETECTION_ENABLED attribute to True, the measurement interval used is equal to the smaller of the duration of the WLAN packet under analysis or the value you set for this attribute.

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

The default value is 1 millisecond.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the maximum measurement interval. This value is expressed in seconds.
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_measurement_enabled(selector_string)[source]

Gets whether to enable the transmit power (TXP) measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Specifies whether to enable the transmit power (TXP) 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_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for TXP measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the maximum number of threads used for parallelism for TXP 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the TXP measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the TXP measurement.

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the TXP measurement.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The TXP measurement uses the TXP Averaging Count attribute as the number of acquisitions over which the TXP measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TxpAveragingEnabled, int) – Specifies whether to enable averaging for the TXP measurement.

Returns:

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

Return type:

int

set_burst_detection_enabled(selector_string, value)[source]

Sets whether the measurement detects the start and the end of a WLAN packet automatically.

When you set this attribute to True, the measurement interval used is equal to the smaller of the duration of the WLAN packet under analysis or the value you set for the MAXIMUM_MEASUREMENT_INTERVAL attribute.

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

The default value is True.

Name (Value)	Description
False (0)	Disables burst detection.
True (1)	Enables burst detection.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TxpBurstDetectionEnabled, int) – Specifies whether the measurement detects the start and the end of a WLAN packet automatically.

Returns:

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

Return type:

int

set_maximum_measurement_interval(selector_string, value)[source]

Sets the maximum measurement interval. This value is expressed in seconds.

When you set the BURST_DETECTION_ENABLED attribute to True, the measurement interval used is equal to the smaller of the duration of the WLAN packet under analysis or the value you set for this attribute.

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

The default value is 1 millisecond.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the maximum measurement interval. This value is expressed in seconds.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the transmit power (TXP) measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Specifies whether to enable the transmit power (TXP) measurement.

Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for TXP measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the maximum number of threads used for parallelism for TXP measurement.

Returns:

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

Return type:

int