AcpResults

Provides methods to fetch and read the Acp measurement results.

class nirfmxbluetooth.acp_results.AcpResults(signal_obj)

Bases: object

Provides methods to fetch and read the Acp measurement results.

fetch_absolute_power_trace(selector_string, timeout, absolute_power)

Fetches the absolute power trace for ACP measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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. This value is expressed in seconds. 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. The default value is 10.

• absolute_power (numpy.float32) – This parameter returns the power measured in the carrier and offset channels. This value is expressed in Hz.

Returns:

x0 (float):

This parameter returns the start frequency. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing. 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 (x0, dx, error_code)

fetch_mask_trace(selector_string, timeout, limit_with_exception_mask, limit_without_exception_mask)

Fetches the limit with exception mask and limit without exception mask traces for ACP measurement. This method returns a valid trace only if you set the OFFSET_CHANNEL_MODE attribute to In-band.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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. This value is expressed in seconds. 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. The default value is 10.

• limit_with_exception_mask (numpy.float32) – This parameter returns the limit with exception mask used for the measurement. This value is expressed in dBm.

• limit_without_exception_mask (numpy.float32) – This parameter returns the limit with exception mask used for the measurement. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start frequency, which is the center frequency of the lowest offset. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing. 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 (x0, dx, error_code)

fetch_measurement_status(selector_string, timeout)

Fetches the overall ACP measurement status based on the measurement limits as defined by the standard if you set the OFFSET_CHANNEL_MODE attribute to In-Band. This method is not valid if you set the ACP Offset Channel Mode attribute to Symmetric.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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. This value is expressed in seconds. 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. The default value is 10.

Returns:

measurement_status (enums.AcpResultsMeasurementStatus):

This parameter returns the overall measurement status based on the measurement limits specified by the standard when you set the ACP Offset Channel Mode attribute to In-Band. Refer to MEASUREMENT_STATUS attribute for more information about measurement status.

error_code (int):

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

Return type:

Tuple (measurement_status, error_code)

fetch_offset_measurement(selector_string, timeout)

Fetches the absolute powers, relative powers and margins measured in the offset channel.

Use “offset<k>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number, and the result name.

  Example:

  ”offset0”

  ”result::r1/offset0”

  You can use the RFmxBT Build Offset String method to build the selector string.

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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. The default value is 10.

Returns:

lower_absolute_power (float):

This parameter returns the absolute power measured in the lower offset channel. This value is expressed in dBm.

upper_absolute_power (float):

This parameter returns the absolute power measured in the upper offset channel. This value is expressed in dBm.

lower_relative_power (float):

This parameter returns the relative power in the lower offset channel measured with respect to the reference channel power. This value is expressed in dB.

upper_relative_power (float):

This parameter returns the relative power in the upper offset channel measured with respect to the reference channel power. This value is expressed in dB.

lower_margin (float):

This parameter returns the margin from the limit specified by the mask with exception for lower offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This parameter is valid only if you set the OFFSET_CHANNEL_MODE attribute to In-band. This parameter returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

upper_margin (float):

This parameter returns the margin from the limit specified by the mask with exception for upper offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This parameter is valid only if you set the ACP Offset Channel Mode attribute to In-band. This parameter returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

error_code (int):

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

Return type:

Tuple (lower_absolute_power, upper_absolute_power, lower_relative_power, upper_relative_power, lower_margin, upper_margin, error_code)

fetch_offset_measurement_array(selector_string, timeout)

Fetches the array of absolute powers, relative powers and margins measured in the offset channels.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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. This value is expressed in seconds. 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. The default value is 10.

Returns:

lower_absolute_power (float):

This parameter returns the array of absolute power measured in the lower offset channel. This value is expressed in dBm.

upper_absolute_power (float):

This parameter returns the array of absolute power measured in the upper offset channel. This value is expressed in dBm.

lower_relative_power (float):

This parameter returns the array of relative power in the lower offset channel measured with respect to the reference channel power. This value is expressed in dB.

upper_relative_power (float):

This parameter returns array of the relative power in the upper offset channel measured with respect to the reference channel power. This value is expressed in dB.

lower_margin (float):

This parameter returns the array of margin from the limit specified by the mask with Exception for lower offset channel. This value is expressed in dB. Margin is defined as the difference between the Offset Absolute Power and Mask with Exception. This parameter is valid only if you set the OFFSET_CHANNEL_MODE attribute to In-band. This parameter returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

upper_margin (float):

This parameter returns the array of the margin from the limit specified by the mask with Exception for upper offset channel. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This parameter is valid only if you set the ACP Offset Channel Mode attribute to In-band. This parameter returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

error_code (int):

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

Return type:

Tuple (lower_absolute_power, upper_absolute_power, lower_relative_power, upper_relative_power, lower_margin, upper_margin, error_code)

fetch_reference_channel_power(selector_string, timeout)

Returns the measured power of the reference channel.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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. This value is expressed in seconds. 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. The default value is 10.

Returns:

reference_channel_power (float):

This parameter returns the measured power of the reference channel. 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 (reference_channel_power, error_code)

fetch_spectrum(selector_string, timeout, spectrum)

Fetches the spectrum used for ACP measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the 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. This value is expressed in seconds. 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. The default value is 10.

• spectrum (numpy.float32) – This parameter returns the averaged power measured at each frequency bin. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start frequency. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing. 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 (x0, dx, error_code)

get_lower_offset_absolute_power(selector_string)

Gets the absolute power measured in the lower offset channel. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute power measured in the lower offset channel. 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_lower_offset_margin(selector_string)

Gets the margin from the limit specified by the mask with exception for lower offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This result is valid only if you set the OFFSET_CHANNEL_MODE attribute to In-band. This attribute returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the margin from the limit specified by the mask with exception for lower offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This result is valid only if you set the OFFSET_CHANNEL_MODE attribute to In-band. This attribute returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

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

Gets the relative power in the lower offset channel measured with respect to the reference channel power. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the relative power in the lower offset channel measured with respect to the reference channel power. 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_measurement_status(selector_string)

Indicates the overall measurement status based on the measurement limits specified by the standard when you set the OFFSET_CHANNEL_MODE attribute to In-band.

The standard defines two masks, mask with exception and mask without exception. Mask with exception is more stringent than mask without exception.

The mask with exception limits are as follows:

PHY	Data Rate (bps)	Offset 0	Offset 1	Offset 2	Offset 3	Offset 4	Offset (greater than or equal to 5)
BR	NA	NA	less than or equal to -20 dBm	less than or equal to -40 dBm	less than or equal to -40 dBm	less than or equal to -40 dBm	less than or equal to -40 dBm
EDR	NA	less than or equal to (Reference Channel Power (dBm) - 26)	less than or equal to -20 dBm	less than or equal to -40 dBm	less than or equal to -40 dBm	less than or equal to -40 dBm	less than or equal to -40 dBm
LE	1 Mbps	NA	less than or equal to -20 dBm	less than or equal to -30 dBm	less than or equal to -30 dBm	less than or equal to -30 dBm	less than or equal to -30 dBm
LE	2 Mbps	NA	NA	NA	less than or equal to -20 dBm	less than or equal to -20 dBm	less than or equal to -30 dBm

The mask without exception limits for all packet type are as follows:

PHY	Data Rate (bps)	Offset (2) to Offset (4)	Offset (greater than or equal to 5)
BR	NA	less than or equal to -20 dBm	less than or equal to -20 dBm
EDR	NA	less than or equal to -20 dBm	less than or equal to -20 dBm
LE	1 Mbps	less than or equal to -20 dBm	less than or equal to -20 dBm
LE	2 Mbps	NA	less than or equal to -20 dBm

You do not need to use a selector string to read this result for the 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
Not Applicable (-1)	This attribute returns Not Applicable when you set the ACP Offset Channel Mode attribute to Symmetric.
Fail (0)	This attribute returns Fail if more than 3 offsets from offset 3 onwards fail the mask with exception or any offset channel fails the mask without exception.
Pass (1)	This attribute returns Pass if all offsets except up to a maximum of 3 from offset 3 onwards do not fail the mask with exception and all offset channels do not fail the mask without exception.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpResultsMeasurementStatus):

Indicates the overall measurement status based on the measurement limits specified by the standard when you set the 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_reference_channel_power(selector_string)

Gets the measured power of the reference channel. This value is expressed in dBm.

You do not need to use a selector string to read this result for the 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 measured power of the reference channel. 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_upper_offset_absolute_power(selector_string)

Gets the absolute power measured in the upper offset channel. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute power measured in the upper offset channel. 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_upper_offset_margin(selector_string)

Gets the margin from the limit specified by the mask with exception for upper offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This result is valid only if you set the OFFSET_CHANNEL_MODE attribute to In-band. This attribute returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the margin from the limit specified by the mask with exception for upper offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This result is valid only if you set the OFFSET_CHANNEL_MODE attribute to In-band. This attribute returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric.

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

Gets the relative power in the upper offset channel measured with respect to the reference channel power. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the relative power in the upper offset channel measured with respect to the reference channel power. 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)