Data structure of the config_complete event.

Public Attribute Documentation#

connection#

uint8_t sl_bt_evt_cs_config_complete_s::connection

Connection handle


Definition at line 12640 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

config_id#

uint8_t sl_bt_evt_cs_config_complete_s::config_id

ABR configuration identifier.

  • Range: 0 to 3


Definition at line 12641 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

status#

uint16_t sl_bt_evt_cs_config_complete_s::status

SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12644 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

config_state#

uint8_t sl_bt_evt_cs_config_complete_s::config_state

Enum sl_bt_cs_config_state_t. ABR configuration state Values:

  • sl_bt_cs_config_state_removed (0x0): The ABR device configuration is removed

  • sl_bt_cs_config_state_created (0x1): The ABR device configuration is created


Definition at line 12647 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

main_mode_type#

uint8_t sl_bt_evt_cs_config_complete_s::main_mode_type

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.


Definition at line 12659 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sub_mode_type#

uint8_t sl_bt_evt_cs_config_complete_s::sub_mode_type

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.


Definition at line 12674 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

min_main_mode_steps#

uint8_t sl_bt_evt_cs_config_complete_s::min_main_mode_steps

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

  • Range: 1 to 160


Definition at line 12689 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

max_main_mode_steps#

uint8_t sl_bt_evt_cs_config_complete_s::max_main_mode_steps

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

  • Range: 1 to 160


Definition at line 12694 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

main_mode_repetition#

uint8_t sl_bt_evt_cs_config_complete_s::main_mode_repetition

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 last Mode 0 step of that event.

  • Range: 0 to 3


Definition at line 12699 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

mode_calibration_steps#

uint8_t sl_bt_evt_cs_config_complete_s::mode_calibration_steps

Number of calibration mode steps to be included at the beginning of the test ABR subevent.

  • Range: 1 to 3


Definition at line 12708 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

role#

uint8_t sl_bt_evt_cs_config_complete_s::role

Enum sl_bt_cs_role_t. Device 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


Definition at line 12713 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

rtt_type#

uint8_t sl_bt_evt_cs_config_complete_s::rtt_type

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


Definition at line 12725 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

cs_sync_phy#

uint8_t sl_bt_evt_cs_config_complete_s::cs_sync_phy

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

  • sl_bt_gap_phy_1m (0x1): 1M PHY


Definition at line 12736 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

channel_map#

sl_bt_cs_channel_map_t sl_bt_evt_cs_config_complete_s::channel_map

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 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.


Definition at line 12743 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

channel_map_repetition#

uint8_t sl_bt_evt_cs_config_complete_s::channel_map_repetition

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

  • Range: 0x01 to 0xFF


Definition at line 12767 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

channel_selection_type#

uint8_t sl_bt_evt_cs_config_complete_s::channel_selection_type

Enum sl_bt_cs_channel_selection_algorithm_t. ABR algorithm to be used during the procedure for non-mode 0 steps Value:

  • 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


Definition at line 12773 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

ch3c_shape#

uint8_t sl_bt_evt_cs_config_complete_s::ch3c_shape

Enum sl_bt_cs_ch3c_shape_t. Shape for user-specified channel sequence 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


Definition at line 12793 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

ch3c_jump#

uint8_t sl_bt_evt_cs_config_complete_s::ch3c_jump

Number of channels skipped in each rising and falling sequence

  • Range: 0x03 to 0x08


Definition at line 12807 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

companion_signal_enable#

uint8_t sl_bt_evt_cs_config_complete_s::companion_signal_enable

Enum sl_bt_cs_companion_signal_status_t. Enabled or disabled companion 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


Definition at line 12811 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

ip1_time_us#

uint8_t sl_bt_evt_cs_config_complete_s::ip1_time_us

Interlude time in microseconds between the RTT packets. Values: 0x0A, 0x14, 0x1E, 0x28, 0x32, 0x3C, 0x50, or 0x91. All other values are reserved for future use.


Definition at line 12824 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

ip2_time_us#

uint8_t sl_bt_evt_cs_config_complete_s::ip2_time_us

Interlude time in microseconds between the CS tones. Values: 0x0A, 0x14, 0x1E, 0x28, 0x32, 0x3C, 0x50, or 0x91. All other values are reserved for future use.


Definition at line 12832 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

fcs_time_us#

uint8_t sl_bt_evt_cs_config_complete_s::fcs_time_us

Time in microseconds for frequency changes. Values: 0x0F, 0x14, 0x1E, 0x28, 0x32, 0x3C, 0x50, 0x64, 0x78, or 0x96. All other values are reserved for future use.


Definition at line 12839 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

pm_time_us#

uint8_t sl_bt_evt_cs_config_complete_s::pm_time_us

Time in microseconds for the phase measurement period of the CS tones. Values: 0x0A, 0x14, or 0x28. All other values are reserved for future use.


Definition at line 12846 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h