RFmxBT_ModAccFetchFrequencyErrorLe
- Updated2025-04-08
- 2 minute(s) read
Fetches ModAcc frequency error measurement results for low energy (LE) or low energy - channel sounding (LE-CS) packets.
Syntax
int32 __stdcall RFmxBT_ModAccFetchFrequencyErrorLe(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *peakFrequencyErrorMaximum, float64 *initialFrequencyDriftMaximum, float64 *peakFrequencyDriftMaximum, float64 *peakFrequencyDriftRateMaximum)
Parameters
Name | Direction | Type | Description |
---|---|---|---|
instrumentHandle | [in] | niRFmxInstrHandle | This parameter specifies the RFmx session refnum. This parameter is obtained from the RFmxInstr_Initialize function. |
selectorString | [in] | char | This parameter 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. The default value is "" (empty string). |
timeout | [in] | float64 | This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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. The default value is 10. |
peakFrequencyErrorMaximum | [out] | float64 * | This parameter when you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to Disabled, it returns the peak frequency error value computed on the preamble and payload portion of the LE packet. When you set the Direction Finding Mode attribute to Angle of Arrival, it returns the peak frequency error value computed on the Constant tone extension field of the LE packet. When you set the RFMXBT_ATTR_MODACC_AVERAGING_ENABLED attribute to 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 | [out] | float64 * | This parameter returns the initial frequency drift value computed on the LE packet. When you set the ModAcc Averaging Enabled attribute to 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 | [out] | float64 * | This parameter returns the peak frequency drift value computed on the LE packet. When you set the ModAcc Averaging Enabled attribute to 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 | [out] | float64 * | This parameter returns the peak frequency drift rate value computed on the LE packet. When you set the ModAcc Averaging Enabled attribute to 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. |
Returns
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 |