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_mode#

sl_rtl_cs_distance_estimate_mode

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_distance_estimate_confidence_mode#

typedef sl_rtl_cs_distance_estimate_mode sl_rtl_cs_distance_estimate_confidence_mode

sl_rtl_cs_libitem#

typedef void* sl_rtl_cs_libitem

CS library item.

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 main_mode, const sl_rtl_cs_mode sub_mode)

Set the estimation CS mode.

Returns

• SL_RTL_ERROR_SUCCESS if successful

Set the desired CS mode for main and sub modes. For example, SL_RTL_CS_MODE_PBR uses round-trip phase based cs_mode. Sub mode should be set to SL_RTL_CS_MODE_NONE if only main mode is enabled in CS ranging. 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 num_procedures, 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, const sl_rtl_cs_distance_estimate_mode estimate_mode, 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, const sl_rtl_cs_distance_estimate_confidence_mode confidence_mode, 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)

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. 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_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. 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_log_add_timestamp#

enum sl_rtl_error_code sl_rtl_cs_log_add_timestamp (sl_rtl_cs_libitem * item, const struct timespec timestamp)

Add epoch time to RTL logging data. This function logs a timestamp entry to enhance the logging data. The timestamp should be recorded at the time of receiving the first subevent from the radio. If measurements are stopped and restarted, this function must be invoked again to log a new timestamp.

Returns

• SL_RTL_ERROR_SUCCESS if successful

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