NI RFmx Bluetooth Packet Attributes - ni/grpc-device GitHub Wiki
- RFMXBT_ATTR_PACKET_TYPE
- RFMXBT_ATTR_DATA_RATE
- BD Address
- RFMXBT_ATTR_ACCESS_ADDRESS
- RFMXBT_ATTR_PAYLOAD_BIT_PATTERN
- RFMXBT_ATTR_PAYLOAD_LENGTH_MODE
- RFMXBT_ATTR_PAYLOAD_LENGTH
- Direction Finding
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the type of the Bluetooth packet to be measured. In this document, packet type is sometimes referred to by the Bluetooth physical layer (PHY) it belongs to. Supported Bluetooth physical layers are basic rate (BR), enhanced data rate (EDR) and low energy (LE). You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXBT_VAL_PACKET_TYPE_DH1. Get Function: RFmxBT_GetPacketType Set Function: RFmxBT_SetPacketType |
| Values: | |
|---|---|
| RFMXBT_VAL_PACKET_TYPE_DH1 (0) | Specifies that the packet type is DH1. The packet belongs to BR PHY. Refer to sections 6.5.1.5 and 6.5.4.2, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_DH3 (1) | Specifies that the packet type is DH3. The packet belongs to BR PHY. Refer to section 6.5.4.4, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_DH5 (2) | Specifies that the packet type is DH5. The packet belongs to BR PHY. Refer to section 6.5.4.6, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_DM1 (3) | Specifies that the packet type is DM1. The packet belongs to BR PHY. Refer to sections 6.5.1.5 and 6.5.4.1, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_DM3 (4) | Specifies that the packet type is DM3. The packet belongs to BR PHY. Refer to section 6.5.4.3, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_DM5 (5) | Specifies that the packet type is DM5. The packet belongs to BR PHY. Refer to section 6.5.4.5, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_2_DH1 (6) | Specifies that the packet type is 2-DH1. The packet belongs to EDR PHY. Refer to section 6.5.4.8, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_2_DH3 (7) | Specifies that the packet type is 2-DH3. The packet belongs to EDR PHY. Refer to section 6.5.4.9, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_2_DH5 (8) | Specifies that the packet type is 2-DH5. The packet belongs to EDR PHY. Refer to section 6.5.4.10, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_3_DH1 (9) | Specifies that the packet type is 3-DH1. The packet belongs to EDR PHY. Refer to section 6.5.4.11, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_3_DH3 (10) | Specifies that the packet type is 3-DH3. The packet belongs to EDR PHY. Refer to section 6.5.4.12, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_3_DH5 (11) | Specifies that the packet type is 3-DH5. The packet belongs to EDR PHY. Refer to section 6.5.4.13, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_2_EV3 (12) | Specifies that the packet type is 2-EV3. The packet belongs to EDR PHY. Refer to section 6.5.3.4, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_2_EV5 (13) | Specifies that the packet type is 2-EV5. The packet belongs to EDR PHY. Refer to section 6.5.3.5, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_3_EV3 (14) | Specifies that the packet type is 3-EV3. The packet belongs to EDR PHY. Refer to section 6.5.3.6, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_3_EV5 (15) | Specifies that the packet type is 3-EV5. The packet belongs to EDR PHY. Refer to section 6.5.3.7, Part B, Volume 2 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| RFMXBT_VAL_PACKET_TYPE_LE (16) | Specifies that the packet belongs to LE PHY. Refer to sections 2.1 and 2.2, Part B, Volume 6 of the Bluetooth Core Specification v5.1 for more information about this packet. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the data rate of the LE packet transmitted by the device under test (DUT). This value is expressed in bps. This attribute is applicable only to LE packet type. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 1M. Get Function: RFmxBT_GetDataRate Set Function: RFmxBT_SetDataRate |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the 24-bit lower address part (LAP) of the bluetooth device address (BD_ADDR). This value is used to generate the sync word if you set the burst synchronization type attribute in TXP, ACP, or ModAcc measurements to Sync Word. This attribute is applicable only to BR and EDR packet types. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 0. Get Function: RFmxBT_GetBDAddressLAP Set Function: RFmxBT_SetBDAddressLAP |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the 32-bit LE access address. This value is used to synchronize to the start of the packet if you set the burst synchronization type attribute in TXP, ACP, or ModAcc measurements to Sync Word and the RFMXBT_ATTR_PACKET_TYPE attribute to RFMXBT_VAL_PACKET_TYPE_LE. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 0x71764129 as specified by the bluetooth standard. Get Function: RFmxBT_GetAccessAddress Set Function: RFmxBT_SetAccessAddress |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the bit pattern present in the payload of the packet. This value is used to determine the set of ModAcc measurements to be performed. Refer to the Payload Bit Pattern property that lists the measurements that are applicable for different payload bit patterns. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXBT_VAL_PAYLOAD_BIT_PATTERN_STANDARD_DEFINED. Get Function: RFmxBT_GetPayloadBitPattern Set Function: RFmxBT_SetPayloadBitPattern |
| Values: | |
|---|---|
| RFMXBT_VAL_PAYLOAD_BIT_PATTERN_STANDARD_DEFINED (0) | Specifies that the payload bit pattern is Standard Defined. |
| RFMXBT_VAL_PAYLOAD_BIT_PATTERN_11110000 (1) | Specifies that the payload bit pattern is 11110000. |
| RFMXBT_VAL_PAYLOAD_BIT_PATTERN_10101010 (2) | Specifies that the payload bit pattern is 10101010. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the payload length mode of the signal to be measured. The payload length mode and Payload Length attributes decide the length of the payload to be used for measurement. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXBT_VAL_PAYLOAD_LENGTH_MODE_AUTO. Get Function: RFmxBT_GetPayloadLengthMode Set Function: RFmxBT_SetPayloadLengthMode |
| Values: | |
|---|---|
| RFMXBT_VAL_PAYLOAD_LENGTH_MODE_MANUAL (0) | Enables the value specified by the Payload Length attribute. The acquisition and measurement durations will be decided based on this value. |
| RFMXBT_VAL_PAYLOAD_LENGTH_MODE_AUTO (1) | Enables the standard defined maximum payload length for the selected packet type. If this attribute is set to Auto, the maximum standard defined payload length for the selected Packet Type is chosen. For LE, the maximum payload length that a device under test(DUT) can generate varies from 37 to 255 bytes. When you set the payload length mode for the LE packet type to Auto, RFmx chooses 37 bytes as the payload length. |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the payload length of the signal in bytes. This attribute is applicable only when you set the RFMXBT_ATTR_PAYLOAD_LENGTH_MODE attribute to RFMXBT_VAL_PAYLOAD_LENGTH_MODE_MANUAL. This attribute returns the payload length used for measurement if you set the RFMXBT_ATTR_PAYLOAD_LENGTH_MODE attribute to RFMXBT_VAL_PAYLOAD_LENGTH_MODE_AUTO. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 10. Get Function: RFmxBT_GetPayloadLength Set Function: RFmxBT_SetPayloadLength |
| Data Type: | int32 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeI32 RFmxBT_GetAttributeI32 |
| Description: | Specifies the mode of direction finding. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is RFMXBT_VAL_DIRECTION_FINDING_MODE_DISABLED. Get Function: RFmxBT_GetDirectionFindingMode Set Function: RFmxBT_SetDirectionFindingMode |
| Values: | |
|---|---|
| RFMXBT_VAL_DIRECTION_FINDING_MODE_DISABLED (0) | Specifies that the LE packet does not have fields required for direction finding. |
| RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL (1) | Specifies that the LE packets uses the Angle of Arrival method of direction finding. |
| RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE (2) | Specifies that the LE packets uses the Angle of Departure method of direction finding. |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeF64 RFmxBT_GetAttributeF64 |
| Description: | Specifies the length of the constant tone extension (CTE) field in the generated signal. This value is expressed in seconds. This attribute is applicable only when you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to either RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 160 microseconds. Get Function: RFmxBT_GetCTELength Set Function: RFmxBT_SetCTELength |
| Data Type: | float64 |
|---|---|
| Access: | read/write |
| Functions: | RFmxBT_SetAttributeF64 RFmxBT_GetAttributeF64 |
| Description: | Specifies the length of the switching slots and transmit slots in the constant tone extension field in the generated signal. This attribute is applicable only when you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. The default value is 1u. Get Function: RFmxBT_GetCTESlotDuration Set Function: RFmxBT_SetCTESlotDuration |
| Data Type: | int32 |
|---|---|
| Access: | read only |
| Functions: | RFmxBT_GetAttributeI32 |
| Description: | Returns the number of transmit slots in the constant time extension portion of the generated LE packet. This attribute is applicable only when you set the RFMXBT_ATTR_DIRECTION_FINDING_MODE attribute to RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or RFMXBT_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector Strings topic for information about the string syntax for named signals. Get Function: RFmxBT_GetCTENumberOfTransmitSlots |