NI RFmx Bluetooth Utility Functions - ni/grpc-device GitHub Wiki
- RFmxBT_Commit
- RFmxBT_ResetToDefault
- RFmxBT_WaitForAcquisitionComplete
- RFmxBT_WaitForMeasurementComplete
- RFmxBT_CheckMeasurementStatus
int32 __stdcall RFmxBT_Commit (niRFmxInstrHandle instrumentHandle, char selectorString[]);
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.
| 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. |
| 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 |
int32 __stdcall RFmxBT_ResetToDefault (niRFmxInstrHandle instrumentHandle, char selectorString[]);
Resets a signal to the default values.
| 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. |
| 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 |
int32 __stdcall RFmxBT_WaitForAcquisitionComplete (niRFmxInstrHandle instrumentHandle, float64 timeout);
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.
| 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. |
| 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 |
int32 __stdcall RFmxBT_WaitForMeasurementComplete (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout);
Waits for the specified number for seconds for all the measurements to complete.
| 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. |
| 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 |
int32 __stdcall RFmxBT_CheckMeasurementStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], int32* isDone);
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.
| 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. |
| 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 |