AcpConfiguration

Provides methods to configure the Acp measurement.

class nirfmxbluetooth.acp_configuration.AcpConfiguration(signal_obj)

Bases: object

Provides methods to configure the Acp measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)

Configures averaging for the adjacent channel power (ACP) 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.AcpAveragingEnabled, int) –

  This parameter specifies whether to enable averaging for the ACP 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 ACP 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)

Configures the type of synchronization used for detecting the start of the packet in the adjacent channel power (ACP) 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.AcpBurstSynchronizationType, 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

configure_number_of_offsets(selector_string, number_of_offsets)

Configures the number of offsets for the adjacent channel power (ACP) measurement.

Parameters:

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

• number_of_offsets (int) – This parameter specifies the number of offset channels used on either side of the reference channel for the ACP measurement when you set the OFFSET_CHANNEL_MODE attribute to Symmetric. This parameter returns the actual number of offsets used in the ACP measurement when you set the ACP Offset Channel Mode attribute to In-band. The default value is 5.

Returns:

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

Return type:

int

configure_offset_channel_mode(selector_string, offset_channel_mode)

Configures the offset channels used for the adjacent channel power (ACP) measurement.

Parameters:

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

• offset_channel_mode (enums.AcpOffsetChannelMode, int) –

  This parameter specifies which offset channels are used for the measurement. The default value is Symmetric.

  Name (Value)	Description
  Symmetric (0)	Specifies that the offset channels are symmetrically located around the reference channel. The number of offsets on either side of the reference channel is specified by the ACP Num Offsets attribute. In symmetric mode, the Center Frequency attribute specifies the frequency of the reference channel, expressed in Hz.
  In-band (1)	Specifies that the measurement is performed over all the channels as specified by the standard. For BR and EDR packets, 79 channels starting from 2.402GHz to 2.48GHz are used for the measurement. For LE packets, 81 channels starting from 2.401GHz to 2.481GHz are used for the measurement. In In-band mode, the Center Frequency attribute specifies the frequency of acquisition which must be equal to 2.441GHz. Configure the Channel Number attribute to specify the frequency of the reference channel.

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)

Gets whether to enable all traces for the adjacent channel power (ACP) 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 traces for the adjacent channel power (ACP) 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)

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)

Gets whether to enable averaging for the ACP 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 ACP Averaging Count attribute as the number of acquisitions over which the ACP measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpAveragingEnabled):

Specifies whether to enable averaging for the ACP 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)

Gets the type of synchronization used for detecting the start of the EDR packet in the adjacent channel power (ACP) 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 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.AcpBurstSynchronizationType):

Specifies the type of synchronization used for detecting the start of the EDR packet in the adjacent channel power (ACP) 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)

Gets whether to enable the ACP measurement.

You do not need to use a selector string to 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 ACP 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)

Gets the maximum number of threads used for parallelism for adjacent channel power (ACP) 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 adjacent channel power (ACP) 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_offsets(selector_string)

Gets the number of offset channels used on either side of the reference channel for the adjacent channel power (ACP) measurement when you set the OFFSET_CHANNEL_MODE attribute to Symmetric. This attribute also returns the actual number of offsets used in the ACP measurement when you set the ACP Offset Channel Mode attribute to In-band.

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 5. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of offset channels used on either side of the reference channel for the adjacent channel power (ACP) measurement when you set the OFFSET_CHANNEL_MODE attribute to Symmetric. This attribute also returns the actual number of offsets used in the ACP measurement when you set the ACP Offset Channel Mode attribute to In-band.

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

Gets which offset channels are used for the 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 Symmetric.

Name (Value)	Description
Symmetric (0)	Specifies that the offset channels are symmetrically located around the reference channel. The number of offsets on either side of the reference channel is specified by the ACP Num Offsets attribute. In symmetric mode, the Center Frequency attribute specifies the frequency of the reference channel, expressed in Hz.
In-band (1)	Specifies that the measurement is performed over all the channels as specified by the standard. For BR and EDR packets, 79 channels starting from 2.402GHz to 2.48GHz are used for the measurement. For LE packets, 81 channels starting from 2.401GHz to 2.481GHz are used for the measurement. In In-band mode, the Center Frequency attribute specifies the frequency of acquisition which must be equal to 2.441GHz. Configure the Channel Number attribute to specify the frequency of the reference channel.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpOffsetChannelMode):

Specifies which offset channels are used for the 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_offset_frequency(selector_string)

Gets the frequency of the offset channel with respect to the reference channel frequency. This value is expressed in Hz.

Use “offset<n>” as the Selector String to configure or read this attribute.

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency of the offset channel with respect to the reference channel frequency. This value is expressed in Hz.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_reference_channel_bandwidth(selector_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Name (Value)	Description
Auto (0)
Manual (1)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpReferenceChannelBandwidthMode):

Name (Value)	Description
Auto (0)
Manual (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 (attr_val, error_code)

set_all_traces_enabled(selector_string, value)

Sets whether to enable all traces for the adjacent channel power (ACP) 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 traces for the adjacent channel power (ACP) 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)

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)

Sets whether to enable averaging for the ACP 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 ACP Averaging Count attribute as the number of acquisitions over which the ACP measurement is averaged.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AcpAveragingEnabled, int) – Specifies whether to enable averaging for the ACP 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_synchronization_type(selector_string, value)

Sets the type of synchronization used for detecting the start of the EDR packet in the adjacent channel power (ACP) 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 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.AcpBurstSynchronizationType, int) – Specifies the type of synchronization used for detecting the start of the EDR packet in the adjacent channel power (ACP) 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)

Sets whether to enable the ACP measurement.

You do not need to use a selector string to 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 ACP 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)

Sets the maximum number of threads used for parallelism for adjacent channel power (ACP) 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 adjacent channel power (ACP) 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_offsets(selector_string, value)

Sets the number of offset channels used on either side of the reference channel for the adjacent channel power (ACP) measurement when you set the OFFSET_CHANNEL_MODE attribute to Symmetric. This attribute also returns the actual number of offsets used in the ACP measurement when you set the ACP Offset Channel Mode attribute to In-band.

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 5. Valid values are 0 to 100, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of offset channels used on either side of the reference channel for the adjacent channel power (ACP) measurement when you set the OFFSET_CHANNEL_MODE attribute to Symmetric. This attribute also returns the actual number of offsets used in the ACP measurement when you set the ACP Offset Channel Mode attribute to In-band.

Returns:

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

Return type:

int

set_offset_channel_mode(selector_string, value)

Sets which offset channels are used for the 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 Symmetric.

Name (Value)	Description
Symmetric (0)	Specifies that the offset channels are symmetrically located around the reference channel. The number of offsets on either side of the reference channel is specified by the ACP Num Offsets attribute. In symmetric mode, the Center Frequency attribute specifies the frequency of the reference channel, expressed in Hz.
In-band (1)	Specifies that the measurement is performed over all the channels as specified by the standard. For BR and EDR packets, 79 channels starting from 2.402GHz to 2.48GHz are used for the measurement. For LE packets, 81 channels starting from 2.401GHz to 2.481GHz are used for the measurement. In In-band mode, the Center Frequency attribute specifies the frequency of acquisition which must be equal to 2.441GHz. Configure the Channel Number attribute to specify the frequency of the reference channel.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AcpOffsetChannelMode, int) – Specifies which offset channels are used for the measurement.

Returns:

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

Return type:

int

set_reference_channel_bandwidth(selector_string, value)

Parameters:

• selector_string (string) – Pass an empty string.

• value (float)

Returns:

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

Return type:

int

set_reference_channel_bandwidth_mode(selector_string, value)

Name (Value)	Description
Auto (0)
Manual (1)

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AcpReferenceChannelBandwidthMode, int) –

  Name (Value)	Description
  Auto (0)
  Manual (1)

Returns:

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

Return type:

int