niBTDTM_HCILEEnhancedTransmitterTest

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_HCILEEnhancedTransmitterTest( niBTDTMSession session, int32 channelNumber, int32 payloadLengthBytes, int32 LEPatternType, int32 PHY, int32 *status);

Purpose

Sends the command to the device under test (DUT) to start the transmitter 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 signal generated by the DUT. The default value is 0.
payloadLengthBytes int32 Specifies the length, in bytes, of payload data in each packet that the DUT transmits. The default value is 37.
LEPatternType int32 Specifies the type of payload to use for the LE packet. Payload type values of NIBTDTM_VAL_LE_PATTERN_TYPE_PRBS9, NIBTDTM_VAL_LE_PATTERN_TYPE_11110000, and NIBTDTM_VAL_LE_PATTERN_TYPE_10101010 must be supported by the DUT. The remaining payload type values are optional. The default value is NIBTDTM_VAL_LE_PATTERN_TYPE_PRBS9.

NIBTDTM_VAL_LE_PATTERN_TYPE_PRBS9 (0)

Specifies that the bit sequence is PRBS9.

NIBTDTM_VAL_LE_PATTERN_TYPE_11110000 (1)

Specifies that the bit sequence is 11110000.

NIBTDTM_VAL_LE_PATTERN_TYPE_10101010 (2)

Specifies that the bit sequence is 10101010.

NIBTDTM_VAL_LE_PATTERN_TYPE_PRBS15 (3)

Specifies that the bit sequence is PRBS15.

NIBTDTM_VAL_LE_PATTERN_TYPE_11111111 (4)

Specifies that the bit sequence is 11111111.

NIBTDTM_VAL_LE_PATTERN_TYPE_00000000 (5)

Specifies that the bit sequence is 00000000.

NIBTDTM_VAL_LE_PATTERN_TYPE_00000000 (5)

Specifies that the bit sequence is 00000000.

NIBTDTM_VAL_LE_PATTERN_TYPE_00001111 (6)

Specifies that the bit sequence is 00001111.

NIBTDTM_VAL_LE_PATTERN_TYPE_01010101 (7)

Specifies that the bit sequence is 01010101.

PHY int32 Specifies the type of the packet to be transmitted by the physical layer of the DUT. The default is NIBTDTM_VAL_TRANSMITTER_PHY_1MBPS.

NIBTDTM_VAL_TRANSMITTER_PHY_1MBPS (0)

Transmitter is set to use the LE 1M PHY.

NIBTDTM_VAL_TRANSMITTER_PHY_2MBPS (1)

Transmitter is set to use the LE 2M PHY.

NIBTDTM_VAL_TRANSMITTER_PHY_CODED_125KBPS (2)

Transmitter is set to use the LE Coded PHY with S = 8 data coding.

NIBTDTM_VAL_TRANSMITTER_PHY_CODED_500KBPS (3)

Transmitter is set to use the LE Coded PHY with S = 2 data coding.

Output
Name Type Description
status int32 Returns the status of the transmitter test command. The DUT receives and executes the transmitter test command if the status parameter returns a 0x00 value. The transmitter 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