ModAccConfiguration

Provides methods to configure the ModAcc measurement.

class nirfmxbluetooth.modacc_configuration.ModAccConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the ModAcc measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for the ModAcc 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.ModAccAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for the ModAcc 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 ModAcc measurement is 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_synchronization_type(selector_string, burst_synchronization_type)[source]

Configures the burst synchronization type for ModAcc measurement.

Parameters:

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

  • burst_synchronization_type (enums.ModAccBurstSynchronizationType, int) –

    This parameter specifies the type of synchronization used for detecting the start of packet in the measurement. The default value is Preamble.

    Name (value)

    Description

    None (0)

    Specifies that the measurement does not perform synchronization to detect the start of the packet.

    Preamble (1)

    Specifies that the measurement uses the preamble field bits to detect the start of the packet.

    Sync Word (2)

    Specifies that the measurement uses sync word for the BR/EDR packets and access address for the LE/LE-CS packets to detect the start of the packet. For BR /EDR packets, the sync word is derived from the BD_ADDRESS_LAP attribute.

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 all the traces computed by ModAcc measurements.

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 all the traces computed by ModAcc measurements.

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 ModAcc measurements.

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 measurement uses the ModAcc Averaging Count attribute as the number of acquisitions over which the ModAcc measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccAveragingEnabled):

Specifies whether to enable averaging for the ModAcc measurements.

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_synchronization_type(selector_string)[source]

Gets the type of synchronization used for detecting the start of packet in ModAcc 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 Preamble.

Name (Value)

Description

None (0)

Specifies that the measurement does not perform synchronization to detect the start of the packet.

Preamble (1)

Specifies that the measurement uses the preamble field to detect the start of the packet.

Sync Word (2)

Specifies that the measurement uses sync word for the BR/EDR packets and access address for the LE/LE-CS packets to detect the start of the packet. For BR /EDR packets, the sync word is derived from the BD Address LAP attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccBurstSynchronizationType):

Specifies the type of synchronization used for detecting the start of packet in ModAcc 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_frequency_tracking_enabled(selector_string)[source]

Gets whether to enable frequency tracking for LE- HDT packet. If you set this attribute to True, the Control Header EVM, Payload EVM, Payload Frequency Error w1 and Frequency Error w0+w1 results are computed after frequency tracking.

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)

Disables the frequency tracking for LE-HDT packets.

True (1)

Enables the frequency tracking for LE-HDT packets.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccFrequencyTrackingEnabled):

Specifies whether to enable frequency tracking for LE- HDT packet. If you set this attribute to True, the Control Header EVM, Payload EVM, Payload Frequency Error w1 and Frequency Error w0+w1 results are computed after frequency tracking.

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_mismatch_correction_enabled(selector_string)[source]

Gets whether to enable the IQ mismatch correction for LE- HDT packet. If you set this attribute to True, the EVM results are computed after correcting for the IQ gain imbalance and quadrature error .

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)

Disables the IQ mismatch correction for LE-HDT packets.

True (1)

Enables the IQ mismatch correction for LE-HDT packets.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQMismatchCorrectionEnabled):

Specifies whether to enable the IQ mismatch correction for LE- HDT packet. If you set this attribute to True, the EVM results are computed after correcting for the IQ gain imbalance and quadrature error .

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_correction_enabled(selector_string)[source]

Gets whether to enable the I/Q origin offset correction for EDR and LE-HDT packets. If you set this attribute to True, the DEVM and EVM results are computed after correcting for the I/Q origin offset.

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)

Disables the I/Q origin offset correction for EDR and LE-HDT packets.

True (1)

Enables the I/Q origin offset correction for EDR and LE-HDT packets.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQOriginOffsetCorrectionEnabled):

Specifies whether to enable the I/Q origin offset correction for EDR and LE-HDT packets. If you set this attribute to True, the DEVM and EVM results are computed after correcting for the I/Q origin offset.

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 ModAcc measurements. You can use this attribute to determine the modulation quality of the bluetooth transmitter.

You can perform the following sub-measurements when ModAcc measurement is enabled: <ul><li> DEVM, on EDR packets</li> <li> df1, on BR and LE packets</li> <li> df2, on BR and LE packets</li> <li> Frequency Error, on BR, EDR, LE and LE-CS packets</li></ul>

The listed sub-measurements are enabled or disabled based on the value of the PAYLOAD_BIT_PATTERN 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 FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the ModAcc measurements. You can use this attribute to determine the modulation quality of the bluetooth transmitter.

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 the ModAcc 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 the ModAcc 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.

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 all the traces computed by ModAcc measurements.

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 all the traces computed by ModAcc measurements.

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 ModAcc measurements.

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 measurement uses the ModAcc Averaging Count attribute as the number of acquisitions over which the ModAcc measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccAveragingEnabled, int) – Specifies whether to enable averaging for the ModAcc measurements.

Returns:

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

Return type:

int

set_burst_synchronization_type(selector_string, value)[source]

Sets the type of synchronization used for detecting the start of packet in ModAcc 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 Preamble.

Name (Value)

Description

None (0)

Specifies that the measurement does not perform synchronization to detect the start of the packet.

Preamble (1)

Specifies that the measurement uses the preamble field to detect the start of the packet.

Sync Word (2)

Specifies that the measurement uses sync word for the BR/EDR packets and access address for the LE/LE-CS packets to detect the start of the packet. For BR /EDR packets, the sync word is derived from the BD Address LAP attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccBurstSynchronizationType, int) – Specifies the type of synchronization used for detecting the start of packet in ModAcc measurement.

Returns:

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

Return type:

int

set_frequency_tracking_enabled(selector_string, value)[source]

Sets whether to enable frequency tracking for LE- HDT packet. If you set this attribute to True, the Control Header EVM, Payload EVM, Payload Frequency Error w1 and Frequency Error w0+w1 results are computed after frequency tracking.

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)

Disables the frequency tracking for LE-HDT packets.

True (1)

Enables the frequency tracking for LE-HDT packets.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccFrequencyTrackingEnabled, int) – Specifies whether to enable frequency tracking for LE- HDT packet. If you set this attribute to True, the Control Header EVM, Payload EVM, Payload Frequency Error w1 and Frequency Error w0+w1 results are computed after frequency tracking.

Returns:

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

Return type:

int

set_iq_mismatch_correction_enabled(selector_string, value)[source]

Sets whether to enable the IQ mismatch correction for LE- HDT packet. If you set this attribute to True, the EVM results are computed after correcting for the IQ gain imbalance and quadrature error .

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)

Disables the IQ mismatch correction for LE-HDT packets.

True (1)

Enables the IQ mismatch correction for LE-HDT packets.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccIQMismatchCorrectionEnabled, int) – Specifies whether to enable the IQ mismatch correction for LE- HDT packet. If you set this attribute to True, the EVM results are computed after correcting for the IQ gain imbalance and quadrature error .

Returns:

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

Return type:

int

set_iq_origin_offset_correction_enabled(selector_string, value)[source]

Sets whether to enable the I/Q origin offset correction for EDR and LE-HDT packets. If you set this attribute to True, the DEVM and EVM results are computed after correcting for the I/Q origin offset.

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)

Disables the I/Q origin offset correction for EDR and LE-HDT packets.

True (1)

Enables the I/Q origin offset correction for EDR and LE-HDT packets.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccIQOriginOffsetCorrectionEnabled, int) – Specifies whether to enable the I/Q origin offset correction for EDR and LE-HDT packets. If you set this attribute to True, the DEVM and EVM results are computed after correcting for the I/Q origin offset.

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 ModAcc measurements. You can use this attribute to determine the modulation quality of the bluetooth transmitter.

You can perform the following sub-measurements when ModAcc measurement is enabled: <ul><li> DEVM, on EDR packets</li> <li> df1, on BR and LE packets</li> <li> df2, on BR and LE packets</li> <li> Frequency Error, on BR, EDR, LE and LE-CS packets</li></ul>

The listed sub-measurements are enabled or disabled based on the value of the PAYLOAD_BIT_PATTERN 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 FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the ModAcc measurements. You can use this attribute to determine the modulation quality of the bluetooth transmitter.

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 the ModAcc 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 the ModAcc 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.

Returns:

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

Return type:

int