niBTDTM_HCILEDirectionFindingReceiverTest

NI Bluetooth Toolkit Direct Test Mode 19.1 Help

Edition Date: October 2019

Part Number: 375699E-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niBTDTM_HCILEDirectionFindingReceiverTest( niBTDTMSession session, int32 channelNumber, int32 modulationIndex, int32 PHY, int32 directionFindingMode, int32 lengthOfSwitchingPattern, float64 CTELength, float64 CTESlotDuration, int32 antennaID[], int32 antennaIDArraySize, int32 *status);

Purpose

Sends the command to the device under test (DUT) to start the receiver test.

Parameters

Input
Name Type Description
session niBTDTMSession Specifies the name of the communication port to which the DUT is connected.
channelNumber int32 Specifies the Bluetooth transmit channel number of the generated signal. The default value is 0.
modulationIndex int32 Specifies the type of modulation index at the generator. The default value is NIBTDTM_VAL_MODULATION_INDEX_STANDARD.
NIBTDTM_VAL_MODULATION_INDEX_STANDARD (0)

The packets are generated with standard modulation index.

NIBTDTM_VAL_MODULATION_INDEX_STABLE (1)

The packets are generated with stable modulation index.

PHY int32 Specifies the type of the generated packet by the physical layer of the DUT. The default value is NIBTDTM_VAL_RECEIVER_PHY_1MBPS.
NIBTDTM_VAL_RECEIVER_PHY_1MBPS (0)

Receiver is set to use the LE 1M PHY.

NIBTDTM_VAL_RECEIVER_PHY_2MBPS (1)

Receiver is set to use the LE 2M PHY.

NIBTDTM_VAL_RECEIVER_PHY_CODED (2)

Receiver is set to use the Coded PHY.

directionFindingMode int32 Specifies the mode of direction finding. The default value is NIBTDTM_VAL_DIRECTION_FINDING_MODE_DISABLED.
NIBTDTM_VAL_DIRECTION_FINDING_MODE_DISABLED (0)

Specifies that the LE packet does not have fields required for direction finding.

NIBTDTM_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL (1)

Specifies the LE packets uses the angle of arrival method of direction finding.

NIBTDTM_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE (2)

Specifies the LE packet uses angle of departure method of direction finding.

lengthOfSwitchingPattern int32 Specifies the length of the antenna switching pattern. The default value is 0.
CTELength float64 Specifies specifies the length of the constant tone extension field in the generated signal. This value is expressed in seconds. This parameter is applicable only when you set the directionFindingMode parameter to either NIBTDTM_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTDTM_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. The default value is 160 microseconds.
CTESlotDuration float64 Specifies the length of the antenna switching and sampling slots in the constant tone extension field. This value is expressed in seconds. The default value is 1 us. Valid values are 1 us and 2 us.
antennaID int32[] Specifies the array of Antenna IDs in the antenna switching pattern. The length of Antenna IDs array must be equal to Length Of Switching Pattern parameter.
antennaIDArraySize int32 Specifies size of antennaID parameter.
Output
Name Type Description
status int32 Returns the status of the receiver test command. The DUT receives and executes the receiver test command if the status parameter returns a 0x00 value. The receiver test command fails if the status parameter returns a non-zero (0x01-0xFF) value.

Return Value

Name Type Description
returnValue 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 niBTDTM function to determine if an error has occurred.

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