nrf_cloud_location.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_CLOUD_LOCATION_H_
#define NRF_CLOUD_LOCATION_H_
 
#include <zephyr/kernel.h>
#include <zephyr/sys/slist.h>
#include <modem/lte_lc.h>
#include <net/nrf_cloud.h>
#include <net/wifi_location_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF_CLOUD_LOCATION_WIFI_OMIT_RSSI       (INT8_MAX)
#define NRF_CLOUD_LOCATION_WIFI_OMIT_CHAN       (0)
 
#define NRF_CLOUD_LOCATION_WIFI_AP_CNT_MIN 2
 
#define NRF_CLOUD_LOCATION_ANCHOR_NAME_MAX 32
 
enum nrf_cloud_location_type {
        LOCATION_TYPE_SINGLE_CELL,
        LOCATION_TYPE_MULTI_CELL,
        LOCATION_TYPE_WIFI,
 
        LOCATION_TYPE__INVALID
};
 
struct nrf_cloud_anchor_list_node {
        sys_snode_t node;
        char name[];
};
 
#define NRF_CLOUD_ANCHOR_LIST_BUF_MIN_SZ        (sizeof(struct nrf_cloud_anchor_list_node) + \
                                                 NRF_CLOUD_LOCATION_ANCHOR_NAME_MAX + 1)
 
struct nrf_cloud_location_result {
        enum nrf_cloud_location_type type;
        double lat;
        double lon;
        uint32_t unc;
        enum nrf_cloud_error err;
 
        uint32_t anchor_cnt;
 
        sys_slist_t anchor_list;
 
        char *anchor_buf;
 
        size_t anchor_buf_sz;
};
 
struct nrf_cloud_location_config {
        bool do_reply;
        bool hi_conf;
        bool fallback;
};
 
#define NRF_CLOUD_LOCATION_CELL_OMIT_TIME_ADV   LTE_LC_CELL_TIMING_ADVANCE_INVALID
#define NRF_CLOUD_LOCATION_CELL_OMIT_RSRQ       LTE_LC_CELL_RSRQ_INVALID
#define NRF_CLOUD_LOCATION_CELL_OMIT_RSRP       LTE_LC_CELL_RSRP_INVALID
#define NRF_CLOUD_LOCATION_CELL_OMIT_EARFCN     UINT32_MAX
 
#define NRF_CLOUD_LOCATION_CELL_TIME_ADV_MAX    LTE_LC_CELL_TIMING_ADVANCE_MAX
 
#if defined(CONFIG_NRF_CLOUD_MQTT)
typedef void (*nrf_cloud_location_response_t)(const struct nrf_cloud_location_result *const pos);
 
int nrf_cloud_location_request(const struct lte_lc_cells_info *const cells_inf,
                               const struct wifi_scan_info *const wifi_inf,
                               const struct nrf_cloud_location_config *const config,
                               nrf_cloud_location_response_t cb);
#endif /* CONFIG_NRF_CLOUD_MQTT */
 
int nrf_cloud_location_process(const char *buf, struct nrf_cloud_location_result *result);
 
int nrf_cloud_location_scell_data_get(struct lte_lc_cell *const cell_inf);
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_CLOUD_LOCATION_H_ */