TxpResults

Provides methods to fetch and read the Txp measurement results.

class nirfmxbluetooth.txp_results.TxpResults(signal_obj)

Bases: object

Provides methods to fetch and read the Txp measurement results.

fetch_edr_powers(selector_string, timeout)

Fetches TXP measurement results for enhanced data rate (EDR) packets.

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:

edr_gfsk_average_power_mean (float):

This parameter returns the average power of the GFSK portion of the EDR packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the GFSK average power results computed for each averaging count. This value is expressed in dBm.

edr_dpsk_average_power_mean (float):

This parameter returns the average power of the DPSK portion of the EDR packet. When you set the TXP Averaging Enabled attribute to True, it returns the mean of the DPSK average power results computed for each averaging count. This value is expressed in dBm.

edr_dpsk_gfsk_average_power_ratio_mean (float):

This parameter returns the ratio of the average power of the DPSK portion to the average power of the GFSK portion of the EDR packet. When you set the TXP Averaging Enabled attribute to True, it returns the mean of the DPSK GFSK average power ratio results computed for each averaging count. 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 (edr_gfsk_average_power_mean, edr_dpsk_average_power_mean, edr_dpsk_gfsk_average_power_ratio_mean, error_code)

fetch_le_cte_reference_period_powers(selector_string, timeout)

Fetches the transmit power (TXP) measurement results over the reference period of the constant tone extension (CTE) portion for low energy (LE) packets when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure.

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_period_average_power_mean (float):

This parameter returns the average power computed over the reference period in the CTE portion of the LE packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the CTE reference period average power results computed for each averaging count. This value is expressed in dBm.

reference_period_peak_absolute_power_deviation_maximum (float):

This parameter returns the peak absolute power deviation computed over the reference period in the CTE portion of the LE packet. The peak absolute power deviation is the deviation of peak power with respect to the average power in the reference period. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the CTE reference period absolute power deviation results computed for each averaging count. This value is expressed as a percentage.

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_period_average_power_mean, reference_period_peak_absolute_power_deviation_maximum, error_code)

fetch_le_cte_transmit_slot_powers(selector_string, timeout)

Fetches the transmit power (TXP) measurement results over each transmit slot of the constant tone extension (CTE) portion for low energy (LE) packets when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure.

Parameters:

• selector_string (string) –

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

  Example:

  ”slot0”

  ”result::r1/slot0”

  You can use the build_slot_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:

transmit_slot_average_power_mean (float):

This parameter returns the average power computed over each transmit slot in CTE portion of the LE packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the CTE transmit slot average power results computed for each averaging count. This value is expressed in dBm.

transmit_slot_peak_absolute_power_deviation_maximum (float):

This parameter returns the peak absolute power deviation computed over each transmit slot in the CTE portion of the LE packet. The peak absolute power deviation is the deviation of peak power in each transmit slot with respect to the average power in that transmit slot. When you set the TXP�Averaging�Enabled attribute to True, it returns the maximum of the CTE transmit slot absolute power deviation results computed for each averaging count. This value is expressed as a percentage.

error_code (int):

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

Return type:

Tuple (transmit_slot_average_power_mean, transmit_slot_peak_absolute_power_deviation_maximum, error_code)

fetch_le_cte_transmit_slot_powers_array(selector_string, timeout)

Fetches an array of transmit power (TXP) measurement results over all the transmit slots of constant tone extension (CTE) portion for low energy (LE) packets when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure.

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:

transmit_slot_average_power_mean (float):

This parameter returns an array of average powers computed over every transmit slot in CTE portion of the LE packet. When you set the AVERAGING_ENABLED attribute to True, it returns an array of mean of the CTE transmit slot average power results computed for each averaging count. This value is expressed in dBm.

transmit_slot_peak_absolute_power_deviation_maximum (float):

This parameter returns an array of peak absolute power deviations computed over every transmit slot in CTE portion of the LE packet. The peak absolute power deviation is the deviation of peak power in each transmit slot with respect to the average power in that transmit slot. When you set the TXP�Averaging�Enabled attribute to True, it returns an array of maximum of the CTE transmit slot absolute power deviation results computed for each averaging count. This value is expressed as a percentage.

error_code (int):

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

Return type:

Tuple (transmit_slot_average_power_mean, transmit_slot_peak_absolute_power_deviation_maximum, error_code)

fetch_power_trace(selector_string, timeout, power)

Fetches the power versus time trace.

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.

• power (numpy.float32) – This parameter returns the averaged power at each time instance. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start time. This value is expressed in seconds.

dx (float):

This parameter returns the sample duration. 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 (x0, dx, error_code)

fetch_powers(selector_string, timeout)

Fetches TXP measurement results. These results are valid for all packets.

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:

average_power_mean (float):

This parameter returns the average power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the average power results computed for each averaging count. This value is expressed in dBm.

average_power_maximum (float):

This parameter returns the average power computed over the measurement interval. When you set the Direction Finding Mode attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. When you set the TXP Averaging Enabled attribute to True, it returns the maximum of the average power results computed for each averaging count. This value is expressed in dBm.

average_power_minimum (float):

This parameter returns the average power computed over the measurement interval. When you set the Direction Finding Mode attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. When you set the TXP Averaging Enabled attribute to True, it returns the minimum of the average power results computed for each averaging count. This value is expressed in dBm.

peak_to_average_power_ratio_maximum (float):

This parameter returns the peak to average power ratio computed over the measurement interval. When you set the Direction Finding Mode attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the peak to average power ratio computation. For LE-HDT, PAPR is calculated using peak power calculated over active portion of burst and average power calculated from beginning of the payload portion. When you set the TXP Averaging Enabled attribute to True, it returns the maximum of the peak to average power ratio results computed for each averaging count. 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 (average_power_mean, average_power_maximum, average_power_minimum, peak_to_average_power_ratio_maximum, error_code)

get_average_power_maximum(selector_string)

Gets the average power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the average power results computed for each averaging count. 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 average power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the average power results computed for each averaging count. 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_average_power_mean(selector_string)

Gets the average power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. This value is expressed in dBm. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the average power results computed for each averaging count.

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 average power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. This value is expressed in dBm. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the average power results computed for each averaging count.

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

Gets the average power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. When you set the AVERAGING_ENABLED attribute to True, it returns the minimum of the average power results computed for each averaging count. 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 average power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the average power computation. For LE-HDT, average power is calculated from beginning of the payload portion. When you set the AVERAGING_ENABLED attribute to True, it returns the minimum of the average power results computed for each averaging count. 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_edr_dpsk_average_power_mean(selector_string)

Gets the average power of the DPSK portion of the EDR packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the DPSK average power results computed for each averaging count. 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 average power of the DPSK portion of the EDR packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the DPSK average power results computed for each averaging count. 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_edr_dpsk_gfsk_average_power_ratio_mean(selector_string)

Gets the ratio of the average power of the DPSK portion to the average power of the GFSK portion of the EDR packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the DPSK GFSK average power ratio results computed for each averaging count. This value is expressed in dB.

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 ratio of the average power of the DPSK portion to the average power of the GFSK portion of the EDR packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the DPSK GFSK average power ratio results computed for each averaging count. 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_edr_gfsk_average_power_mean(selector_string)

Gets the average power of the GFSK portion of the EDR packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the GFSK average power results computed for each averaging count. 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 average power of the GFSK portion of the EDR packet. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the GFSK average power results computed for each averaging count. 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_le_cs_phase_measurement_period_average_power_mean(selector_string)

Gets the average power computed over each antenna path during phase measurement period of the LE-CS packet. This result is applicable only when you set the PACKET_TYPE attribute to LE-CS and the CHANNEL_SOUNDING_PACKET_FORMAT attribute to any value other than SYNC. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the phase measurement period average power results computed for each averaging count. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power computed over each antenna path during phase measurement period of the LE-CS packet. This result is applicable only when you set the PACKET_TYPE attribute to LE-CS and the CHANNEL_SOUNDING_PACKET_FORMAT attribute to any value other than SYNC. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the phase measurement period average power results computed for each averaging count. 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_le_cte_reference_period_average_power_mean(selector_string)

Gets the average power computed over the reference period in the CTE portion of the LE packet. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the CTE reference period average power results computed for each averaging count. 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 average power computed over the reference period in the CTE portion of the LE packet. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the CTE reference period average power results computed for each averaging count. 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_le_cte_reference_period_peak_absolute_power_deviation_maximum(selector_string)

Gets the peak absolute power deviation computed over the reference period in the CTE portion of the LE packet. The peak absolute power deviation is the deviation of peak power with respect to the average power in the reference period. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the CTE reference period absolute power deviation results computed for each averaging count. This value is expressed as a percentage.

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 peak absolute power deviation computed over the reference period in the CTE portion of the LE packet. The peak absolute power deviation is the deviation of peak power with respect to the average power in the reference period. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the CTE reference period absolute power deviation results computed for each averaging count. This value is expressed as a percentage.

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

Gets the average power computed over each transmit slot in CTE portion of the LE packet. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the CTE transmit slot average power results computed for each averaging count. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power computed over each transmit slot in CTE portion of the LE packet. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the mean of the CTE transmit slot average power results computed for each averaging count. 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_le_cte_transmit_slot_peak_absolute_power_deviation_maximum(selector_string)

Gets the peak absolute power deviation computed over each transmit slot in the CTE portion of the LE packet. The peak absolute power deviation is the deviation of peak power in each transmit slot with respect to the average power in that transmit slot. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the CTE transmit slot absolute power deviation results computed for each averaging count. This value is expressed as a percentage.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak absolute power deviation computed over each transmit slot in the CTE portion of the LE packet. The peak absolute power deviation is the deviation of peak power in each transmit slot with respect to the average power in that transmit slot. This result is applicable only when you set the DIRECTION_FINDING_MODE attribute to Angle of Departure. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the CTE transmit slot absolute power deviation results computed for each averaging count. This value is expressed as a percentage.

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

Gets the peak power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the peak power computation. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the peak power results computed for each averaging count. 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 peak power computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the peak power computation. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the peak power results computed for each averaging count. 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_peak_to_average_power_ratio_maximum(selector_string)

Gets the peak to average power ratio computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the peak to average power ratio computation. For LE-HDT, PAPR is calculated using peak power calculated over active portion of burst and average power calculated from beginning of the payload portion. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the peak to average power ratio results computed for each averaging count. This value is expressed in dB.

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 peak to average power ratio computed over the measurement interval. When you set the AVERAGING_ENABLED attribute to Angle of Departure for LE packets, it will exclude guard period and all the switching slots for the peak to average power ratio computation. For LE-HDT, PAPR is calculated using peak power calculated over active portion of burst and average power calculated from beginning of the payload portion. When you set the AVERAGING_ENABLED attribute to True, it returns the maximum of the peak to average power ratio results computed for each averaging count. 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)