nrf_modem_rs_capture_session_start()

int32_t nrf_modem_rs_capture_session_start	(	const struct nrf_modem_rs_capture_session_start_req *	req,
		struct nrf_modem_rs_capture_session_start_resp *	resp,
		nrf_modem_rs_capture_event_handler_type_t	callback )

#include <nrf_modem/include/nrf_modem_rs_capture.h>

Starts RS capture session.

This function prepares RS capture sampling session but the actual sampling is not started until nrf_modem_rs_capture_prs_configure function is called. An event handler is also given to this function to receive the samples.

Note

The event handler is executed in interrupt context so a lot of processing inside the handler may have performance implications and side effects. It's recommended to use the handler only for signaling or re-scheduling processing to a separate thread.

Parameters

[in]	req	Session start request parameters.
[out]	resp	Session start response parameters if 0 is returned.
[in]	callback	Event handler function.

Return values

0	on success.
-NRF_EBUSY	Another RS capture session is ongoing.
-NRF_EPERM	The Modem library is not initialized.
-NRF_EBADMSG	The modem responded with wrong response.
-NRF_EFAULT	Input parameter is NULL.
-NRF_ENOMEM	There is not enough shared memory for this request.
-NRF_ESHUTDOWN	The modem was shut down.
NRF_MODEM_RS_CAPTURE_STATUS_NO_CELL	Cell not found.
NRF_MODEM_RS_CAPTURE_STATUS_BUSY	Resources not available or session already started.
NRF_MODEM_RS_CAPTURE_STATUS_NOT_SUPPORTED	Capture not supported in current LTE system.
NRF_MODEM_RS_CAPTURE_STATUS_TIMEOUT	Timeout.
NRF_MODEM_RS_CAPTURE_STATUS_STOPPED	Stop requested during start.