lib: location: Remove support for HERE location services

Removed support for HERE location services.

Signed-off-by: Tommi Kangas <[email protected]>

Author: tokangas

doc/nrf/libraries/modem/location.rst

@@ -382,12 +382,10 @@ This library uses the following |NCS| libraries:
 
 * :ref:`nrf_modem_lib_readme`
 * :ref:`lte_lc_readme`
-* :ref:`lib_rest_client`
 * :ref:`lib_nrf_cloud`
 * :ref:`lib_nrf_cloud_agnss`
 * :ref:`lib_nrf_cloud_pgps`
 * :ref:`lib_nrf_cloud_rest`
-* :ref:`lib_modem_jwt`
 
 It uses the following `sdk-nrfxlib`_ library:
 

doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst

@@ -118,6 +118,19 @@ nRF Cloud library
    * You must set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option to access the nRF Cloud libraries.
      This option is now disabled by default to prevent the unintended inclusion of nRF Cloud Kconfig variables in non-nRF Cloud projects, addressing a previous issue.
 
+Location library
+----------------
+
+.. toggle::
+
+   For applications and samples using the :ref:`lib_location` library:
+
+   * Support for HERE location services and the :kconfig:option:`CONFIG_LOCATION_SERVICE_HERE` Kconfig option has been removed.
+     To use external location services, enable the :kconfig:option:`CONFIG_LOCATION_SERVICE_EXTERNAL` option and implement the required APIs.
+
+   * The ``service`` parameter in :c:struct:`location_cellular_config` and :c:struct:`location_wifi_config` has been removed.
+     The library supports only one location service, so the ``service`` parameter is no longer needed.
+
 .. _migration_3.0_recommended:
 
 Recommended changes

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -953,7 +953,7 @@ Modem libraries
 
 * :ref:`lib_location` library:
 
-  * Removed references to HERE location services.
+  * Removed support for HERE location services.
 
 * :ref:`lib_at_host` library:
 

include/modem/location.h

@@ -142,21 +142,6 @@ enum location_accuracy {
 	LOCATION_ACCURACY_HIGH,
 };
 
-/** Location service. */
-enum location_service {
-	/**
-	 * Use any location service that has been configured to be available.
-	 *
-	 * This is useful when only one service is configured but can also be used
-	 * even if several services are available.
-	 */
-	LOCATION_SERVICE_ANY,
-	/** nRF Cloud location service. */
-	LOCATION_SERVICE_NRF_CLOUD,
-	/** HERE location service. */
-	LOCATION_SERVICE_HERE
-};
-
 /** Date and time (UTC). */
 struct location_datetime {
 	/** True if date and time are valid, false if not. */
@@ -466,16 +451,6 @@ struct location_cellular_config {
 	 */
 	int32_t timeout;
 
-	/**
-	 * @brief Used cellular positioning service.
-	 *
-	 * @details Default value is @ref LOCATION_SERVICE_ANY. It is applied when
-	 * location_config_defaults_set() function is called.
-	 *
-	 * This parameter is ignored when @kconfig{CONFIG_LOCATION_SERVICE_EXTERNAL} is enabled.
-	 */
-	enum location_service service;
-
 	/**
 	 * @brief Number of cells to be requested for cellular positioning.
 	 *
@@ -519,16 +494,6 @@ struct location_wifi_config {
 	 * @ref location_config structure is still valid.
 	 */
 	int32_t timeout;
-
-	/**
-	 * @brief Used Wi-Fi positioning service.
-	 *
-	 * @details Default value is @ref LOCATION_SERVICE_ANY. It is applied when
-	 * location_config_defaults_set() function is called.
-	 *
-	 * This parameter is ignored when @kconfig{CONFIG_LOCATION_SERVICE_EXTERNAL} is enabled.
-	 */
-	enum location_service service;
 };
 
 /** Location method configuration. */
@@ -560,7 +525,6 @@ struct location_config {
 	 * these methods are handled together, if the following conditions are met:
 	 *   - Methods are one after the other in location request method list
 	 *   - @ref mode is @ref LOCATION_REQ_MODE_FALLBACK
-	 *   - Requested cloud service for Wi-Fi and cellular is the same
 	 */
 	struct location_method_config methods[CONFIG_LOCATION_METHODS_LIST_SIZE];
 

lib/location/CMakeLists.txt

@@ -17,7 +17,7 @@ endif()
 
 if(CONFIG_LOCATION_METHOD_CELLULAR OR CONFIG_LOCATION_METHOD_WIFI)
 zephyr_library_sources(method_cloud_location.c)
-add_subdirectory(cloud_service)
+zephyr_library_sources_ifdef(CONFIG_LOCATION_SERVICE_NRF_CLOUD cloud_service.c)
 endif()
 
 zephyr_library_compile_definitions(_POSIX_C_SOURCE=200809L)

lib/location/Kconfig

@@ -117,17 +117,10 @@ if LOCATION_METHOD_CELLULAR || LOCATION_METHOD_WIFI
 
 config LOCATION_SERVICE_CLOUD_RECV_BUF_SIZE
 	int "Receive buffer size"
-	default 1024 if LOCATION_SERVICE_HERE
 	default 512
 	help
 	  Size of the buffer used to store the response from the location service.
 
-config LOCATION_SERVICE_HERE
-	bool "HERE location service"
-	select CJSON_LIB
-	help
-	  Use HERE location service.
-
 config LOCATION_SERVICE_NRF_CLOUD
 	bool "nRF Cloud location service"
 	default y if !LOCATION_SERVICE_EXTERNAL
@@ -137,47 +130,6 @@ config LOCATION_SERVICE_NRF_CLOUD
 	help
 	  Use nRF Cloud location service.
 
-if LOCATION_SERVICE_HERE
-
-config LOCATION_REST_CLIENT
-	bool
-	default y
-	select REST_CLIENT
-	help
-	  Use the REST client library for cellular service. This is
-	  separated here from other dependencies to allow disabling of
-	  REST client library in tests for mocking purposes.
-
-config LOCATION_MODEM_KEY_MGMT
-	bool
-	default y
-	select MODEM_KEY_MGMT
-	help
-	  Use the Modem key management library for cellular service. This is
-	  separated here from other dependencies to allow disabling of
-	  Modem key management library in tests for mocking purposes.
-
-config LOCATION_SERVICE_HERE_API_KEY
-	string "HERE API key"
-	help
-	  HERE API key used for authentication.
-
-config LOCATION_SERVICE_HERE_HOSTNAME
-	string "Server hostname for HERE"
-	default "positioning.hereapi.com"
-	help
-	  Server hostname to use when connecting to the HERE location service.
-
-config LOCATION_SERVICE_HERE_TLS_SEC_TAG
-	int "Security tag for HERE TLS certificates"
-	default 175
-	help
-	  Security tag where the required TLS certificates for the HERE location
-	  service are stored. This sec tag will also be used to provision CA
-	  certificates.
-
-endif # LOCATION_SERVICE_HERE
-
 endif # LOCATION_METHOD_CELLULAR || LOCATION_METHOD_WIFI
 
 config LOCATION_SERVICE_EXTERNAL

lib/location/cloud_service/cloud_service_nrf.c renamed to lib/location/cloud_service.c

@@ -26,40 +26,41 @@ BUILD_ASSERT(
 	"CONFIG_NRF_CLOUD_MQTT, CONFIG_NRF_CLOUD_REST or CONFIG_NRF_CLOUD_COAP transport "
 	"must be enabled");
 
+static char recv_buf[CONFIG_LOCATION_SERVICE_CLOUD_RECV_BUF_SIZE];
 
 #if defined(CONFIG_NRF_CLOUD_MQTT)
 /* Verify that LOCATION is enabled if MQTT is enabled */
 BUILD_ASSERT(
 	IS_ENABLED(CONFIG_NRF_CLOUD_LOCATION),
 	"If CONFIG_NRF_CLOUD_MQTT is enabled also CONFIG_NRF_CLOUD_LOCATION must be enabled");
 
-static struct location_data nrf_cloud_location;
-static K_SEM_DEFINE(nrf_location_ready, 0, 1);
+static struct location_data cloud_location;
+static K_SEM_DEFINE(location_ready, 0, 1);
 #endif
 
 #if defined(CONFIG_NRF_CLOUD_MQTT)
-static void cloud_service_nrf_location_ready_cb(
+static void cloud_service_location_ready_cb(
 	const struct nrf_cloud_location_result *const result)
 {
 	if ((result != NULL) && (result->err == NRF_CLOUD_ERROR_NONE)) {
-		nrf_cloud_location.latitude = result->lat;
-		nrf_cloud_location.longitude = result->lon;
-		nrf_cloud_location.accuracy = (double)result->unc;
+		cloud_location.latitude = result->lat;
+		cloud_location.longitude = result->lon;
+		cloud_location.accuracy = (double)result->unc;
 
-		k_sem_give(&nrf_location_ready);
+		k_sem_give(&location_ready);
 	} else {
 		if (result) {
 			LOG_ERR("Unable to determine location from cloud service, error: %d",
 				result->err);
 		}
-		/* Reset the semaphore to unblock cloud_service_nrf_pos_get()
+		/* Reset the semaphore to unblock cloud_service_pos_get()
 		 * and make it return an error.
 		 */
-		k_sem_reset(&nrf_location_ready);
+		k_sem_reset(&location_ready);
 	}
 }
 
-int cloud_service_nrf_pos_get(
+static int cloud_service_pos_get(
 	const struct cloud_service_pos_req *params,
 	char * const rcv_buf,
 	const size_t rcv_buf_len,
@@ -70,11 +71,11 @@ int cloud_service_nrf_pos_get(
 
 	int err;
 
-	k_sem_reset(&nrf_location_ready);
+	k_sem_reset(&location_ready);
 
 	LOG_DBG("Sending positioning request (MQTT)");
 	err = nrf_cloud_location_request(
-		params->cell_data, params->wifi_data, NULL, cloud_service_nrf_location_ready_cb);
+		params->cell_data, params->wifi_data, NULL, cloud_service_location_ready_cb);
 	if (err == -EACCES) {
 		LOG_ERR("Cloud connection is not established");
 		return err;
@@ -85,18 +86,18 @@ int cloud_service_nrf_pos_get(
 
 	LOG_DBG("Positioning request sent");
 
-	if (k_sem_take(&nrf_location_ready, K_MSEC(params->timeout_ms)) == -EAGAIN) {
+	if (k_sem_take(&location_ready, K_MSEC(params->timeout_ms)) == -EAGAIN) {
 		LOG_ERR("Positioning data request timed out or "
 			"cloud did not return a location");
 		return -ETIMEDOUT;
 	}
 
-	*location = nrf_cloud_location;
+	*location = cloud_location;
 
 	return err;
 }
 #else /* defined(CONFIG_NRF_CLOUD_MQTT) */
-int cloud_service_nrf_pos_get(
+static int cloud_service_pos_get(
 	const struct cloud_service_pos_req *params,
 	char * const rcv_buf,
 	const size_t rcv_buf_len,
@@ -136,3 +137,18 @@ int cloud_service_nrf_pos_get(
 	return err;
 }
 #endif /* defined(CONFIG_NRF_CLOUD_MQTT) */
+
+int cloud_service_location_get(
+	const struct cloud_service_pos_req *params,
+	struct location_data *location)
+{
+	__ASSERT_NO_MSG(params != NULL);
+	__ASSERT_NO_MSG(params->cell_data != NULL || params->wifi_data != NULL);
+	__ASSERT_NO_MSG(location != NULL);
+
+	LOG_DBG("Cloud service location parameters:");
+	LOG_DBG("  Timeout: %dms", params->timeout_ms);
+
+	return cloud_service_pos_get(
+		params, recv_buf, sizeof(recv_buf), location);
+}

lib/location/cloud_service/cloud_service.h renamed to lib/location/cloud_service.h

@@ -17,8 +17,6 @@ extern "C" {
 
 /** Cloud positioning input parameters. */
 struct cloud_service_pos_req {
-	/** Cloud positioning service to be used. */
-	enum location_service service;
 	/** Neighbor cell data. */
 	struct lte_lc_cells_info *cell_data;
 	/** Wi-Fi scanning results data. */
@@ -44,11 +42,6 @@ int cloud_service_location_get(
 	const struct cloud_service_pos_req *params,
 	struct location_data *location);
 
-/**
- * @brief Initialize cloud services.
- */
-void cloud_service_init(void);
-
 #ifdef __cplusplus
 }
 #endif