Accurate Bluetooth Ranging#

Connection handle

Connection handle

Enum sl_bt_cs_role_status_t. Enable or disable status of the Initiator role. Values:

• sl_bt_cs_role_status_disable (0x0): The given role is disabled

• sl_bt_cs_role_status_enable (0x1): The given role is enabled

Enum sl_bt_cs_role_status_t. Enable or disable status of the Reflector role. Values:

• sl_bt_cs_role_status_disable (0x0): The given role is disabled

• sl_bt_cs_role_status_enable (0x1): The given role is enabled

Antenna identifier to be used for ABR sync packets.

• Range: 1 to 4

Maximum transmit power level to be used in all ABR transmissions. Units: dBm.

• Range: -127 to +20

The connection handle

ABR configuration identifier.

• Range: 0 to 3

Defines in which device the created configuration will be written

• Value: 0x00. Write ABR configuration in the local controller only

• Value: 0x01. Write ABR configuration in both the local and remote controller using a configuration procedure

Enum sl_bt_cs_mode_t. Main mode type. Values:

• sl_bt_cs_mode_rtt (0x1): Round Trip Time (RTT) measurement

• sl_bt_cs_mode_pbr (0x2): Phase-Based Ranging (PBR) measurement

• sl_bt_cs_submode_disabled (0xff): Submode disabled for the procedure.

Enum sl_bt_cs_mode_t. Sub mode type. Values:

• sl_bt_cs_mode_rtt (0x1): Round Trip Time (RTT) measurement

• sl_bt_cs_mode_pbr (0x2): Phase-Based Ranging (PBR) measurement

• sl_bt_cs_submode_disabled (0xff): Submode disabled for the procedure.

Minimum number of ABR main mode steps to be executed prior to a sub mode step.

• Range: 1 to 160

Maximum number of ABR main mode steps to be executed prior to a sub mode step.

• Range: 1 to 160

Number of main mode steps taken from the end of the last ABR subevent to be repeated at the beginning of the current ABR subevent directly after the value r last Mode 0 step of that event.

• Range: 0 to 3

Number of Mode 0 steps to be included at the beginning of the test ABR subevent

• Range: 1 to 3

Enum sl_bt_cs_role_t. Device's role during the ABR procedure Values:

• sl_bt_cs_role_initiator (0x0): The device will initiate the procedure

• sl_bt_cs_role_reflector (0x1): The device will reciprocate transmission

Enum sl_bt_cs_rtt_type_t. RTT payload type used in the ABR procedure Values:

• sl_bt_cs_rtt_type_coarse (0x0): RTT Coarse

• sl_bt_cs_rtt_type_fractional_96_bit_sounding (0x2): RTT Fractional with 96-bit Sounding Sequence

Enum sl_bt_gap_phy_t. Used PHY for ABR SYNC exchanges during a procedure Values:

• sl_bt_gap_phy_1m (0x1): 1M PHY

A fixed length byte array of 10 bytes consisting of 79 1-bit fields.

The nth such field (in the range 0 to 78) contains the value for the ABR channel index n.

• Bit value 0: Channel n is disabled

• Bit value 1: Channel n is enabled

The rest of most significant bits are reserved for future use and must be set to 0. Channels n = 0, 1, 23, 24, 25, 77 and 78 shall be ignored and not used for ABR. At least 15 channels shall be marked as used.

Number of times the channel_map field will be cycled through for non-Mode 0 steps within an ABR procedure.

• Range: 0x01 to 0xFF

Enum sl_bt_cs_channel_selection_algorithm_t. Channel selection algorithm Values:

• sl_bt_cs_channel_selection_algorithm_3b (0x0): Use Channel Selection Algorithm #3b for non-mode 0 ABR steps

• sl_bt_cs_channel_selection_algorithm_3c (0x1): Use Channel Selection Algorithm #3c for non-mode 0 ABR steps

• sl_bt_cs_channel_selection_algorithm_user_shape_interleaved (0x2): Use Interleaved shape for user specified channel sequence

Enum sl_bt_cs_ch3c_shape_t. Ch3c shape Values:

• sl_bt_cs_ch3c_shape_hat (0x0): Use Hat shape for user specified channel sequence

• sl_bt_cs_chc3_shape_interleaved (0x1): Use Interleaved shape for user specified channel sequence

Number of channels skipped in each rising and falling sequence.

• Range: 2 to 8

Enum sl_bt_cs_companion_signal_status_t. Companion device's signal status Values:

• sl_bt_cs_companion_signal_status_disable (0x0): The companion signal is disabled

• sl_bt_cs_companion_signal_status_enable (0x1): The companion signal is enabled

Connection handle

ABR configuration identifier

• Range: 0 to 3

A fixed length byte array of 10 bytes consisting of 79 1-bit fields.

The nth field (in the range 0 to 78) contains the value for the link layer channel index n.

• Bit value 0: Channel n is disabled.

• Bit value 1: Channel n is enabled.

The rest of most significant bits are reserved for future use and must be set to 0. Channels n = 0, 1, 23, 24, 25, 77 and 78 shall be ignored and not used for ABR.

The connection handle

ABR configuration identifier.

• Range: 0 to 3.

Maximum duration for each measurement procedure. Value in units of 0.625 ms.

• Range: 0x0001 to 0xFFFF.

• Time: N x 0.625ms. N being the input.

• Time range: 0.625 ms to 40.959375 s.

Minimum duration in number of connection events between consecutive measurement procedure.

• Range: 0x01 to 0xFFFF.

Maximum duration in number of connection events between consecutive measurement procedure.

• Range: 0x01 to 0xFFFF.

Maximum number of ABR procedures to be scheduled

• Range: 0x01 to 0xFFFF: Maximum number of procedures to be scheduled.

• Value: 0x00. Procedures to continue until disabled.

Minimum suggested duration for each ABR subevent. Units: microseconds.

• Range: 0x01 to 0xFFFFFF

• Time range: 1250 us to 4s

Maximum suggested duration for each ABR subevent. Units: microseconds.

• Range: 0x01 to 0xFFFFFF

• Time range: 1250 us to 4s

Antenna configuration index

• Range: 0 to 7

Enum sl_bt_gap_phy_t. PHY on which the ABR transmission will take place Values:

• sl_bt_gap_phy_1m (0x1): 1M PHY

• sl_bt_gap_phy_2m (0x2): 2M PHY

• sl_bt_gap_phy_coded (0x4): Coded PHY, 125k (S=8) or 500k (S=2)

• sl_bt_gap_phy_any (0xff): Any PHYs the device supports

Transmit power delta. Units: dB.

• Value: 0x80. Host does not have a recommendation for transmit power delta

Preferred peer-ordered antenna elements to be used by the remote device for the antenna configuration denoted by the tone antenna config selection.

• Bit 0: Use first ordered antenna element

• Bit 1: Use second ordered antenna element

• Bit 2: Use third ordered antenna element

• Bit 3: Use fourth ordered antenna element

The connection handle

Enum sl_bt_cs_procedure_state_t. Enabled or disabled ABR procedure state. Values:

• sl_bt_cs_procedure_state_disabled (0x0): ABR procedures are disabled

• sl_bt_cs_procedure_state_enabled (0x1): ABR procedures are enabled

ABR configuration identifier

Length of data in antenna_element_offset

Offset of each antenna, each element is a signed 16-bit integer stored in two consecutive bytes in little-endian order. Units: 1 cm.

The number of ABR configurations supported per connection.

• Range: 0x01-0x04

The maximum number of consecutive ABR procedures supported.

• 0x00: Fixed number of consecutive procedures and for an indefinite number of procedures until termination

• 0x0001-0xFFFF: Maximum number of consecutive procedures supported

The number of antenna elements available for ABR tone exchanges.

• Range: 0x01-0x04

The maximum number of antenna paths supported.

• Range: 0x01-0x04

This value is a bitmask of flags to indicate which ABR roles are supported by the controller. Flags:

• 0x01, bit 0: Initiator role

• 0x02, bit 1: Reflector role

This value is a bitmask of flags to indicate which Optional ABR modes are supported. Flags:

• 0x02, bit 0: Mode 3 is supported

This value is a bitmask of flags to indicate which Round Trip Time (RTT) ABR capabilities accuracy requirement in rtt_aa_only_n, rtt_sounding_n, and rtt_random_payload. Flags:

• 0x01, bit 0: 10 ns time-of-flight (ToF) precision requirement for rtt_aa_only if set; otherwise 150 ns ToF

• 0x02, bit 1: 10 ns ToF precision requirement for rtt_sounding if set; otherwise 150 ns ToF

• 0x04, bit 2: 10 ns ToF precision requirement for rtt_random_payload if set; otherwise 150 ns ToF

RTT Access Address(AA) is supported by the controller

• 0x00: RTT AA Only is not supported

• 0x01-0xFF: Number of SYNC changes needed to satisfy the precision requirements

RTT Sounding is supported by the controller

• 0x00: RTT Sounding is not supported

• 0x01-0xFF: Number of SYNC changes needed to satisfy the precision requirements

RTT Random Payload is supported by the controller

• 0x00: RTT Random Payload is not supported

• 0x01-0xFF: Number of SYNC changes needed to satisfy the precision requirements

This value is a bitmask of flags to indicate which ABR SYNC packages supported in an specific PHY. Flags:

• 0x02, bit 1: LE 2M PHY ABR SYNC packages are supported

This value is a bitmask of flags to indicate which Optional ABR subfeatures supported is supported. Flags:

• 0x01, bit 0: ABR Companion Signal is supported

• 0x02, bit 1: ABR with zero Frequency Actuation Error relative to Mode 0 transmissions in reflector role is supported

• 0x04, bit 2: ABR Channel Selection Algorithm #3c is supported

• 0x08, bit 3: ABR phase-based ranging from a sounding sequence is supported

This value is a bitmask of flags to indicate which Time for Interlude Period 1 (IP1) supported is supported. Flags:

• 0x0001, bit 0: Time durantion of 10 microseconds is supported

• 0x0002, bit 1: Time durantion of 20 microseconds is supported

• 0x0004, bit 2: Time durantion of 30 microseconds is supported

• 0x0008, bit 3: Time durantion of 40 microseconds is supported

• 0x0010, bit 4: Time durantion of 50 microseconds is supported

• 0x0020, bit 5: Time durantion of 60 microseconds is supported

• 0x0040, bit 6: Time durantion of 80 microseconds is supported

This value is a bitmask of flags to indicate which Time for Interlude Period 2 (IP2) supported is supported. Flags:

• 0x0001, bit 0: Time duration of 10 microseconds is supported

• 0x0002, bit 1: Time duration of 20 microseconds is supported

• 0x0004, bit 2: Time duration of 30 microseconds is supported

• 0x0008, bit 3: Time duration of 40 microseconds is supported

• 0x0010, bit 4: Time duration of 50 microseconds is supported

• 0x0020, bit 5: Time duration of 60 microseconds is supported

• 0x0040, bit 6: Time duration of 80 microseconds is supported

This value is a bitmask of flags to indicate which Time for Frequency Change Spaceing (FCS) is supported. Flags:

• 0x0001, bit 0: Time duration of 10 microseconds is supported

• 0x0002, bit 1: Time duration of 20 microseconds is supported

• 0x0004, bit 2: Time duration of 30 microseconds is supported

• 0x0008, bit 3: Time duration of 40 microseconds is supported

• 0x0010, bit 4: Time duration of 50 microseconds is supported

• 0x0020, bit 5: Time duration of 60 microseconds is supported

• 0x0040, bit 6: Time duration of 80 microseconds is supported

• 0x0100, bit 7: Time duration of 100 microseconds is supported

• 0x0200, bit 8: Time duration of 120 microseconds is supported

This value is a bitmask of flags to indicate which Time for Phase Measurement (PM) supported is supported. Flags:

• 0x0001, bit 0: Time duration of 10 microseconds is supported

• 0x0002, bit 1: Time duration of 20 microseconds is supported

Time in microseconds for the antenna switch period of the ABR tones.

• Values: 0x02, 0x02, 0x04 and 0x0A