NI RFmx Bluetooth TXP Attributes - ni/grpc-device GitHub Wiki

TXP Attributes

RFMXBT_ATTR_TXP_MEASUREMENT_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxBT_SetAttributeI32
RFmxBT_GetAttributeI32
Description: Specifies whether to enable the transmit power (TxP) 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 Strings topic for information about the string syntax for named signals.

The default value is RFMXBT_VAL_FALSE.

Get Function: RFmxBT_TXPGetMeasurementEnabled
Set Function: RFmxBT_TXPSetMeasurementEnabled

RFMXBT_ATTR_TXP_BURST_SYNCHRONIZATION_TYPE

Data Type: int32
Access: read/write
Functions: RFmxBT_SetAttributeI32
RFmxBT_GetAttributeI32
Description: Specifies the type of synchronization used for detecting the start of packet in the transmit power (TXP) 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 Strings topic for information about the string syntax for named signals.

The default value is RFMXBT_VAL_TXP_BURST_SYNCHRONIZATION_TYPE_PREAMBLE.

Get Function: RFmxBT_TXPGetBurstSynchronizationType
Set Function: RFmxBT_TXPSetBurstSynchronizationType
Values:
RFMXBT_VAL_TXP_BURST_SYNCHRONIZATION_TYPE_NONE (0) Specifies that the measurement does not perform synchronization to detect the start of the packet.
RFMXBT_VAL_TXP_BURST_SYNCHRONIZATION_TYPE_PREAMBLE (1) Specifies that the measurement uses the preamble field to detect the start of the packet.
RFMXBT_VAL_TXP_BURST_SYNCHRONIZATION_TYPE_SYNC_WORD (2) Specifies that the measurement uses sync word for the BR/EDR packets and access address for LE packets to detect the start of the packet. For BR /EDR packets, the sync word is derived from the RFMXBT_ATTR_BD_ADDRESS_LAP attribute.

TXP Averaging

RFMXBT_ATTR_TXP_AVERAGING_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxBT_SetAttributeI32
RFmxBT_GetAttributeI32
Description: Specifies whether to enable averaging for the transmit power (TxP) 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 Strings topic for information about the string syntax for named signals.

The default value is RFMXBT_VAL_TXP_AVERAGING_ENABLED_FALSE.

Get Function: RFmxBT_TXPGetAveragingEnabled
Set Function: RFmxBT_TXPSetAveragingEnabled
Values:
RFMXBT_VAL_TXP_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXBT_VAL_TXP_AVERAGING_ENABLED_TRUE (1) The measurement uses the RFMXBT_ATTR_TXP_AVERAGING_COUNT attribute as the number of acquisitions over which the TXP measurement is averaged.

RFMXBT_ATTR_TXP_AVERAGING_COUNT

Data Type: int32
Access: read/write
Functions: RFmxBT_SetAttributeI32
RFmxBT_GetAttributeI32
Description: Specifies the number of acquisitions used for averaging when you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals.

The default value is 10.

Get Function: RFmxBT_TXPGetAveragingCount
Set Function: RFmxBT_TXPSetAveragingCount

RFMXBT_ATTR_TXP_ALL_TRACES_ENABLED

Data Type: int32
Access: read/write
Functions: RFmxBT_SetAttributeI32
RFmxBT_GetAttributeI32
Description: Specifies whether to enable all the traces used for transmit power (TxP) 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 Strings topic for information about the string syntax for named signals.

The default value is RFMXBT_VAL_FALSE.

Get Function: RFmxBT_TXPGetAllTracesEnabled
Set Function: RFmxBT_TXPSetAllTracesEnabled

RFMXBT_ATTR_TXP_NUMBER_OF_ANALYSIS_THREADS

Data Type: int32
Access: read/write
Functions: RFmxBT_SetAttributeI32
RFmxBT_GetAttributeI32
Description: Specifies the maximum number of threads used for parallelism for TXP 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 Strings topic for information about the string syntax for named signals.

The default value is 1.

Get Function: RFmxBT_TXPGetNumberOfAnalysisThreads
Set Function: RFmxBT_TXPSetNumberOfAnalysisThreads

TXP Results

RFMXBT_ATTR_TXP_RESULTS_AVERAGE_POWER_MEAN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns the average power computed over the measurement interval. When you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE for LE packets, it will exclude guard period and all the switching slots for the average power computation. This value is expressed in dBm. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsAveragePowerMean

RFMXBT_ATTR_TXP_RESULTS_AVERAGE_POWER_MAXIMUM

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns the average power computed over the measurement interval. When you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE for LE packets, it will exclude guard period and all the switching slots for the average power computation. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsAveragePowerMaximum

RFMXBT_ATTR_TXP_RESULTS_AVERAGE_POWER_MINIMUM

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns the average power computed over the measurement interval. When you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE for LE packets, it will exclude guard period and all the switching slots for the average power computation. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsAveragePowerMinimum

RFMXBT_ATTR_TXP_RESULTS_PEAK_POWER_MAXIMUM

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns the peak power computed over the measurement interval. When you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_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 RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsPeakPowerMaximum

RFMXBT_ATTR_TXP_RESULTS_PEAK_TO_AVERAGE_POWER_RATIO_MAXIMUM

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns the peak to average power ratio computed over the measurement interval. When you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE for LE packets, it will exclude guard period and all the switching slots for the peak to average power ratio computation. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsPeakToAveragePowerRatioMaximum

RFMXBT_ATTR_TXP_RESULTS_EDR_GFSK_AVERAGE_POWER_MEAN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns the average power of the GFSK portion of the EDR packet. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsEDRGFSKAveragePowerMean

RFMXBT_ATTR_TXP_RESULTS_EDR_DPSK_AVERAGE_POWER_MEAN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns the average power of the DPSK portion of the EDR packet. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsEDRDPSKAveragePowerMean

RFMXBT_ATTR_TXP_RESULTS_EDR_DPSK_GFSK_AVERAGE_POWER_RATIO_MEAN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: 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 RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsEDR_DPSK_GFSKAveragePowerRatioMean

RFMXBT_ATTR_TXP_RESULTS_LE_CTE_REFERENCE_PERIOD_AVERAGE_POWER_MEAN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: 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 RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsLECTEReferencePeriodAveragePowerMean

RFMXBT_ATTR_TXP_RESULTS_LE_CTE_REFERENCE_PERIOD_PEAK_ABSOLUTE_POWER_DEVIATION_MAXIMUM

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: 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 RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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 Strings topic for information about the string syntax for named signals and results.

Get Function: RFmxBT_TXPGetResultsLECTEReferencePeriodPeakAbsolutePowerDeviationMaximum

RFMXBT_ATTR_TXP_RESULTS_LE_CTE_TRANSMIT_SLOT_AVERAGE_POWER_MEAN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: 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 RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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.

Get Function: RFmxBT_TXPGetResultsLECTETransmitSlotAveragePowerMean

RFMXBT_ATTR_TXP_RESULTS_LE_CTE_TRANSMIT_SLOT_PEAK_ABSOLUTE_POWER_DEVIATION_MAXIMUM

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: 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 RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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.

Get Function: RFmxBT_TXPGetResultsLECTETransmitSlotPeakAbsolutePowerDeviationMaximum
⚠️ **GitHub.com Fallback** ⚠️