Skip to content

NI RFmx Bluetooth Fetch Results Functions

tdunkle edited this page Feb 22, 2022 · 5 revisions

Fetch Results Functions

Modacc Fetch Results

RFmxBT_ModAccFetchDf1

int32 __stdcall RFmxBT_ModAccFetchDf1 (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* df1avgMaximum, float64* df1avgMinimum);

Purpose

Fetches the ModAcc df1 measurement results. These results are valid only for basic rate (BR) and low energy (LE) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
df1avgMaximum float64* Returns the df1avg value computed on the signal. This value is expressed in Hz. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the maximum of the df1avg results computed for each averaging count.
df1avgMinimum float64* Returns the df1avg value computed on the signal. This value is expressed in Hz. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the minimum of the df1avg results computed for each averaging count.

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_ModAccFetchDf1maxTrace

int32 __stdcall RFmxBT_ModAccFetchDf1maxTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float32 time[], float32 df1max[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the df1max versus the time trace. This function is applicable only for basic rate (BR) and low energy (LE) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
time float32[] Returns the array of time instances at which the df1max values are computed. This value is expressed in seconds.
df1max float32[] Returns the array of df1max values computed over the packet at each time instance. This value is expressed in Hz.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchFrequencyTrace

int32 __stdcall RFmxBT_ModAccFetchFrequencyTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 frequency[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the frequency versus time trace. This trace is valid only for basic rate (BR) and low energy (LE) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start time. This value is expressed in seconds.
dx float64* Returns the sample duration. This value is expressed in seconds.
frequency float32[] Returns the frequency at each time instance. This value is expressed in Hz.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchDf2

int32 __stdcall RFmxBT_ModAccFetchDf2 (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* df2avgMinimum, float64* percentageOfSymbolsAboveDf2maxThreshold);

Purpose

Fetches the ModAcc df2 measurement results. These results are valid only for basic rate (BR) and low energy (LE) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
df2avgMinimum float64* Returns the df2avg value computed on the signal. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the minimum of the df2avg results computed for each averaging count. This value is expressed in Hz.
percentageOfSymbolsAboveDf2maxThreshold float64* Returns the percentage of symbols with df2max values that are greater than the df2max threshold defined by the standard. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it computes this result using the df2max values from all averaging counts. This value is expressed as a percentage.

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_ModAccFetchDf2maxTrace

int32 __stdcall RFmxBT_ModAccFetchDf2maxTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float32 time[], float32 df2max[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the df2max versus the time trace. This function is valid only for basic rate (BR) and low energy (LE) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
time float32[] Returns the array of time instances at which the df2max values are computed. This value is expressed in seconds.
df2max float32[] Returns the array of df2max values computed over the packet at each time instance. This value is expressed in Hz.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchFrequencyErrorBR

int32 __stdcall RFmxBT_ModAccFetchFrequencyErrorBR (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* initialFrequencyErrorMaximum, float64* peakFrequencyDriftMaximum, float64* peakFrequencyDriftRateMaximum);

Purpose

Fetches the ModAcc frequency error trace for basic rate (BR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
initialFrequencyErrorMaximum float64* Returns the initial frequency error value computed on the preamble of the BR packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns a value corresponding to the maximum of absolute initial frequency error values computed for each averaging count. This value is expressed in Hz.
peakFrequencyDriftMaximum float64* Returns the peak frequency drift value computed on the BR packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of absolute peak frequency drift values computed for each averaging count. This value is expressed in Hz.
peakFrequencyDriftRateMaximum float64* Returns the peak frequency drift rate value computed on the BR packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of absolute peak frequency drift rate values computed for each averaging count. This value is expressed in Hz.

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_ModAccFetchFrequencyErrorTraceBR

int32 __stdcall RFmxBT_ModAccFetchFrequencyErrorTraceBR (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float32 time[], float32 frequencyError[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the ModAcc frequency error trace for basic rate (BR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
time float32[] Returns an array of time instances corresponding to the start of the bit blocks at which the frequency error values are computed. This value is expressed in seconds.
frequencyError float32[] Returns an array of frequency errors computed over the packet. This value is expressed in Hz.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchFrequencyErrorEDR

int32 __stdcall RFmxBT_ModAccFetchFrequencyErrorEDR (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* headerFrequencyErrorWiMaximum, float64* peakFrequencyErrorWiPlusW0Maximum, float64* peakFrequencyErrorW0Maximum);

Purpose

Fetches ModAcc frequency error measurement results for enhanced data rate (EDR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
headerFrequencyErrorWiMaximum float64* Returns the frequency error value computed on the header of the EDR packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of absolute header frequency error values computed for each averaging count. This value is expressed in Hz.
peakFrequencyErrorWiPlusW0Maximum float64* Returns the peak frequency error value computed on the EDR portion of the EDR packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of the absolute peak frequency error values computed for each averaging count. This value is expressed in Hz.
peakFrequencyErrorW0Maximum float64* Returns the peak frequency error value computed on the EDR portion of the EDR packet, relative to the header frequency error. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of absolute peak frequency error values computed for each averaging count. This value is expressed in Hz.

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_ModAccFetchFrequencyErrorWiPlusW0TraceEDR

int32 __stdcall RFmxBT_ModAccFetchFrequencyErrorWiPlusW0TraceEDR (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float32 time[], float32 frequencyErrorWiPlusW0[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the ModAcc frequency error trace for enhanced data rate (EDR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
time float32[] Returns an array of time instances corresponding to the start of the 50us blocks of the EDR portion of EDR packet at which the frequency error values are computed. This value is expressed in seconds.
frequencyErrorWiPlusW0 float32[] Returns an array of frequency errors wi+w0 computed over the packet. This value is expressed in Hz.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchFrequencyErrorLE

int32 __stdcall RFmxBT_ModAccFetchFrequencyErrorLE (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* peakFrequencyErrorMaximum, float64* initialFrequencyDriftMaximum, float64* peakFrequencyDriftMaximum, float64* peakFrequencyDriftRateMaximum);

Purpose

Fetches ModAcc frequency error measurement results for low energy (LE) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
peakFrequencyErrorMaximum float64* When you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, , it returns the value corresponding to the maximum of absolute peak frequency error values computed for each averaging count. This value is expressed in Hz.
initialFrequencyDriftMaximum float64* Returns the initial frequency drift value computed on the LE packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of absolute initial frequency drift values computed for each averaging count. This value is expressed in Hz.
peakFrequencyDriftMaximum float64* Returns the peak frequency drift value computed on the LE packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of absolute peak frequency drift values computed for each averaging count. This value is expressed in Hz.
peakFrequencyDriftRateMaximum float64* Returns the peak frequency drift rate value computed on the LE packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the value corresponding to the maximum of absolute peak frequency drift rate values computed for each averaging count. This value is expressed in Hz.

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_ModAccFetchFrequencyErrorTraceLE

int32 __stdcall RFmxBT_ModAccFetchFrequencyErrorTraceLE (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float32 time[], float32 frequencyError[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the ModAcc frequency error trace for low energy (LE) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
time float32[] Returns an array of time instances corresponding to the start of the bit blocks at which the frequency error values are computed. This value is expressed in seconds.
frequencyError float32[] Returns an array of frequency errors computed over the packet. This value is expressed in Hz.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchDEVM

int32 __stdcall RFmxBT_ModAccFetchDEVM (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* peakRMSDEVMMaximum, float64* peakDEVMMaximum, float64* ninetyninePercentDEVM);

Purpose

Fetches ModAcc differential EVM (DEVM) measurement results. These results are valid only for enhanced data rate (EDR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
peakRMSDEVMMaximum float64* Returns the peak of the RMS DEVM values computed on each 50us block of the EDR portion of the EDR packet. When you set RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the maximum of the peak RMS DEVM values computed for each averaging count. This value is expressed in percentage.
peakDEVMMaximum float64* Returns the peak of the DEVM values computed on symbols in the EDR portion of the EDR packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to RFMXBT_VAL_MODACC_AVERAGING_ENABLED_TRUE, it returns the maximum of the peak symbol DEVM values computed for each averaging count. This value is expressed in percentage.
ninetyninePercentDEVM float64* Returns the 99th percentile of the DEVM values computed on symbols of the EDR portion of all measured EDR packets. This value is expressed in percentage.

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_ModAccFetchRMSDEVMTrace

int32 __stdcall RFmxBT_ModAccFetchRMSDEVMTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float32 RMSDEVM[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the RMS DEVM values from each 50us block of EDR portion of EDR packet. This function is valid only for enhanced data rate (EDR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
RMSDEVM float32[] Returns the array of RMS DEVM values computed on each 50us block of the EDR portion of the EDR packet. This value is expressed in percentage.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchDEVMPerSymbolTrace

int32 __stdcall RFmxBT_ModAccFetchDEVMPerSymbolTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float32 DEVMPerSymbol[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the DEVM values for symbols from the enhanced data rate (EDR) portion of the EDR packet. This function is valid only for EDR packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
DEVMPerSymbol float32[] Returns the array of DEVM values computed over the symbols in the EDR portion of EDR packet. This value is expressed in percentage.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchDemodulatedBitTrace

int32 __stdcall RFmxBT_ModAccFetchDemodulatedBitTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int8 demodulatedBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the ModAcc demodulated bit trace.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
demodulatedBits int8[] Returns the array of demodulated bits of the packet
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchConstellationTrace

int32 __stdcall RFmxBT_ModAccFetchConstellationTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, NIComplexSingle constellation[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the demodulated symbols from the enhanced data rate (EDR) portion of the EDR packet. This function is valid only for EDR packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
constellation NIComplexSingle[] Returns the array of demodulated symbols from over the EDR portion of the EDR packet.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ModAccFetchDEVMMagnitudeError

int32 __stdcall RFmxBT_ModAccFetchDEVMMagnitudeError (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* averageRMSMagnitudeErrorMean, float64* peakRMSMagnitudeErrorMaximum);

Purpose

Fetches ModAcc RMS magnitude error results. These results are valid only for enhanced data rate (EDR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
averageRMSMagnitudeErrorMean float64* Returns the average of the RMS magnitude error values computed on each 50 us block of EDR portion of the EDR packet. When you set the ModAcc Averaging Enabled attribute to true, it returns the mean of the average RMS magnitude error values computed for each averaging count. This value is expressed as a percentage.
peakRMSMagnitudeErrorMaximum float64* Returns the peak of the RMS magnitude error values computed on each 50 us block of EDR portion of the EDR packet. When you set the ModAcc Averaging Enabled attribute to true, it returns the maximum of the peak RMS magnitude error values computed for each averaging count. This value is expressed as a percentage.

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_ModAccFetchDEVMPhaseError

int32 __stdcall RFmxBT_ModAccFetchDEVMPhaseError (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* averageRMSPhaseErrorMean, float64* peakRMSPhaseErrorMaximum);

Purpose

Fetches ModAcc RMS phase error results. These results are valid only for enhanced data rate (EDR) packets.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
averageRMSPhaseErrorMean float64* Returns the average of the RMS phase error values computed on each 50 us block of EDR portion of the EDR packet. When you set the ModAcc Averaging Enabled attribute to true, it returns the mean of the average RMS phase error values computed for each averaging count. This value is expressed in degrees.
peakRMSPhaseErrorMaximum float64* Returns the peak of the RMS phase error values computed on each 50 us block of EDR portion of the EDR packet. When you set the ModAcc Averaging Enabled attribute to true, it returns the maximum of the peak RMS phase error values computed for each averaging count. This value is expressed in degrees.

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 Fetch Results

RFmxBT_ACPFetchMeasurementStatus

int32 __stdcall RFmxBT_ACPFetchMeasurementStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus);

Purpose

Fetches the overall ACP measurement status based on the measurement limits as defined by the standard if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND. This function is not valid if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
measurementStatus int32* Returns 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. Refer to RFMXBT_ATTR_ACP_RESULTS_MEASUREMENT_STATUS attribute for more information about measurement status.

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_ACPFetchReferenceChannelPower

int32 __stdcall RFmxBT_ACPFetchReferenceChannelPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* referenceChannelPower);

Purpose

Returns the measured power of the reference channel.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
referenceChannelPower float64* Returns the measured power of the reference channel. This value is expressed in dBm.

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_ACPFetchOffsetMeasurement

int32 __stdcall RFmxBT_ACPFetchOffsetMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* lowerAbsolutePower, float64* upperAbsolutePower, float64* lowerRelativePower, float64* upperRelativePower, float64* lowerMargin, float64* upperMargin);

Purpose

Fetches the absolute powers, relative powers and margins measured in the offset channel. Use "offset<k>" as the selector string to read results from this function.

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, offset number, and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"offset0"
"signal::sig1/offset0"
"signal::sig1/result::r1/offset0"
"result::r1/offset0"
You can use the RFmxBT_BuildOffsetString 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.
Output
Name Type Description
lowerAbsolutePower float64* Returns the absolute power measured in the lower offset channel. This value is expressed in dBm.
upperAbsolutePower float64* Returns the absolute power measured in the upper offset channel. This value is expressed in dBm.
lowerRelativePower float64* Returns the relative power in the lower offset channel measured with respect to the reference channel power. This value is expressed in dB.
upperRelativePower float64* Returns the relative power in the upper offset channel measured with respect to the reference channel power. This value is expressed in dB.
lowerMargin float64* Returns the margin from the limit specified by the mask with exception for lower offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This parameter is valid only if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND. This parameter returns NaN if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.
upperMargin float64* Returns the margin from the limit specified by the mask with exception for upper offsets. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This parameter is valid only if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND. This parameter returns NaN if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.

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_ACPFetchOffsetMeasurementArray

int32 __stdcall RFmxBT_ACPFetchOffsetMeasurementArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 lowerAbsolutePower[], float64 upperAbsolutePower[], float64 lowerRelativePower[], float64 upperRelativePower[], float64 lowerMargin[], float64 upperMargin[], int32 arraySize, int32* actualArraySize);

Purpose

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

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
lowerAbsolutePower float64[] Returns the array of absolute power measured in the lower offset channel. This value is expressed in dBm.
upperAbsolutePower float64[] Returns the array of absolute power measured in the upper offset channel. This value is expressed in dBm.
lowerRelativePower float64[] Returns the array of relative power in the lower offset channel measured with respect to the reference channel power. This value is expressed in dB.
upperRelativePower float64[] Returns array of the relative power in the upper offset channel measured with respect to the reference channel power. This value is expressed in dB.
lowerMargin float64[] Returns the array of margin from the limit specified by the mask with Exception for lower offset channel. This value is expressed in dB. Margin is defined as the difference between the Offset Absolute Power and Mask with Exception. This parameter is valid only if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND. This parameter returns NaN if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.
upperMargin float64[] Returns the array of the margin from the limit specified by the mask with Exception for upper offset channel. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This parameter is valid only if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND. This parameter returns NaN if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_SYMMETRIC.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ACPFetchSpectrum

int32 __stdcall RFmxBT_ACPFetchSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectrum[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the spectrum used for 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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start frequency. This value is expressed in Hz.
dx float64* Returns the frequency bin spacing. This value is expressed in Hz.
spectrum float32[] Returns the averaged power measured at each frequency bin. This value is expressed in dBm.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ACPFetchAbsolutePowerTrace

int32 __stdcall RFmxBT_ACPFetchAbsolutePowerTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 absolutePower[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the absolute power trace for 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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start frequency. This value is expressed in Hz.
dx float64* Returns the frequency bin spacing. This value is expressed in Hz.
absolutePower float32[] Returns the power measured in the carrier and offset channels. This value is expressed in dBm.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_ACPFetchMaskTrace

int32 __stdcall RFmxBT_ACPFetchMaskTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 limitWithExceptionMask[], float32 limitWithoutExceptionMask[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the limit with exception mask and limit without exception mask traces for ACP measurement. This function returns a valid trace only if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to RFMXBT_VAL_ACP_OFFSET_CHANNEL_MODE_INBAND.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start frequency, which is the center frequency of the lowest offset. This value is expressed in Hz.
dx float64* Returns the frequency bin spacing. This value is expressed in Hz.
limitWithExceptionMask float32[] Returns the limit with exception mask used for the measurement. This value is expressed in dBm.
limitWithoutExceptionMask float32[] Returns the limit without exception mask used for the measurement. This value is expressed in dBm.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 Fetch Results

RFmxBT_20dBBandwidthFetchMeasurement

int32 __stdcall RFmxBT_20dBBandwidthFetchMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* peakPower, float64* bandwidth, float64* highFrequency, float64* lowFrequency);

Purpose

Fetches the 20dBBandwidth measurement results.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
peakPower float64* Returns the peak power of the measured spectrum. This value is expressed in dBm.
bandwidth float64* Returns the 20dB bandwidth of the received signal. It is computed as the difference between highFrequency and lowFrequency parameters. This value is expressed in Hz.
highFrequency float64* Returns the highest frequency above the center frequency at which transmit power drops 20 dB below the peak power. This value is expressed in Hz.
lowFrequency float64* Returns the lowest frequency below the center frequency at which transmit power drops 20 dB below the peak power. This value is expressed in Hz.

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_20dBBandwidthFetchSpectrum

int32 __stdcall RFmxBT_20dBBandwidthFetchSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectrum[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the 20dBBandwidth spectrum trace.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start frequency. This value is expressed in Hz.
dx float64* Returns the frequency bin spacing. This value is expressed in Hz.
spectrum float32[] Returns the averaged power measured at each frequency bin. This value is expressed in dBm.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 Fetch Results

RFmxBT_TXPFetchPowers

int32 __stdcall RFmxBT_TXPFetchPowers (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* averagePowerMean, float64* averagePowerMaximum, float64* averagePowerMinimum, float64* peakToAveragePowerRatioMaximum);

Purpose

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

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
averagePowerMean float64* Returns the average power computed over the measurement interval. When you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_TRUE, it returns the mean of the average power results computed for each averaging count. This value is expressed in dBm.
averagePowerMaximum float64* 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.
averagePowerMinimum float64* 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.
peakToAveragePowerRatioMaximum float64* 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.

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_TXPFetchEDRPowers

int32 __stdcall RFmxBT_TXPFetchEDRPowers (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* EDRGFSKAveragePowerMean, float64* EDRDPSKAveragePowerMean, float64* EDR_DPSK_GFSKAveragePowerRatioMean);

Purpose

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

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
EDRGFSKAveragePowerMean float64* 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.
EDRDPSKAveragePowerMean float64* 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.
EDR_DPSK_GFSKAveragePowerRatioMean float64* 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.

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_TXPFetchPowerTrace

int32 __stdcall RFmxBT_TXPFetchPowerTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 power[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the power versus time trace.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start time. This value is expressed in seconds.
dx float64* Returns the sample duration. This value is expressed in seconds.
power float32[] Returns the averaged power at each time instance. This value is expressed in dBm.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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_TXPFetchLECTEReferencePeriodPowers

int32 __stdcall RFmxBT_TXPFetchLECTEReferencePeriodPowers (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* referencePeriodAveragePowerMean, float64* referencePeriodPeakAbsolutePowerDeviationMaximum);

Purpose

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 RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
referencePeriodAveragePowerMean float64* Returns the average power computed over the reference period in the CTE portion of the LE packet. 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.
referencePeriodPeakAbsolutePowerDeviationMaximum float64* 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 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.

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_TXPFetchLECTETransmitSlotPowers

int32 __stdcall RFmxBT_TXPFetchLECTETransmitSlotPowers (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* transmitSlotAveragePowerMean, float64* transmitSlotPeakAbsolutePowerDeviationMaximum);

Purpose

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 RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

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, result name, and slot number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"slot0"
"signal::sig1/slot0"
"signal::sig1/result::r1/slot0"
"result::r1/slot0"
You can use the RFmxBT_BuildSlotString 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.
Output
Name Type Description
transmitSlotAveragePowerMean float64* Returns the average power computed over each transmit slot in CTE portion of the LE packet. 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.
transmitSlotPeakAbsolutePowerDeviationMaximum float64* 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 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.

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_TXPFetchLECTETransmitSlotPowersArray

int32 __stdcall RFmxBT_TXPFetchLECTETransmitSlotPowersArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 transmitSlotAveragePowerMean[], float64 transmitSlotPeakAbsolutePowerDeviationMaximum[], int32 arraySize, int32* actualArraySize);

Purpose

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 RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
transmitSlotAveragePowerMean float64[] Returns an array of average powers computed over every transmit slot in CTE portion of the LE packet. When you set the RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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.
transmitSlotPeakAbsolutePowerDeviationMaximum float64[] 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 RFMXBT_ATTR_TXP_AVERAGING_ENABLED attribute to RFMXBT_VAL_TXP_AVERAGING_ENABLED_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.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 Fetch Results

RFmxBT_FrequencyRangeFetchMeasurement

int32 __stdcall RFmxBT_FrequencyRangeFetchMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* highFrequency, float64* lowFrequency);

Purpose

Fetches the FrequencyRange measurement results.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
Output
Name Type Description
highFrequency float64* Returns the highest frequency above the center frequency at which the transmit power drops below -30 dBm measured in a 100 kHz bandwidth. This value is expressed in Hz.
lowFrequency float64* Returns the lowest frequency below the center frequency at which the transmit power drops below -30 dBm measured in a 100 kHz bandwidth. This value is expressed in Hz.

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_FrequencyRangeFetchSpectrum

int32 __stdcall RFmxBT_FrequencyRangeFetchSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectrum[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the FrequencyRange spectrum trace.

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 and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
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.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start frequency. This value is expressed in Hz.
dx float64* Returns the frequency bin spacing. This value is expressed in Hz.
spectrum float32[] Returns the averaged power measured at each frequency bin. This value is expressed in dBm.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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

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