PowerRampConfiguration

Provides methods to configure the PowerRamp measurement.

class nirfmxbluetooth.powerramp_configuration.PowerRampConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the PowerRamp measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

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

    This parameter specifies whether to enable averaging for the PowerRamp 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 PowerRamp 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 PowerRamp 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.PowerRampBurstSynchronizationType, int) –

    This parameter specifies the type of synchronization used for detecting the start of packet in the PowerRamp 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 the Access Address for LE-CS packets to detect the start of the packet.

Returns:

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

Return type:

int

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

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PowerRampAveragingEnabled):

Specifies whether to enable averaging for PowerRamp 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_synchronization_type(selector_string)[source]

Gets the type of synchronization used for detecting the start of packet in the PowerRamp 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 bits to detect the start of the packet.

Sync Word (2)

Specifies that the measurement uses the Access Address for LE-CS packets to detect the start of the packet.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PowerRampBurstSynchronizationType):

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

Gets whether to enable PowerRamp measurements. This measurement is valid only for low energy CS (LE-CS) packets.

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 PowerRamp measurements. This measurement is valid only for low energy CS (LE-CS) packets.

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 PowerRamp 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 PowerRamp 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_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 PowerRamp 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 measurement uses the PowerRamp Averaging Count attribute as the number of acquisitions over which the PowerRamp measurement is averaged.
Parameters:
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 the PowerRamp 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 bits to detect the start of the packet.

Sync Word (2)

Specifies that the measurement uses the Access Address for LE-CS packets to detect the start of the packet.
Parameters:

  • selector_string (string) – Pass an empty string.

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

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 PowerRamp measurements. This measurement is valid only for low energy CS (LE-CS) packets.

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 PowerRamp measurements. This measurement is valid only for low energy CS (LE-CS) packets.

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 PowerRamp 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 PowerRamp measurement.

Returns:

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

Return type:

int