CS Initiator#

Channel Sounding (CS) Initiator provides an instantiable initiator (central) logic that produce its own CS results and also collects CS results from CS Reflector (peripheral) devices. Once all initiator and reflector results collected correctly it is forwarded to the RTL lib that shall produce the high-level measurement values e.g. distance, likeliness of the current distance, etc.

Modules#

cs_result_t

cs_intermediate_result_t

cs_result_event_t

cs_result_data_t

state_machine_event_data_t

Enumerations#

enum

cs_procedure_action_t {

CS_PROCEDURE_ACTION_CONTINUE = 0u

CS_PROCEDURE_ACTION_TRIGGER_RESET

CS_PROCEDURE_ACTION_TRIGGER_START

CS_PROCEDURE_ACTION_TRIGGER_STOP

}

enum

state_machine_event_t {

INITIATOR_EVT_INIT_STARTED = 0U

INITIATOR_EVT_INIT_COMPLETED

INITIATOR_EVT_START_PROCEDURE

INITIATOR_EVT_PROCEDURE_ENABLE_STARTING

INITIATOR_EVT_PROCEDURE_ENABLE_COMPLETED

INITIATOR_EVT_PROCEDURE_DISABLE_COMPLETED

INITIATOR_EVT_CS_RESULT

INITIATOR_EVT_CS_RESULT_CONTINUE

INITIATOR_EVT_DELETE_INSTANCE

INITIATOR_EVT_ERROR

}

Typedefs#

typedef void(*

cs_error_cb_t)(uint8_t conn_handle, cs_error_event_t evt, sl_status_t sc)

typedef void(*

cs_result_cb_t)(const cs_result_t *result, const sl_rtl_cs_procedure *cs_procedure, const void *user_data)

typedef void(*

cs_intermediate_result_cb_t)(const cs_intermediate_result_t *result, const void *user_data)

Functions#

sl_status_t

cs_initiator_create(const uint8_t conn_handle, cs_initiator_config_t *initiator_config, const rtl_config_t *rtl_config, cs_result_cb_t result_cb, cs_intermediate_result_cb_t intermediate_result_cb, cs_error_cb_t error_cb, uint8_t *instance_id)

void

cs_initiator_init(void)

sl_status_t

cs_initiator_delete(const uint8_t conn_handle)

void

cs_initiator_deinit(void)

bool

cs_initiator_on_event(sl_bt_msg_t *evt)

Macros#

#define

CS_INITIATOR_MAX_CONNECTIONS (1)

#define

CS_INITIATOR_MAX_SUBEVENT_PER_PROC (6)

#define

CS_INITIATOR_MAX_STEP_DATA_LEN (2048)

#define

CS_INITIATOR_LOG (1)

#define

CS_INITIATOR_LOG_PREFIX "[Initiator]"

#define

CS_INITIATOR_RTL_LOG (1)

#define

CS_INITIATOR_CS_EVENT_BUF_SIZE (16)

#define

CS_INITIATOR_DEFAULT_MIN_PROCEDURE_INTERVAL (30)

#define

CS_INITIATOR_DEFAULT_MAX_PROCEDURE_INTERVAL (30)

#define

CS_INITIATOR_ANTENNA_OFFSET 0

#define

CS_INITIATOR_ERROR_TIMEOUT_MS 3000

#define

CS_INITIATOR_PROCEDURE_TIMEOUT_MS 3000

#define

CS_CUSTOM_CHANNEL_MAP { 0xFC, 0xFF, 0x7F, 0xFC, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x1F }

#define

CS_INITIATOR_DEFAULT_CS_MODE 2

#define

CS_INITIATOR_DEFAULT_MIN_CONNECTION_INTERVAL 6

#define

CS_INITIATOR_DEFAULT_MAX_CONNECTION_INTERVAL 6

#define

CS_INITIATOR_DEFAULT_MAX_PROCEDURE_COUNT 1

#define

CS_INITIATOR_DEFAULT_CONN_PHY sl_bt_gap_phy_2m

#define

CS_INITIATOR_DEFAULT_CS_SYNC_PHY sl_bt_gap_phy_1m

#define

CS_INITIATOR_DEFAULT_MODE0_STEPS 3

#define

CS_INITIATOR_DEFAULT_CS_TONE_ANTENNA_CONFIG_IDX_REQ CS_ANTENNA_CONFIG_INDEX_DUAL_ONLY

#define

CS_INITIATOR_DEFAULT_CS_SYNC_ANTENNA_REQ CS_SYNC_SWITCHING

#define

CS_INITIATOR_DEFAULT_PREFERRED_PEER_ANTENNA 1

#define

CS_INITIATOR_DEFAULT_MAX_TX_POWER 20

#define

CS_INITIATOR_DEFAULT_CREATE_CONTEXT 1

#define

CS_INITIATOR_DEFAULT_RSSI_REF_TX_POWER -40.0F

#define

CS_INITIATOR_DEFAULT_CONNECTION_PERIPHERAL_LATENCY 0

#define

CS_INITIATOR_DEFAULT_TIMEOUT 200

#define

CS_INITIATOR_DEFAULT_MIN_CE_LENGTH 0

#define

CS_INITIATOR_DEFAULT_MAX_CE_LENGTH 65535

#define

CS_INITIATOR_DEFAULT_CHANNEL_SELECTION_TYPE sl_bt_cs_channel_selection_algorithm_3b

#define

CS_INITIATOR_DEFAULT_CH3C_SHAPE sl_bt_cs_ch3c_shape_hat

#define

CS_INITIATOR_DEFAULT_ALGO_MODE SL_RTL_CS_ALGO_MODE_REAL_TIME_BASIC

#define

CS_INITIATOR_DEFAULT_CHANNEL_MAP_PRESET CS_CHANNEL_MAP_PRESET_HIGH

#define

CS_INITIATOR_DEFAULT_CH3C_JUMP 2

#define

CS_INITIATOR_DEFAULT_MAX_PROCEDURE_DURATION 65535

#define

CS_INITIATOR_DEFAULT_TX_PWR_DELTA 0

#define

CS_INITIATOR_DEFAULT_CONFIG_ID 1

#define

CS_INITIATOR_DEFAULT_MIN_SUBEVENT_LEN 1250

#define

CS_INITIATOR_DEFAULT_MAX_SUBEVENT_LEN 3999999

Enumeration Documentation#

cs_procedure_action_t#

cs_procedure_action_t

Enumerator
CS_PROCEDURE_ACTION_CONTINUE
CS_PROCEDURE_ACTION_TRIGGER_RESET
CS_PROCEDURE_ACTION_TRIGGER_START
CS_PROCEDURE_ACTION_TRIGGER_STOP

Definition at line 109 of file common/cs_initiator/inc/cs_initiator.h

state_machine_event_t#

state_machine_event_t

Enumerator
INITIATOR_EVT_INIT_STARTED
INITIATOR_EVT_INIT_COMPLETED
INITIATOR_EVT_START_PROCEDURE
INITIATOR_EVT_PROCEDURE_ENABLE_STARTING
INITIATOR_EVT_PROCEDURE_ENABLE_COMPLETED
INITIATOR_EVT_PROCEDURE_DISABLE_COMPLETED
INITIATOR_EVT_CS_RESULT
INITIATOR_EVT_CS_RESULT_CONTINUE
INITIATOR_EVT_DELETE_INSTANCE
INITIATOR_EVT_ERROR

Definition at line 147 of file common/cs_initiator/inc/cs_initiator.h

Typedef Documentation#

cs_error_cb_t#

typedef void(* cs_error_cb_t) (uint8_t conn_handle, cs_error_event_t evt, sl_status_t sc) )(uint8_t conn_handle, cs_error_event_t evt, sl_status_t sc)

Parameters

Direction	Argument Name	Description
[in]	conn_handle	connection handle.
[in]	evt	error event.
[in]	sc	status code.

Initiator error callback type Called in case any CS initiator related error occurred.

Definition at line 79 of file common/cs_initiator/inc/cs_initiator.h

cs_result_cb_t#

typedef void(* cs_result_cb_t) (const cs_result_t *result, const sl_rtl_cs_procedure *cs_procedure, const void *user_data) )(const cs_result_t *result, const sl_rtl_cs_procedure *cs_procedure, const void *user_data)

Parameters

Direction	Argument Name	Description
[in]	result	pointer to the result structure.
[in]	cs_procedure	procedure data that the result was calculated from.
[in]	user_data	pointer to additional user data.

Initiator result callback type Called in case a CS procedure extracted successfully and based on the extracted data a distance measurement by the RTL library has been successfully performed.

Definition at line 91 of file common/cs_initiator/inc/cs_initiator.h

cs_intermediate_result_cb_t#

typedef void(* cs_intermediate_result_cb_t) (const cs_intermediate_result_t *result, const void *user_data) )(const cs_intermediate_result_t *result, const void *user_data)

Parameters

Type	Direction	Argument Name	Description
	[in]	result	pointer to the intermediate result structure.
	[in]	user_data	pointer to additional user data.

Initiator intermediate result callback type Called only in case the static object tracking mode is active. That means not in every CS procedure the CS initiator gets a distance measurement. When the measurement is still in progress at the end of a successfully extracted CS procedure this callback will be called instead of the result callback.

Definition at line 106 of file common/cs_initiator/inc/cs_initiator.h

Function Documentation#

cs_initiator_create#

sl_status_t cs_initiator_create (const uint8_t conn_handle, cs_initiator_config_t * initiator_config, const rtl_config_t * rtl_config, cs_result_cb_t result_cb, cs_intermediate_result_cb_t intermediate_result_cb, cs_error_cb_t error_cb, uint8_t * instance_id)

Parameters

Type	Direction	Argument Name	Description
const uint8_t	[in]	conn_handle	connection handle
cs_initiator_config_t *	[in]	initiator_config	pointer to the initiator config
const rtl_config_t *	[in]	rtl_config	pointer to the RTL library config
cs_result_cb_t	[in]	result_cb	callback for result
cs_intermediate_result_cb_t	[in]	intermediate_result_cb	callback for intermediate result
cs_error_cb_t	[in]	error_cb	callback for error
uint8_t *	[out]	instance_id	RTL library instance ID (optional)

Create CS Initiator instance for the given connection handle. Returns

status of the operation.

Definition at line 175 of file common/cs_initiator/inc/cs_initiator.h

cs_initiator_init#

void cs_initiator_init (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

Create and configure initiator instances.

Definition at line 186 of file common/cs_initiator/inc/cs_initiator.h

cs_initiator_delete#

sl_status_t cs_initiator_delete (const uint8_t conn_handle)

Parameters

Type	Direction	Argument Name	Description
const uint8_t	[in]	conn_handle	connection handle

Delete CS Initiator instance associated with the given connection handle. Returns

status of the operation.

Definition at line 194 of file common/cs_initiator/inc/cs_initiator.h

cs_initiator_deinit#

void cs_initiator_deinit (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

Deinitialization function of CS Initiator component.

Definition at line 199 of file common/cs_initiator/inc/cs_initiator.h

cs_initiator_on_event#

bool cs_initiator_on_event (sl_bt_msg_t * evt)

Parameters

Type	Direction	Argument Name	Description
sl_bt_msg_t *	[in]	evt	Event coming from the Bluetooth stack.

Bluetooth stack event handler of the initiator events. Returns

true to send the event to the host in NCP case.

Definition at line 209 of file common/cs_initiator/inc/cs_initiator.h