Utility Functionality#

sl_rtl_util_parameter#

sl_rtl_util_parameter

Util parameter.

sl_rtl_util_libitem#

typedef void* sl_rtl_util_libitem

Utility library item.

sl_rtl_util_init#

enum sl_rtl_error_code sl_rtl_util_init (sl_rtl_util_libitem * item)

Initialize the Util libitem instance.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_deinit#

enum sl_rtl_error_code sl_rtl_util_deinit (sl_rtl_util_libitem * item)

Deinitialize a Util libitem instance.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_set_parameter#

enum sl_rtl_error_code sl_rtl_util_set_parameter (sl_rtl_util_libitem * item, enum sl_rtl_util_parameter parameter, float value)

Set util parameters.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_filter#

enum sl_rtl_error_code sl_rtl_util_filter (sl_rtl_util_libitem * item, float value_in, float * value_out)

Filter a value using the moving average.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_rssi2distance#

enum sl_rtl_error_code sl_rtl_util_rssi2distance (float tx_power, float rssi, float * distance_out)

Convert an RSSI-value to distance in meters.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_setup#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_setup (sl_rtl_util_libitem * item, uint32_t level, uint32_t num_antennas, bool raw_samples)

Set up the IQ sample quality analysis.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_set_parameters#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_set_parameters (sl_rtl_util_libitem * item, uint32_t sample_rate, uint8_t sample_offset, uint8_t samples_in_slot, uint8_t number_of_channels)

Set up parameters for the IQ sample quality analysis.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_set_downsampling_factor#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_set_downsampling_factor (sl_rtl_util_libitem * item, float dsf)

Set up IQ sample QA downsampling ratio.

Set the downsampling factor used during the antenna samples (related to the sampling rate of the reference period)

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_set_data_offset#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_set_data_offset (sl_rtl_util_libitem * item, uint32_t offset)

Set data samples offset.

Set the offset for the data samples from the start of the reference period. The use of this function is optional and, if not given, the default values are used.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_set_switch_pattern#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_set_switch_pattern (sl_rtl_util_libitem * item, uint32_t size, uint32_t * pattern)

Set the switch pattern for the IQ sample quality.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_add_reference#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_add_reference (sl_rtl_util_libitem * item, uint32_t num_samples, float * i_samples, float * q_samples)

Feed the IQ sample quality analysis the reference period data.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_add_data#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_add_data (sl_rtl_util_libitem * item, uint32_t num_snapshots, float ** i_samples, float ** q_samples, uint8_t channel)

Feed the IQ sample quality analysis the antenna data.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_get_results#

uint32_t sl_rtl_util_iq_sample_qa_get_results (sl_rtl_util_libitem * item)

Get the overall results of the IQ sample quality analysis.

Returns

• Bitmask of the failing tests, zero if everything passed

sl_rtl_util_iq_sample_qa_get_details#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_get_details (sl_rtl_util_libitem * item, sl_rtl_clib_iq_sample_qa_dataset_t * iq_sample_qa_results, sl_rtl_clib_iq_sample_qa_antenna_data_t * antenna_data)

Get the detailed results of the IQ sample quality analysis.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_get_channel_details#

enum sl_rtl_error_code sl_rtl_util_iq_sample_qa_get_channel_details (sl_rtl_util_libitem * item, uint8_t channel, sl_rtl_clib_iq_sample_qa_dataset_t * iq_sample_qa_results, sl_rtl_clib_iq_sample_qa_antenna_data_t * antenna_data)

Get the detailed results of the IQ sample quality analysis for the specified radio channel.

Returns

• SL_RTL_ERROR_SUCCESS if successful

sl_rtl_util_iq_sample_qa_code2string#

char * sl_rtl_util_iq_sample_qa_code2string (char * buf, int size, uint32_t code)

Write the IQ sample quality analysis code as human readable strings in the provided buffer.

Returns

• pointer to the buffer containing data, or to a constant string