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#
Enumerations#
Typedefs#
Functions#
Macros#
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 |
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 |
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)
[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.
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)
[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.
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)
[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.
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)
[in] | conn_handle | connection handle |
[in] | initiator_config | pointer to the initiator config |
[in] | rtl_config | pointer to the RTL library config |
[in] | result_cb | callback for result |
[in] | intermediate_result_cb | callback for intermediate result |
[in] | error_cb | callback for error |
[out] | instance_id | RTL library instance ID (optional) |
Create CS Initiator instance for the given connection handle. Returns
status of the operation.
175
of file common/cs_initiator/inc/cs_initiator.h
cs_initiator_init#
void cs_initiator_init (void )
N/A |
Create and configure initiator instances.
186
of file common/cs_initiator/inc/cs_initiator.h
cs_initiator_delete#
sl_status_t cs_initiator_delete (const uint8_t conn_handle)
[in] | conn_handle | connection handle |
Delete CS Initiator instance associated with the given connection handle. Returns
status of the operation.
194
of file common/cs_initiator/inc/cs_initiator.h
cs_initiator_deinit#
void cs_initiator_deinit (void )
N/A |
Deinitialization function of CS Initiator component.
199
of file common/cs_initiator/inc/cs_initiator.h
cs_initiator_on_event#
bool cs_initiator_on_event (sl_bt_msg_t * evt)
[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.
209
of file common/cs_initiator/inc/cs_initiator.h
Macro Definition Documentation#
CS_INITIATOR_MAX_CONNECTIONS#
#define CS_INITIATOR_MAX_CONNECTIONSValue:
(1)
49
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_MAX_SUBEVENT_PER_PROC#
#define CS_INITIATOR_MAX_SUBEVENT_PER_PROCValue:
(6)
55
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_MAX_STEP_DATA_LEN#
#define CS_INITIATOR_MAX_STEP_DATA_LENValue:
(2048)
61
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_LOG#
#define CS_INITIATOR_LOGValue:
(1)
68
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_LOG_PREFIX#
#define CS_INITIATOR_LOG_PREFIXValue:
"[Initiator]"
74
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_RTL_LOG#
#define CS_INITIATOR_RTL_LOGValue:
(1)
82
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_CS_EVENT_BUF_SIZE#
#define CS_INITIATOR_CS_EVENT_BUF_SIZEValue:
(16)
89
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MIN_PROCEDURE_INTERVAL#
#define CS_INITIATOR_DEFAULT_MIN_PROCEDURE_INTERVALValue:
(30)
96
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MAX_PROCEDURE_INTERVAL#
#define CS_INITIATOR_DEFAULT_MAX_PROCEDURE_INTERVALValue:
(30)
103
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_ANTENNA_OFFSET#
#define CS_INITIATOR_ANTENNA_OFFSETValue:
0
111
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_ERROR_TIMEOUT_MS#
#define CS_INITIATOR_ERROR_TIMEOUT_MSValue:
3000
119
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_PROCEDURE_TIMEOUT_MS#
#define CS_INITIATOR_PROCEDURE_TIMEOUT_MSValue:
3000
126
of file common/cs_initiator/config/cs_initiator_config.h
CS_CUSTOM_CHANNEL_MAP#
#define CS_CUSTOM_CHANNEL_MAPValue:
{ 0xFC, 0xFF, 0x7F, 0xFC, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x1F }
130
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CS_MODE#
#define CS_INITIATOR_DEFAULT_CS_MODEValue:
2
135
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MIN_CONNECTION_INTERVAL#
#define CS_INITIATOR_DEFAULT_MIN_CONNECTION_INTERVALValue:
6
139
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MAX_CONNECTION_INTERVAL#
#define CS_INITIATOR_DEFAULT_MAX_CONNECTION_INTERVALValue:
6
143
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MAX_PROCEDURE_COUNT#
#define CS_INITIATOR_DEFAULT_MAX_PROCEDURE_COUNTValue:
1
149
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CONN_PHY#
#define CS_INITIATOR_DEFAULT_CONN_PHYValue:
sl_bt_gap_phy_2m
155
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CS_SYNC_PHY#
#define CS_INITIATOR_DEFAULT_CS_SYNC_PHYValue:
sl_bt_gap_phy_1m
161
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MODE0_STEPS#
#define CS_INITIATOR_DEFAULT_MODE0_STEPSValue:
3
166
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CS_TONE_ANTENNA_CONFIG_IDX_REQ#
#define CS_INITIATOR_DEFAULT_CS_TONE_ANTENNA_CONFIG_IDX_REQValue:
CS_ANTENNA_CONFIG_INDEX_DUAL_ONLY
183
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CS_SYNC_ANTENNA_REQ#
#define CS_INITIATOR_DEFAULT_CS_SYNC_ANTENNA_REQValue:
CS_SYNC_SWITCHING
191
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_PREFERRED_PEER_ANTENNA#
#define CS_INITIATOR_DEFAULT_PREFERRED_PEER_ANTENNAValue:
1
197
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MAX_TX_POWER#
#define CS_INITIATOR_DEFAULT_MAX_TX_POWERValue:
20
201
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CREATE_CONTEXT#
#define CS_INITIATOR_DEFAULT_CREATE_CONTEXTValue:
1
209
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_RSSI_REF_TX_POWER#
#define CS_INITIATOR_DEFAULT_RSSI_REF_TX_POWERValue:
-40.0F
214
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CONNECTION_PERIPHERAL_LATENCY#
#define CS_INITIATOR_DEFAULT_CONNECTION_PERIPHERAL_LATENCYValue:
0
220
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_TIMEOUT#
#define CS_INITIATOR_DEFAULT_TIMEOUTValue:
200
224
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MIN_CE_LENGTH#
#define CS_INITIATOR_DEFAULT_MIN_CE_LENGTHValue:
0
229
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MAX_CE_LENGTH#
#define CS_INITIATOR_DEFAULT_MAX_CE_LENGTHValue:
65535
234
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CHANNEL_SELECTION_TYPE#
#define CS_INITIATOR_DEFAULT_CHANNEL_SELECTION_TYPEValue:
sl_bt_cs_channel_selection_algorithm_3b
241
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CH3C_SHAPE#
#define CS_INITIATOR_DEFAULT_CH3C_SHAPEValue:
sl_bt_cs_ch3c_shape_hat
247
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_ALGO_MODE#
#define CS_INITIATOR_DEFAULT_ALGO_MODEValue:
SL_RTL_CS_ALGO_MODE_REAL_TIME_BASIC
253
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CHANNEL_MAP_PRESET#
#define CS_INITIATOR_DEFAULT_CHANNEL_MAP_PRESETValue:
CS_CHANNEL_MAP_PRESET_HIGH
261
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CH3C_JUMP#
#define CS_INITIATOR_DEFAULT_CH3C_JUMPValue:
2
270
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MAX_PROCEDURE_DURATION#
#define CS_INITIATOR_DEFAULT_MAX_PROCEDURE_DURATIONValue:
65535
276
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_TX_PWR_DELTA#
#define CS_INITIATOR_DEFAULT_TX_PWR_DELTAValue:
0
280
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_CONFIG_ID#
#define CS_INITIATOR_DEFAULT_CONFIG_IDValue:
1
285
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MIN_SUBEVENT_LEN#
#define CS_INITIATOR_DEFAULT_MIN_SUBEVENT_LENValue:
1250
290
of file common/cs_initiator/config/cs_initiator_config.h
CS_INITIATOR_DEFAULT_MAX_SUBEVENT_LEN#
#define CS_INITIATOR_DEFAULT_MAX_SUBEVENT_LENValue:
3999999
295
of file common/cs_initiator/config/cs_initiator_config.h