RTL API for Ranging Service (RAS)#

RTL API for Ranging Service (RAS)

This is a supplementary RAS API wrapper for the Channel Sounding (CS) API. The RAS API provides a method to calculate distance and confidence estimates based on RAS format data. Please refer to the CS API for initialization and configuration of the CS libitem.

Modules#

sl_rtl_ras_ranging_data_header

sl_rtl_ras_subevent_header

sl_rtl_ras_subevent

sl_rtl_ras_ranging_data_body

sl_rtl_ras_additional_info

sl_rtl_ras_measurement

sl_rtl_cs_measurement

sl_rtl_ras_procedure

sl_rtl_ras_procedure.__unnamed3__

sl_rtl_ras_procedure.__unnamed5__

Functions#

sl_rtl_ras_process(sl_rtl_cs_libitem *item, const uint8_t num_procedures, const sl_rtl_ras_procedure *procedure_data)

Macros#

#define
SL_RTL_RAS 0

RAS subevent type.

#define
SL_RTL_CS 1

CS subevent type.

Typedef Documentation#

sl_rtl_cs_subevent#

typedef sl_rtl_cs_subevent_data sl_rtl_cs_subevent

sl_rtl_ras_measurement_type#

typedef uint8_t sl_rtl_ras_measurement_type

Function Documentation#

sl_rtl_ras_process#

enum sl_rtl_error_code sl_rtl_ras_process (sl_rtl_cs_libitem * item, const uint8_t num_procedures, const sl_rtl_ras_procedure * procedure_data)
Parameters
TypeDirectionArgument NameDescription
sl_rtl_cs_libitem *[in]item

Pointer to the initialized and configured CS libitem

const uint8_t[in]num_procedures

Number of procedures in the procedure_data array

const sl_rtl_ras_procedure *[in]procedure_data

Data structure with the completed RAS procedures

Process RAS procedures to calculate distance estimate.

Returns

Calculate the distance estimate from the given procedure data. 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.