Skip to content

NI RFmx Bluetooth Configuration Functions

Jump to bottom
tdunkle edited this page Feb 23, 2022 · 17 revisions

Configuration Functions

RFmxBT_CfgRF

int32 __stdcall RFmxBT_CfgRF (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 centerFrequency, float64 referenceLevel, float64 externalAttenuation);

Purpose

Configures the RF attributes of the signal specified by the selector string.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
centerFrequency float64 Specifies the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. The value is expressed in Hz. The default of this attribute is hardware dependent.
referenceLevel float64 Specifies the reference level which represents the maximum expected power of an RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices. The default of this parameter is hardware dependent.
externalAttenuation float64 Specifies the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. The value is expressed in dB.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgFrequency

int32 __stdcall RFmxBT_CfgFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 centerFrequency);

Purpose

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
centerFrequency float64 Specifies the expected carrier frequency of the RF signal that needs to be acquired. This value is expressed in Hz. The signal analyzer tunes to this frequency. The default value of this parameter is hardware dependent. The default value for the devices PXIe-5645/5820 is 0 Hz. The default value for devices PXIe-5644/5646/5840/5663/5663E/5665/5668 is 2.402 GHz.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgReferenceLevel

int32 __stdcall RFmxBT_CfgReferenceLevel (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 referenceLevel);

Purpose

Configures the reference level which represents the maximum expected power of an RF input signal.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
referenceLevel float64 Specifies the reference level which represents the maximum expected power of an RF input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices. The default of this parameter is hardware dependent.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_AutoLevel

int32 __stdcall RFmxBT_AutoLevel (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 measurementInterval, float64* referenceLevel);

Purpose

Examines the input signal to calculate the peak power level and sets it as the value of the RFMXBT_ATTR_REFERENCE_LEVEL attribute. Use this function to help calculate an approximate setting for the reference level. The RFmxBT Auto Level function does the following: When using PXIe 5663, PXIe 5665, or PXIe 5668R device, NI recommends that you set an appropriate value for mechanical attenuation before calling the RFmxNR Auto Level function. Setting an appropriate value for mechanical attenuation reduces the number of times the attenuator settings are changed by this function; thus reducing wear and tear, and maximizing the life time of the attenuator.

  1. Resets the mixer level, mixer level offset and IF output power offset.
  2. Sets the starting reference level to the maximum reference level supported by the device based on the current RF attenuation, mechanical attenuation and preamp enabled settings.
  3. Iterates to adjust the reference level based on the input signal peak power.
  4. Uses immediate triggering and restores the trigger settings back to user setting after completing execution.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
measurementInterval float64 Specifies the acquisition length. Use this value to compute the number of samples to acquire from the signal analyzer. This value is expressed in seconds.
Auto Level function does not use any trigger for acquisition. It ignores the user-configured trigger attributes. NI recommends that you set a sufficiently high measurement interval to ensure that the acquired waveform is at least as long as one period of the signal.
Output
Name Type Description
referenceLevel float64* Returns the estimated peak power level of the input signal. This value is expressed in dBm for RF devices and Vpk-pk for baseband devices.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_AutoDetectSignal

int32 __stdcall RFmxBT_AutoDetectSignal (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout);

Purpose

Detects the Bluetooth packet and returns the detected packet type, data rate, and payload length.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgExternalAttenuation

int32 __stdcall RFmxBT_CfgExternalAttenuation (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 externalAttenuation);

Purpose

Configures the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
externalAttenuation float64 Specifies the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. The value is expressed in dB.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Frequency Range Configure

RFmxBT_FrequencyRangeCfgSpan

int32 __stdcall RFmxBT_FrequencyRangeCfgSpan (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 span);

Purpose

Configures the span for the FrequencyRange measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
span float64 Specifies the span for the FrequencyRange measurement. This value is expressed in Hz. You must adjust the span according the center frequency as specified in section 4.5.4 of the Bluetooth Test Specification v5.1.0. It is recommended to use the span of 6 MHz for a center frequency of 2.402 GHz and 10 MHz for a center frequency of 2.48 GHz.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_FrequencyRangeCfgAveraging

int32 __stdcall RFmxBT_FrequencyRangeCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount);

Purpose

Configures averaging for the FrequencyRange measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
averagingEnabled int32 Specifies whether to enable averaging for the FrequencyRange measurement.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXBT_VAL_FREQUENCY_RANGE_AVERAGING_ENABLED_TRUE.
Possible Values of averagingEnabled:
RFMXBT_VAL_FREQUENCY_RANGE_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXBT_VAL_FREQUENCY_RANGE_AVERAGING_ENABLED_TRUE (1) The measurement uses the averagingCount parameter as the number of acquisitions over which the FrequencyRange measurement is averaged.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Trigger

RFmxBT_DisableTrigger

int32 __stdcall RFmxBT_DisableTrigger (niRFmxInstrHandle instrumentHandle, char selectorString[]);

Purpose

Configures the device to not wait for a trigger to mark a reference point within a record. This function defines the signal triggering as immediate.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgDigitalEdgeTrigger

int32 __stdcall RFmxBT_CfgDigitalEdgeTrigger (niRFmxInstrHandle instrumentHandle, char selectorString[], char digitalEdgeSource[], int32 digitalEdge, float64 triggerDelay, int32 enableTrigger);

Purpose

Configures the device to wait for a digital edge trigger and then marks a reference point within the record.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
digitalEdgeSource char[] Specifies the source terminal for the digital edge trigger. The default of this attribute is hardware dependent.
digitalEdge int32 Specifies the trigger edge to detect.
triggerDelay float64 Specifies the trigger delay time, in seconds.
enableTrigger int32 Specifies whether to enable the trigger.
Possible Values of digitalEdgeSource:
RFMXBT_VAL_PFI0_STR (PFI0) The trigger is received on PFI 0.
RFMXBT_VAL_PFI1_STR (PFI1) The trigger is received on PFI 1.
RFMXBT_VAL_PXI_TRIG0_STR (PXI_Trig0) The trigger is received on PXI trigger line 0.
RFMXBT_VAL_PXI_TRIG1_STR (PXI_Trig1) The trigger is received on PXI trigger line 1.
RFMXBT_VAL_PXI_TRIG2_STR (PXI_Trig2) The trigger is received on PXI trigger line 2.
RFMXBT_VAL_PXI_TRIG3_STR (PXI_Trig3) The trigger is received on PXI trigger line 3.
RFMXBT_VAL_PXI_TRIG4_STR (PXI_Trig4) The trigger is received on PXI trigger line 4.
RFMXBT_VAL_PXI_TRIG5_STR (PXI_Trig5) The trigger is received on PXI trigger line 5.
RFMXBT_VAL_PXI_TRIG6_STR (PXI_Trig6) The trigger is received on PXI trigger line 6.
RFMXBT_VAL_PXI_TRIG7_STR (PXI_Trig7) The trigger is received on PXI trigger line 7.
RFMXBT_VAL_PXI_STAR_STR (PXI_STAR) The trigger is received on the PXI star trigger line.
RFMXBT_VAL_PXIE_DSTARB_STR (PXI_STAR) The trigger is received on the PXIe DStar B trigger line.
RFMXBT_VAL_TIMER_EVENT_STR (PXI_STAR) The trigger is received from the timer event.
Possible Values of digitalEdge:
RFMXBT_VAL_DIGITAL_EDGE_RISING_EDGE (0) The trigger asserts on the rising edge of the signal.
RFMXBT_VAL_DIGITAL_EDGE_FALLING_EDGE (1) The trigger asserts on the falling edge of the signal.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgIQPowerEdgeTrigger

int32 __stdcall RFmxBT_CfgIQPowerEdgeTrigger (niRFmxInstrHandle instrumentHandle, char selectorString[], char IQPowerEdgeSource[], int32 IQPowerEdgeSlope, float64 IQPowerEdgeLevel, float64 triggerDelay, int32 triggerMinQuietTimeMode, float64 triggerMinQuietTimeDuration, int32 IQPowerEdgeLevelType, int32 enableTrigger);

Purpose

Configures the device to wait for the complex power of the I/Q data to cross the specified threshold and then marks a reference point within the record. To trigger on bursty signals, specify a minimum quiet time, which ensures that the trigger does not occur in the middle of the burst signal. The quiet time must be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
IQPowerEdgeSource char[] Specifies the channel from which the device monitors the trigger. The default of this attribute is hardware dependent.
IQPowerEdgeSlope int32 Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify.
IQPowerEdgeLevel float64 Specifies the power level at which the device triggers. This value is expressed in dB when you set the IQPowerEdgeLevelType parameter to RFMXBT_VAL_IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE_RELATIVE; and is expressed in dBm when you set the IQPowerEdgeLevelType parameter to RFMXBT_VAL_IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE_ABSOLUTE. The device asserts the trigger when the signal exceeds the level specified by the value of this parameter, taking into consideration the specified slope. The default of this attribute is hardware dependent.
triggerDelay float64 Specifies the trigger delay time, in seconds.
triggerMinQuietTimeMode int32 Specifies whether the measurement computes the minimum quiet time used for triggering.
triggerMinQuietTimeDuration float64 Specifies the duration, in seconds, for which the signal must be quiet before the signal analyzer arms the I/Q Power Edge trigger. If you set the IQPowerEdgeSlope parameter to RFMXBT_VAL_IQ_POWER_EDGE_RISING_SLOPE, the signal is quiet when it is below the trigger level. If you set the IQPowerEdgeSlope parameter to RFMXBT_VAL_IQ_POWER_EDGE_FALLING_SLOPE, the signal is quiet when it is above the trigger level.
IQPowerEdgeLevelType int32 Specifies the reference for the IQPowerEdgeLevel parameter.
enableTrigger int32 Specifies whether to enable the trigger.
Possible Values of IQPowerEdgeSlope:
RFMXBT_VAL_IQ_POWER_EDGE_RISING_SLOPE (0) The trigger asserts when the signal power is rising.
RFMXBT_VAL_IQ_POWER_EDGE_FALLING_SLOPE (1) The trigger asserts when the signal power is falling.
Possible Values of triggerMinQuietTimeMode:
RFMXBT_VAL_TRIGGER_MINIMUM_QUIET_TIME_MODE_MANUAL (0) The minimum quiet time used for triggering is the value of the triggerMinQuietTimeDuration parameter.
RFMXBT_VAL_TRIGGER_MINIMUM_QUIET_TIME_MODE_AUTO (1) The measurement computes the minimum quiet time used for triggering.
Possible Values of IQPowerEdgeLevelType:
RFMXBT_VAL_IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE_RELATIVE (0) The IQPowerEdgeLevel parameter is relative to the value of the RFMXBT_ATTR_REFERENCE_LEVEL attribute.
RFMXBT_VAL_IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE_ABSOLUTE (1) The IQPowerEdgeLevel parameter specifies the absolute power.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgSoftwareEdgeTrigger

int32 __stdcall RFmxBT_CfgSoftwareEdgeTrigger (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 triggerDelay, int32 enableTrigger);

Purpose

Configures the device to wait for a software trigger and then marks a reference point within the record.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
triggerDelay float64 Specifies the trigger delay time, in seconds.
enableTrigger int32 Specifies whether to enable the trigger.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_SendSoftwareEdgeTrigger

int32 __stdcall RFmxBT_SendSoftwareEdgeTrigger (niRFmxInstrHandle instrumentHandle);

Purpose

Sends a trigger to the device when you use the RFmxBT_SendSoftwareEdgeTrigger function to choose a software version of a trigger and the device is waiting for the trigger to be sent. You can also use this function to override a hardware trigger. This function returns an error in the following situations:

  • You configure an invalid trigger.
  • You have not previously called the RFmxBT_Initiate function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgPacketType

int32 __stdcall RFmxBT_CfgPacketType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 packetType);

Purpose

Configures the type of Bluetooth packet to be measured.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
packetType int32 Specifies the type of Bluetooth packet to be measured. In this document, packet type is sometimes referred to by the Bluetooth physical layer (PHY) it belongs to. Supported Bluetooth physical layers are basic rate (BR), enhanced data rate (EDR) and low energy (LE).
Possible Values of packetType:
RFMXBT_VAL_PACKET_TYPE_DH1 (0) Specifies that the packet type is DH1. The packet belongs to BR PHY. Refer to sections 6.5.1.5 and 6.5.4.2, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_DH3 (1) Specifies that the packet type is DH3. The packet belongs to BR PHY. Refer to section 6.5.4.4, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_DH5 (2) Specifies that the packet type is DH5. The packet belongs to BR PHY. Refer to section 6.5.4.6, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_DM1 (3) Specifies that the packet type is DM1. The packet belongs to BR PHY. Refer to sections 6.5.1.5 and 6.5.4.1, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_DM3 (4) Specifies that the packet type is DM3. The packet belongs to BR PHY. Refer to section 6.5.4.3, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_DM5 (5) Specifies that the packet type is DM5. The packet belongs to BR PHY. Refer to section 6.5.4.5, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_2_DH1 (6) Specifies that the packet type is 2-DH1. The packet belongs to EDR PHY. Refer to section 6.5.4.8, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_2_DH3 (7) Specifies that the packet type is 2-DH3. The packet belongs to EDR PHY. Refer to section 6.5.4.9, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_2_DH5 (8) Specifies that the packet type is 2-DH5. The packet belongs to EDR PHY. Refer to section 6.5.4.10, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_3_DH1 (9) Specifies that the packet type is 3-DH1. The packet belongs to EDR PHY. Refer to section 6.5.4.11, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_3_DH3 (10) Specifies that the packet type is 3-DH3. The packet belongs to EDR PHY. Refer to section 6.5.4.12, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_3_DH5 (11) Specifies that the packet type is 3-DH5. The packet belongs to EDR PHY. Refer to section 6.5.4.13, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_2_EV3 (12) Specifies that the packet type is 2-EV3. The packet belongs to EDR PHY. Refer to section 6.5.3.4, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_2_EV5 (13) Specifies that the packet type is 2-EV5. The packet belongs to EDR PHY. Refer to section 6.5.3.5, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_3_EV3 (14) Specifies that the packet type is 3-EV3. The packet belongs to EDR PHY. Refer to section 6.5.3.6, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_3_EV5 (15) Specifies that the packet type is 3-EV5. The packet belongs to EDR PHY. Refer to section 6.5.3.7, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet.
RFMXBT_VAL_PACKET_TYPE_LE (16) Specifies that the packet belongs to LE PHY. Refer to sections 2.1 and 2.2, Part B, Volume 6 of the Bluetooth Core Specification v5.1 for more information about this packet.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgDataRate

int32 __stdcall RFmxBT_CfgDataRate (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 dataRate);

Purpose

Configures the data rate of the low energy (LE) packet to be measured.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
dataRate int32 Specifies the data rate of the LE packet transmitted by the device under test (DUT). This value is expressed in bps. This parameter is applicable only to the LE packet type.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgPayloadBitPattern

int32 __stdcall RFmxBT_CfgPayloadBitPattern (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 payloadBitPattern);

Purpose

Configures the bit pattern present in the payload of the packet.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
payloadBitPattern int32 Specifies the bit pattern present in the payload of the packet. This value is used to determine the set of ModAcc measurements to be performed.
Possible Values of payloadBitPattern:
RFMXBT_VAL_PAYLOAD_BIT_PATTERN_STANDARD_DEFINED (0) Specifies that the payload bit pattern is standardDefined.
RFMXBT_VAL_PAYLOAD_BIT_PATTERN_11110000 (1) Specifies that the payload bit pattern is 11110000.
RFMXBT_VAL_PAYLOAD_BIT_PATTERN_10101010 (2) Specifies that the payload bit pattern is 10101010.

The following table shows the measurements applicable for different payload bit patterns:

Bluetooth PHY Data Rate Standard 11110000 10101010
BR NA Error df1 df2 and BR frequency error
EDR NA DEVM (The measurement considers PN9 as payload pattern) Error Error
LE 1 Mbps Error df1 and LE frequency errors on the constant tone extension (CTE) field within the direction finding packets. df2 and LE frequency error
LE 2 Mbps Error df1 and LE frequency errors on the constant tone extension (CTE) field within the direction finding packets. df2 and LE frequency error
LE 125 kbps df1 and LE frequency errors (The measurement considers 11111111 as payload pattern) Error Error

Note: ModAcc measurement cannot be enabled for LE 500 kbps packets. The default value is Standard Defined.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgPayloadLength

int32 __stdcall RFmxBT_CfgPayloadLength (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 payloadLengthMode, int32 payloadLength);

Purpose

Configures the payloadLengthMode and RFMXBT_VAL_PAYLOAD_LENGTH_MODE_AUTO parameters that decide the length of the payload to be used for the measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
payloadLengthMode int32 Specifies the payload length mode of the signal to be measured. The payloadLengthMode and RFMXBT_VAL_PAYLOAD_LENGTH_MODE_AUTO parameters decide the length of the payload to be used for measurement.
payloadLength int32 Specifies the payload length of the signal in bytes. The parameter is applicable only when you set the payloadLengthMode parameter to RFMXBT_VAL_PAYLOAD_LENGTH_MODE_MANUAL. This parameter returns the payload length used for measurement if you set the Payload Length Mode parameter to RFMXBT_VAL_PAYLOAD_LENGTH_MODE_AUTO.
Possible Values of payloadLengthMode:
RFMXBT_VAL_PAYLOAD_LENGTH_MODE_MANUAL (0) Enables the value specified by the payloadLength parameter. The acquisition and measurement durations will be decided based on this value.
RFMXBT_VAL_PAYLOAD_LENGTH_MODE_AUTO (1) Enables the standard defined maximum payload length for the selected packet type. If this parameter is set to Auto, the maximum standard defined payload length for the selected packet type is chosen. For LE, the maximum payload length that a device under test(DUT) can generate varies from 37 to 255 bytes. When you set the payload length mode for the LE packet type to auto, RFmx chooses 37 bytes as the payload length.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgChannelNumber

int32 __stdcall RFmxBT_CfgChannelNumber (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 channelNumber);

Purpose

Configures the RF channel number of the signal generated by the device under test (DUT), as defined in the Bluetooth specification.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
channelNumber int32 Specifies the RF channel number of the signal generated by the device under test (DUT), as defined in the Bluetooth specification. This parameter is applicable when you enable the ACP measurement and when you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgLEDirectionFinding

int32 __stdcall RFmxBT_CfgLEDirectionFinding (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 directionFindingMode, float64 CTELength, float64 CTESlotDuration);

Purpose

Configures the mode of direction finding, length of the constant tone extension field, and the duration of the switching slot in the generated signal.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
directionFindingMode int32 Specifies the mode of direction finding. The default value is RFMXBT_VAL_DIRECTION_FINDING_MODE_DISABLED.
CTELength float64 Specifies the length of the constant tone extension (CTE) field in the generated signal. This value is expressed in seconds. This parameter is applicable only when you set the Direction Finding Mode parameter to either RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. The default value is 160 microseconds.
CTESlotDuration float64 Specifies the length of the switching slots and transmit slots in the constant tone extension field in the generated signal.
Possible Values of directionFindingMode:
RFMXBT_VAL_DIRECTION_FINDING_MODE_DISABLED (0) Specifies that the LE packet does not have fields required for direction finding.
RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL (1) Specifies the LE packets uses the angle of arrival method of direction finding.
RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE (2) Specifies the LE packet uses angle of departure method of direction finding.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_CfgFrequencyChannelNumber

int32 __stdcall RFmxBT_CfgFrequencyChannelNumber (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 standard, int32 channelNumber);

Purpose

Configures the expected carrier frequency of the RF signal to be acquired using channelNumber and standard parameters.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
standard int32 Specifies the signal to which the Bluetooth physical layer belongs.
channelNumber int32 Specifies the RF channel number of the signal generated by the device under test (DUT), as defined in the Bluetooth specification. This parameter is applicable when you enable the ACP measurement and when you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Modacc Configure

RFmxBT_ModAccCfgAveraging

int32 __stdcall RFmxBT_ModAccCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount);

Purpose

Configures averaging for the ModAcc measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
averagingEnabled int32 Specifies whether to enable averaging for the ModAcc measurement.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE.
Possible Values of averagingEnabled:
RFMXBT_VAL_MODACC_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE (1) The measurement uses the averagingCount parameter as the number of acquisitions over which the ModAcc measurement is averaged.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_ModAccCfgBurstSynchronizationType

int32 __stdcall RFmxBT_ModAccCfgBurstSynchronizationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 burstSynchronizationType);

Purpose

Configures the burst synchronization type for ModAcc measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
burstSynchronizationType int32 Specifies the type of synchronization used for detecting the start of packet in the measurement.
Possible Values of burstSynchronizationType:
RFMXBT_VAL_MODACC_BURST_SYNCHRONIZATION_TYPE_NONE (0) Specifies that the measurement does not perform synchronization to detect the start of the packet.
RFMXBT_VAL_MODACC_BURST_SYNCHRONIZATION_TYPE_PREAMBLE (1) Specifies that the measurement uses the preamble field to detect the start of the EDR packet.
RFMXBT_VAL_MODACC_BURST_SYNCHRONIZATION_TYPE_SYNC_WORD (2) Specifies that the measurement uses sync word for the BR/EDR packets and access address for the 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.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

ACP Configure

RFmxBT_ACPCfgAveraging

int32 __stdcall RFmxBT_ACPCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount);

Purpose

Configures averaging for the adjacent channel power (ACP) measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
averagingEnabled int32 Specifies whether to enable averaging for the ACP measurement.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXBT_VAL_ACP_AVERAGING_ENABLED_TRUE.
Possible Values of averagingEnabled:
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 averagingCount parameter as the number of acquisitions over which the ACP measurement is averaged.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_ACPCfgBurstSynchronizationType

int32 __stdcall RFmxBT_ACPCfgBurstSynchronizationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 burstSynchronizationType);

Purpose

Configures the type of synchronization used for detecting the start of the packet in the adjacent channel power (ACP) measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
burstSynchronizationType int32 Specifies the type of synchronization used for detecting the start of packet in the measurement.
Possible Values of burstSynchronizationType:
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 to detect the start of the EDR packet.
RFMXBT_VAL_ACP_BURST_SYNCHRONIZATION_TYPE_SYNC_WORD (2) Specifies that the measurement uses sync word for the BR/EDR packets and access address for the 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.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_ACPCfgOffsetChannelMode

int32 __stdcall RFmxBT_ACPCfgOffsetChannelMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 offsetChannelMode);

Purpose

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

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
offsetChannelMode int32 Specifies which offset channels are used for the measurement.
Possible Values of offsetChannelMode:
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 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.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_ACPCfgNumberOfOffsets

int32 __stdcall RFmxBT_ACPCfgNumberOfOffsets (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfOffsets);

Purpose

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

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
numberOfOffsets int32 Specifies the number of offset channels used on either side of the reference channel for the ACP measurement when you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC. This parameter 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.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Twenty dB Bandwidth Configure

RFmxBT_20dBBandwidthCfgAveraging

int32 __stdcall RFmxBT_20dBBandwidthCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount);

Purpose

Configures averaging for the 20dBBandwidth measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
averagingEnabled int32 Specifies whether to enable averaging for 20dBBandwidth measurement.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXBT_VAL_20DB_BANDWIDTH_AVERAGING_ENABLED_TRUE.
Possible Values of averagingEnabled:
RFMXBT_VAL_20DB_BANDWIDTH_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXBT_VAL_20DB_BANDWIDTH_AVERAGING_ENABLED_TRUE (1) The measurement uses the averagingCount parameter as the number of acquisitions over which the 20dBBandwidth measurement is averaged.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

TXP Configure

RFmxBT_TXPCfgAveraging

int32 __stdcall RFmxBT_TXPCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount);

Purpose

Configures averaging for the transmit power (TXP) measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
averagingEnabled int32 Specifies whether to enable averaging for the TXP measurement.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXBT_VAL_TXP_AVERAGING_ENABLED_TRUE.
Possible Values of averagingEnabled:
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 averagingCount parameter as the number of acquisitions over which the TXP measurement is averaged.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxBT_TXPCfgBurstSynchronizationType

int32 __stdcall RFmxBT_TXPCfgBurstSynchronizationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 burstSynchronizationType);

Purpose

Configures the type of synchronization used for detecting the start of the packet in the transmit power (TXP) measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
burstSynchronizationType int32 Specifies the type of synchronization used for detecting the start of packet in the measurement.
Possible Values of burstSynchronizationType:
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 EDR 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 the 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.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxBT_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Table of Contents

Home

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally