niBTSA_DF1GetAverageBlockdf1maxTrace

NI Bluetooth Analysis Toolkit 19.1 Help

Edition Date: October 2019

Part Number: 373431L-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niBTSA_DF1GetAverageBlockdf1maxTrace (niBTSASession session, char channelString[], float64 *x0, float64 *dx, float64 DF1AverageBlock[], int32 dataArraySize, int32 *actualArraySize);

Purpose

Returns the average block df1max versus time trace.

The Bluetooth test specification document specifies 11110000 as the 8-bit sequence pattern to use as a payload for this measurement. For LE-LR-125k packets, the payload pattern should be 11111111, which results in a coded bit sequence of 11110000.

The toolkit measures the average frequency deviation, df1max, within the bit period for each second, third, sixth, and seventh of these 8-bit sequences. This value is expressed in Hz. All the df1max values within the packet are recorded as block df1max. The block df1max array is averaged over the different acquisitions based on the specified averaging type and the number of averages and it is given as Average Block df1max Trace.

Parameters

Input
Name Type Description
session niBTSASession Specifies the niBT SA session. Use this parameter to configure the behavior and operation of the appropriate NI Bluetooth Analysis Toolkit function that accepts the niBTSASession as an input.
channelString char[] Set this parameter to "" (empty string) or NULL.
dataArraySize int32 Specifies the size of the DF1AverageBlock array.
Output
Name Type Description
x0 float64* Returns the starting block index. This value is set to 0.
dx float64* Returns the block interval. This value is set to 1.
DF1AverageBlock float64[] Returns the array of block df1max values of the signal. This value is expressed in Hz.
actualArraySize int32* Returns the actual number of elements populated in the DF1AverageBlock array. If the array is not large enough to hold all the samples, the function returns an error and the dataArraySize parameter returns the minimum expected size of the output array.

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. Examine the status code from each call to an niBT SA 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 niBTSA_GetErrorString function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful