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

ACP Attributes

RFMXBT_ATTR_ACP_MEASUREMENT_ENABLED

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

The default value is RFMXBT_VAL_FALSE.

Get Function: RFmxBT_ACPGetMeasurementEnabled
Set Function: RFmxBT_ACPSetMeasurementEnabled

RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE

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

The default value is RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.

Get Function: RFmxBT_ACPGetOffsetChannelMode
Set Function: RFmxBT_ACPSetOffsetChannelMode
Values:
RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_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 RFMXBT_ATTR_ACP_NUMBER_OF_OFFSETS attribute. In symmetric mode, the RFMX_ATTR_CENTER_FREQUENCY attribute specifies the frequency of the reference channel, expressed in Hz.
RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND (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 RFMX_ATTR_CENTER_FREQUENCY attribute specifies the frequency of acquisition which must be equal to 2.441GHz. Configure the RFMXBT_ATTR_CHANNEL_NUMBER attribute to specify the frequency of the reference channel.

RFMXBT_ATTR_ACP_NUMBER_OF_OFFSETS

Data Type: int32
Access: read/write
Functions: RFmxBT_SetAttributeI32
RFmxBT_GetAttributeI32
Description: 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 RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC. This attribute also returns the actual number of offsets used in the ACP measurement when you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND.

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

Get Function: RFmxBT_ACPGetNumberOfOffsets
Set Function: RFmxBT_ACPSetNumberOfOffsets

RFMXBT_ATTR_ACP_OFFSET_FREQUENCY

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns 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.

Get Function: RFmxBT_ACPGetOffsetFrequency

RFMXBT_ATTR_ACP_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 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 Strings topic for information about the string syntax for named signals.

The default value is RFMXBT_VAL_ACP_BURST_SYNCHRONIZATION_TYPE_PREAMBLE.

Get Function: RFmxBT_ACPGetBurstSynchronizationType
Set Function: RFmxBT_ACPSetBurstSynchronizationType
Values:
RFMXBT_VAL_ACP_BURST_SYNCHRONIZATION_TYPE_NONE (0) Specifies that the measurement does not perform synchronization to detect the start of the packet.
RFMXBT_VAL_ACP_BURST_SYNCHRONIZATION_TYPE_PREAMBLE (1) Specifies that the measurement uses the preamble field bits to detect the start of the EDR packet.
RFMXBT_VAL_ACP_BURST_SYNCHRONIZATION_TYPE_SYNC_WORD (2) Specifies that the measurement uses the sync word to detect the start of the EDR packet. For EDR packets, the sync word is derived from the RFMXBT_ATTR_BD_ADDRESS_LAP attribute.

ACP Averaging

RFMXBT_ATTR_ACP_AVERAGING_ENABLED

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

The default value is RFMXBT_VAL_ACP_AVERAGING_ENABLED_FALSE.

Get Function: RFmxBT_ACPGetAveragingEnabled
Set Function: RFmxBT_ACPSetAveragingEnabled
Values:
RFMXBT_VAL_ACP_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXBT_VAL_ACP_AVERAGING_ENABLED_TRUE (1) The measurement uses the RFMXBT_ATTR_ACP_AVERAGING_COUNT attribute as the number of acquisitions over which the ACP measurement is averaged.

RFMXBT_ATTR_ACP_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_ACP_AVERAGING_ENABLED attribute to RFMXBT_VAL_ACP_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_ACPGetAveragingCount
Set Function: RFmxBT_ACPSetAveragingCount

RFMXBT_ATTR_ACP_ALL_TRACES_ENABLED

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

The default value is RFMXBT_VAL_FALSE.

Get Function: RFmxBT_ACPGetAllTracesEnabled
Set Function: RFmxBT_ACPSetAllTracesEnabled

RFMXBT_ATTR_ACP_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 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 Strings topic for information about the string syntax for named signals.

The default value is 1.

Get Function: RFmxBT_ACPGetNumberOfAnalysisThreads
Set Function: RFmxBT_ACPSetNumberOfAnalysisThreads

ACP Results

RFMXBT_ATTR_ACP_RESULTS_MEASUREMENT_STATUS

Data Type: int32
Access: read only
Functions: RFmxBT_GetAttributeI32
Description: Indicates the overall measurement status based on the measurement limits specified by the standard when you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND.

The standard defines two masks, mask with exception and mask without exception. Mask with exception is more stringent than mask without exception. Refer to the ACP Results Meas Status property for more details about the exception limits.


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_ACPGetResultsMeasurementStatus
Values:
RFMXBT_VAL_ACP_RESULTS_MEASUREMENT_STATUS_NOT_APPLICABLE (-1) This attribute returns Not Applicable when you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.
RFMXBT_VAL_ACP_RESULTS_MEASUREMENT_STATUS_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.
RFMXBT_VAL_ACP_RESULTS_MEASUREMENT_STATUS_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.

RFMXBT_ATTR_ACP_RESULTS_REFERENCE_CHANNEL_POWER

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

Get Function: RFmxBT_ACPGetResultsReferenceChannelPower

Lower Offset

RFMXBT_ATTR_ACP_RESULTS_LOWER_OFFSET_ABSOLUTE_POWER

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns 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.

Get Function: RFmxBT_ACPGetResultsLowerOffsetAbsolutePower

RFMXBT_ATTR_ACP_RESULTS_LOWER_OFFSET_RELATIVE_POWER

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns 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.

Get Function: RFmxBT_ACPGetResultsLowerOffsetRelativePower

RFMXBT_ATTR_ACP_RESULTS_LOWER_OFFSET_MARGIN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: 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 RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND. This attribute returns NaN if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.

Use 'offset(k)' as the selector string to read this result.

Get Function: RFmxBT_ACPGetResultsLowerOffsetMargin

Upper Offset

RFMXBT_ATTR_ACP_RESULTS_UPPER_OFFSET_ABSOLUTE_POWER

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns 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.

Get Function: RFmxBT_ACPGetResultsUpperOffsetAbsolutePower

RFMXBT_ATTR_ACP_RESULTS_UPPER_OFFSET_RELATIVE_POWER

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: Returns 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.

Get Function: RFmxBT_ACPGetResultsUpperOffsetRelativePower

RFMXBT_ATTR_ACP_RESULTS_UPPER_OFFSET_MARGIN

Data Type: float64
Access: read only
Functions: RFmxBT_GetAttributeF64
Description: 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 RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND. This attribute returns NaN if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.

Use 'offset(k)' as the selector string to read this result.

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