niBluetoothDTM_HCILETransmitterTest
- Updated2025-10-13
- 2 minute(s) read
Sends the command to the device under test (DUT) to start the transmitter test.
Syntax
int32 __stdcall niBluetoothDTM_HCILETransmitterTest(niBluetoothDTMSession session, int32 channelNumber, int32 payloadLengthBytes, int32 lePatternType, int32 status)
Parameters
| Name | Direction | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| session | [out] | niBluetoothDTMSession | Specifies the name of the communication port to which the DUT is connected. | ||||||||||||||||||
| channelNumber | [in] | int32 | Specifies the Bluetooth transmit channel number of the signal generated by the DUT. The default value is 0. | ||||||||||||||||||
| payloadLengthBytes | [in] | int32 | Specifies the length, in bytes, of payload data in each packet that the DUT transmits. The default value is 37. | ||||||||||||||||||
| lePatternType | [in] | int32 | Specifies the type of payload to use for the LE packet. Payload type values of NIBLUETOOTHDTM_VAL_LE_PATTERN_TYPE_PRBS9, NIBLUETOOTHDTM_VAL_LE_PATTERN_TYPE_11110000, and NIBLUETOOTHDTM_VAL_LE_PATTERN_TYPE_10101010 must be supported by the DUT. The remaining payload type values are optional. The default value is NIBLUETOOTHDTM_VAL_LE_PATTERN_TYPE_PRBS9.
| ||||||||||||||||||
| status | [out] | 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. |
Returns
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 niBluetoothDTM 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 |