niBTDTM_HCILEDirectionFindingTransmitterTest
- Updated2023-02-21
- 3 minute(s) read
int32 __stdcall niBTDTM_HCILEDirectionFindingTransmitterTest( niBTDTMSession session, int32 channelNumber, int32 payloadLength, int32 LEPatternType, 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 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 generated signal. The default value is 0. | ||||||||||||||||
| payloadLength | 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.
|
||||||||||||||||
| PHY | int32 | Specifies the type of the packet to be transmitted by the physical layer of the DUT. The default is NIBLUETOOTHDTM_VAL_TRANSMITTER_PHY_1MBPS.
|
||||||||||||||||
| directionFindingMode | int32 | Specifies the mode of direction finding. The default value is NIBTDTM_VAL_DIRECTION_FINDING_MODE_DISABLED.
|
||||||||||||||||
| 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 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:
|
||||||||