LwM2M client utilities location

API for the LwM2M based LOCATION. More...

Macros
#define	LOCATION_ASSIST_NEEDS_UTC   BIT(0)
#define	LOCATION_ASSIST_NEEDS_EPHEMERIES   BIT(1)
#define	LOCATION_ASSIST_NEEDS_ALMANAC   BIT(2)
#define	LOCATION_ASSIST_NEEDS_KLOBUCHAR   BIT(3)
#define	LOCATION_ASSIST_NEEDS_NEQUICK   BIT(4)
#define	LOCATION_ASSIST_NEEDS_TOW   BIT(5)
#define	LOCATION_ASSIST_NEEDS_CLOCK   BIT(6)
#define	LOCATION_ASSIST_NEEDS_LOCATION   BIT(7)
#define	LOCATION_ASSIST_NEEDS_INTEGRITY   BIT(8)
#define	LOCATION_ASSIST_RESULT_CODE_OK   0
#define	LOCATION_ASSIST_RESULT_CODE_PERMANENT_ERR   -1
#define	LOCATION_ASSIST_RESULT_CODE_TEMP_ERR   1
#define	LOCATION_ASSIST_RESULT_CODE_NO_RESP_ERR   2
#define	GNSS_ASSIST_OBJECT_ID   33625
#define	GROUND_FIX_OBJECT_ID   33626
#define	VISIBLE_WIFI_AP_OBJECT_ID   33627
#define	ECID_SIGNAL_MEASUREMENT_INFO_OBJECT_ID   10256

Typedefs
typedef void(*	location_assistance_result_code_cb_t) (uint16_t object_id, int32_t result_code)
	Callback for location assistance result.

Functions
void	location_assistance_set_result_code_cb (location_assistance_result_code_cb_t cb)
	Set the location assistance result code callback.
int	location_assistance_agnss_set_mask (const struct nrf_modem_gnss_agnss_data_frame *agnss_req)
	Set the A-GNSS request mask.
int	location_assistance_agnss_request_send (struct lwm2m_ctx *ctx)
	Send the A-GNSS assistance request to LwM2M Server.
int	location_assistance_ground_fix_request_send (struct lwm2m_ctx *ctx)
	Send the Ground Fix request to LwM2M Server.
int	location_assistance_pgps_request_send (struct lwm2m_ctx *ctx)
	Send the P-GPS assistance request to LwM2M Server.
void	location_assistance_retry_init (bool enable_resend)
	Initialize the location assistance library resend handler. Handler will handle the result code from server and schedule resending in case of temporary error in server using an exponential backoff.
int	location_event_handler_init (struct lwm2m_ctx *ctx)
	Initialize the location assistance event handler.
void	location_assist_agnss_request_set (uint32_t request_mask)
	Set an A-GNSS assistance request mask for the object.
void	location_assist_agnss_set_elevation_mask (int32_t elevation_mask)
	Set the satellite elevation mask angle above the ground. Satellites below the angle will be filtered in the response.
int32_t	location_assist_agnss_get_elevation_mask (void)
	Get the satellite elevation mask currently stored in the resource.
int	location_assist_pgps_set_prediction_count (int32_t predictions)
	Set prediction count for the P-GPS query.
int	location_assist_pgps_set_prediction_interval (int32_t interval)
	Set prediction interval as minutes for the P-GPS query.
void	location_assist_pgps_set_start_gps_day (int32_t gps_day)
	Set starting GPS day as days since GPS epoch. Setting the day as 0, will use the default value for the request which will be current GPS day.
int32_t	location_assist_pgps_get_start_gps_day (void)
	Get the GPS start day stored currently in the resource.
int	location_assist_pgps_set_start_time (int32_t start_time)
	Set the GPS start time in seconds.
int32_t	location_assist_gnss_get_result_code (void)
	Get the result code of the location request.
void	ground_fix_set_report_back (bool report_back)
	Set if the server should report the location back to the object after it has attained it.
int32_t	ground_fix_get_result_code (void)
	Get the result code of the location request.
int	lwm2m_signal_meas_info_inst_id_to_index (uint16_t obj_inst_id)
int	lwm2m_signal_meas_info_index_to_inst_id (int index)
int	lwm2m_update_signal_meas_objects (const struct lte_lc_cells_info *const cells)
	Update the ECID-Signal Measurement Info objects with the recent neighbor cell data.
int	lwm2m_ncell_handler_register (void)
	Register the handler for the Neighbor cell scanning.
void	lwm2m_ncell_schedule_measurement (void)
int	lwm2m_wifi_request_scan (void)
	Request a Wi-Fi scan for nearby access points.

Detailed Description

API for the LwM2M based LOCATION.