Skip to content

NI RFmx Bluetooth Utility Functions

Jump to bottom
tdunkle edited this page Feb 22, 2022 · 3 revisions

Utility Functions

RFmxBT_Commit

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

Purpose

Commits settings to the hardware. Calling this function is optional. RFmxBT commits settings to the hardware when you call the RFmxBT_Initiate function or any of the measurement Read functions.

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_ResetToDefault

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

Purpose

Resets a signal to the default values.

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_WaitForAcquisitionComplete

int32 __stdcall RFmxBT_WaitForAcquisitionComplete (niRFmxInstrHandle instrumentHandle, float64 timeout);

Purpose

Waits and blocks the data flow until the acquisition is complete. This function is typically called after a specific initiate function.

This function is a wrapper over the NI-RFmx Instruments API, and calls the RFmxInstr_WaitForAcquisitionComplete function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
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_WaitForMeasurementComplete

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

Purpose

Waits for the specified number for seconds for all the measurements to complete.

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.

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_CheckMeasurementStatus

int32 __stdcall RFmxBT_CheckMeasurementStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], int32* isDone);

Purpose

Checks the status of the measurement. Use this function to check for any errors that may occur during measurement or to check whether the measurement is complete and results are available.

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.
Output
Name Type Description
isDone int32* Indicates whether 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

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