Channel Sounding (CS)#

sl_rtl_cs_role#

sl_rtl_cs_role

sl_rtl_cs_algo_mode#

sl_rtl_cs_algo_mode

sl_rtl_cs_mode#

sl_rtl_cs_mode

sl_rtl_cs_rtt_type#

sl_rtl_cs_rtt_type

sl_rtl_cs_estimator_param_type#

sl_rtl_cs_estimator_param_type

sl_rtl_cs_distance_estimate_type#

sl_rtl_cs_distance_estimate_type

sl_rtl_cs_distance_estimate_confidence_type#

sl_rtl_cs_distance_estimate_confidence_type

sl_rtl_cs_distance_estimate_extended_info_type#

sl_rtl_cs_distance_estimate_extended_info_type

sl_rtl_cs_libitem#

typedef void* sl_rtl_cs_libitem

CS library item.

typedef#

typedef (struct { uint8_t channel_map[SL_RTL_CS_CHANNEL_MAP_SIZE];} )

typedef#

typedef (struct { uint8_t num_antenna_paths;uint8_t channel_map_repetition;uint32_t main_mode_repetition;uint8_t num_calib_steps;uint8_t T_PM_time;uint8_t T_IP1_time;uint8_t T_IP2_time;uint8_t T_FCS_time;uint8_t channel_selection_type;uint8_t ch3c_shape;uint8_t ch3c_jump;uint32_t subevent_len;uint8_t subevents_per_event;uint16_t subevent_interval;uint16_t event_interval;uint16_t procedure_interval;uint16_t procedure_count;uint8_t cs_sync_phy;sl_rtl_cs_rtt_type rtt_type :8;uint16_t acl_connection_interval;} )

typedef#

typedef (union { float last_known_distance;float range_min;float range_max;float ref_tx_power;} )

typedef#

typedef (struct { sl_rtl_cs_estimator_param_type type :8;sl_rtl_cs_estimator_param_value value;} )

typedef#

typedef (struct { uint8_t packet_quality;uint8_t packet_rssi;uint8_t packet_antenna;int16_t measured_freq_offset;} )

typedef#

typedef (struct { uint8_t packet_quality;uint8_t packet_nadm;int8_t packet_rssi;int16_t packet_rtt;uint8_t packet_antenna;} )

typedef#

typedef (struct tone { int32_t pct_i :SL_RTL_CS_PCT_IQ_BIT_LEN;int32_t pct_q :SL_RTL_CS_PCT_IQ_BIT_LEN;uint8_t quality_indicator;} )

typedef#

typedef (struct { uint8_t antenna_permutation_index;sl_rtl_cs_pbr_tone tones[];} )

typedef#

typedef (struct { sl_rtl_cs_mode step_mode :SL_RTL_CS_STEP_MODE_BIT_LEN;uint8_t step_channel;uint8_t step_data_length;1(union { sl_rtl_cs_mode_calib_data mode_calib_step;sl_rtl_cs_mode_rtt_data mode_rtt_step;sl_rtl_cs_mode_pbr_data mode_pbr_step;});} )

typedef#

typedef (struct { uint64_t subevent_timestamp_ms;int16_t frequency_compensation;int8_t reference_power_level;uint8_t num_steps;uint16_t step_data_count;uint8_t *step_data;} )

typedef#

typedef (struct { sl_rtl_cs_config cs_config;uint8_t initiator_subevent_data_count;sl_rtl_cs_subevent_data *initiator_subevent_data;uint8_t reflector_subevent_data_count;sl_rtl_cs_subevent_data *reflector_subevent_data;} )

typedef#

typedef (struct { struct timespec timestamp;uint64_t timestamp_ms;} )

sl_rtl_cs_init#

enum sl_rtl_error_code sl_rtl_cs_init (sl_rtl_cs_libitem * item)

Initialize the CS libitem instance.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_cs_deinit#

enum sl_rtl_error_code sl_rtl_cs_deinit (sl_rtl_cs_libitem * item)

Deinitialize a libitem instance of the CS estimator.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_cs_set_algo_mode#

enum sl_rtl_error_code sl_rtl_cs_set_algo_mode (sl_rtl_cs_libitem * item, const sl_rtl_cs_algo_mode mode)

Set the estimation algorithm mode.

Returns

• SL_RTL_ERROR_SUCCESS if successful

Set the estimation mode. For example, SL_RTL_CS_ALGO_MODE_REAL_TIME_BASIC sets medium filtering. For further description of the modes, see the documentation of::sl_rtl_cs_algo_mode. CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called before estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_ALREADY_CREATED.

sl_rtl_cs_set_cs_mode#

enum sl_rtl_error_code sl_rtl_cs_set_cs_mode (sl_rtl_cs_libitem * item, const sl_rtl_cs_mode cs_mode)

Set the estimation CS mode.

Returns

• SL_RTL_ERROR_SUCCESS if successful

Set the desired cs_mode. For example, SL_RTL_CS_MODE_PBR uses round-trip phase based cs_mode. CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called before estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_ALREADY_CREATED.

sl_rtl_cs_set_cs_params#

enum sl_rtl_error_code sl_rtl_cs_set_cs_params (sl_rtl_cs_libitem * item, const sl_rtl_cs_params * parameters)

Set the estimation CS parameters.

Returns

• SL_RTL_ERROR_SUCCESS if successful

Set the parameters for the estimator. CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called before estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_ALREADY_CREATED.

sl_rtl_cs_create_estimator#

enum sl_rtl_error_code sl_rtl_cs_create_estimator (sl_rtl_cs_libitem * item)

Create an estimator with the given parameters after initializing the libitem.

Returns

• SL_RTL_ERROR_SUCCESS if successful

CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called before estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_ALREADY_CREATED.

sl_rtl_cs_set_estimator_param#

enum sl_rtl_error_code sl_rtl_cs_set_estimator_param (sl_rtl_cs_libitem * item, const sl_rtl_cs_estimator_param * param)

Set CS algorithm parameters. The function can be called any time before or during the processing calls.

Returns

• SL_RTL_ERROR_SUCCESS if successful

CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called after estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_NOT_CREATED.

sl_rtl_cs_process#

enum sl_rtl_error_code sl_rtl_cs_process (sl_rtl_cs_libitem * item, const uint8_t procedure_count, const sl_rtl_cs_procedure * procedure_data)

Calculate distance estimate based on CS procedures.

Returns

• SL_RTL_ERROR_SUCCESS if successful and SL_RTL_ERROR_ESTIMATION_IN_PROGRESS if estimate is not yet final and more input data needs to be processed.

Calculate the distance estimate from the given procedure data. The function can be called with multiple procedures. Use sl_rtl_cs_get_distance to fetch the latest distance estimate. CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called after estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_NOT_CREATED.

sl_rtl_cs_get_distance_estimate#

enum sl_rtl_error_code sl_rtl_cs_get_distance_estimate (sl_rtl_cs_libitem * item, const sl_rtl_cs_distance_estimate_type estimate_type, float * distance)

Get distance estimate

Returns

• SL_RTL_ERROR_SUCCESS if successful

CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called after estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_NOT_CREATED.

sl_rtl_cs_get_distance_estimate_confidence#

enum sl_rtl_error_code sl_rtl_cs_get_distance_estimate_confidence (sl_rtl_cs_libitem * item, const sl_rtl_cs_distance_estimate_confidence_type confidence_type, float * confidence)

Get distance estimate confidence.

Returns

• SL_RTL_ERROR_SUCCESS if successful

CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called after estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_NOT_CREATED.

sl_rtl_cs_get_distance_estimate_extended_info#

enum sl_rtl_error_code sl_rtl_cs_get_distance_estimate_extended_info (sl_rtl_cs_libitem * item, const sl_rtl_cs_distance_estimate_extended_info_type extended_info_type, float * extended_info)

Get distance estimate extended information.

Returns

• SL_RTL_ERROR_SUCCESS if successful

CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED. This method should be called after estimator is created for CS libitem, or it will fail with error code SL_RTL_ERROR_ESTIMATOR_NOT_CREATED.

sl_rtl_cs_log_enable#

enum sl_rtl_error_code sl_rtl_cs_log_enable (sl_rtl_cs_libitem * item, const sl_rtl_cs_log_params * log_params)

Enable logging for the given CS libitem.

Returns

• SL_RTL_ERROR_SUCCESS if successful

CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED.

sl_rtl_cs_log_disable#

enum sl_rtl_error_code sl_rtl_cs_log_disable (sl_rtl_cs_libitem * item)

Disable logging for the given CS libitem.

Returns

• SL_RTL_ERROR_SUCCESS if successful

CS libitem must be initialized before calling this method, or it will fail with return code SL_RTL_ERROR_NOT_INITIALIZED.

sl_rtl_cs_log_get_instance_id#

enum sl_rtl_error_code sl_rtl_cs_log_get_instance_id (sl_rtl_cs_libitem * item, uint8_t * instance_id)

Get the instance ID of the given CS libitem.

Returns

• SL_RTL_ERROR_SUCCESS if successful

SL_RTL_CS_PCT_IQ_BIT_LEN#

#define SL_RTL_CS_PCT_IQ_BIT_LEN

12

Number of bits used for indicating I or Q sample in the phase correction term (PCT) in CS step data.

SL_RTL_CS_STEP_MODE_BIT_LEN#

#define SL_RTL_CS_STEP_MODE_BIT_LEN

8

Number of bits used for indicating step mode in CS step data.

SL_RTL_CS_CHANNEL_MAP_SIZE#

#define SL_RTL_CS_CHANNEL_MAP_SIZE

10

Size of the channel map in bytes.