Data structure of the config_complete event.
Public Attributes#
Public Attribute Documentation#
config_id#
uint8_t sl_bt_evt_cs_config_complete_s::config_id
CS configuration identifier.
Range: 0 to 3
status#
uint16_t sl_bt_evt_cs_config_complete_s::status
SL_STATUS_OK if successful. Error code otherwise.
config_state#
uint8_t sl_bt_evt_cs_config_complete_s::config_state
Enum sl_bt_cs_config_state_t. CS configuration state Values:
sl_bt_cs_config_state_removed (0x0): The CS device configuration is removed
sl_bt_cs_config_state_created (0x1): The CS device configuration is created
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.
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.
min_main_mode_steps#
uint8_t sl_bt_evt_cs_config_complete_s::min_main_mode_steps
Minimum number of CS main mode steps to be executed prior to a sub mode step.
Range: 2 to 255
max_main_mode_steps#
uint8_t sl_bt_evt_cs_config_complete_s::max_main_mode_steps
Maximum number of CS main mode steps to be executed prior to a sub mode step.
Range: 2 to 255
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 CS subevent to be repeated at the beginning of the current CS subevent directly after the last Mode 0 step of that event.
Range: 0 to 3
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 CS subevent.
Range: 1 to 3
role#
uint8_t sl_bt_evt_cs_config_complete_s::role
Enum sl_bt_cs_role_t. Device role during the CS 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
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 CS procedure Values:
sl_bt_cs_rtt_type_aa_only (0x0): RTT Access Address (AA) only
sl_bt_cs_rtt_type_fractional_32_bit_sounding (0x1): RTT Fractional with 32-bit Sounding Sequence
sl_bt_cs_rtt_type_fractional_96_bit_sounding (0x2): RTT Fractional with 96-bit Sounding Sequence
sl_bt_cs_rtt_type_fractional_32_bit_random (0x3): RTT Fractional with 32-bit Random Sequence
sl_bt_cs_rtt_type_fractional_64_bit_random (0x4): RTT Fractional with 64-bit Random Sequence
sl_bt_cs_rtt_type_fractional_96_bit_random (0x5): RTT Fractional with 96-bit Random Sequence
sl_bt_cs_rtt_type_fractional_128_bit_random (0x6): RTT Fractional with 128-bit Random Sequence
cs_sync_phy#
uint8_t sl_bt_evt_cs_config_complete_s::cs_sync_phy
Enum sl_bt_gap_phy_t. Used PHY for CS_SYNC exchanges during a procedure 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
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 80 1-bit fields.
The nth field (in the range 0 to 78) contains the value for the CS channel index n.
Bit value 0: Channel n is disabled
Bit value 1: Channel n is enabled
The most significant bit (79) is 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 CS. At least 15 channels shall be marked as used.
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 CS procedure.
Range: 1 to 255
channel_selection_type#
uint8_t sl_bt_evt_cs_config_complete_s::channel_selection_type
Enum sl_bt_cs_channel_selection_algorithm_t. CS 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 CS steps
sl_bt_cs_channel_selection_algorithm_3c (0x1): Use Channel Selection Algorithm #3c for non-mode 0 CS steps
sl_bt_cs_channel_selection_algorithm_user_shape_interleaved (0x2): Use Interleaved shape for user specified channel sequence
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
ch3c_jump#
uint8_t sl_bt_evt_cs_config_complete_s::ch3c_jump
Number of channels skipped in each rising and falling sequence
Range: 3 to 8
t_ip1_time#
uint8_t sl_bt_evt_cs_config_complete_s::t_ip1_time
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.
t_ip2_time#
uint8_t sl_bt_evt_cs_config_complete_s::t_ip2_time
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.
t_fcs_time#
uint8_t sl_bt_evt_cs_config_complete_s::t_fcs_time
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.
t_pm_time#
uint8_t sl_bt_evt_cs_config_complete_s::t_pm_time
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.