samples: nrf9160: modem_shell: location: status led for the location

DK LED #1 (purple with Thingy91) is getting on for a while
when location has been retrieved by the location command.

Signed-off-by: Jani Hirsimäki <[email protected]>

Author: jhirsi

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

@@ -215,6 +215,12 @@ nRF9160 samples
 
    * Sample moved from :file:`samples/nrf9160/nrf_cloud_rest_cell_pos` to :file:`samples/nrf9160/nrf_cloud_rest_cell_location`.
 
+* :ref:`modem_shell_application` sample:
+
+  * Added:
+
+    * LED 1 (nRF9160 DK)/Purple LED (Thingy:91) is lit for five seconds indicating that a current location has been acquired by using the ``location get`` command.
+
 Thread samples
 --------------
 

samples/nrf9160/modem_shell/README.rst

@@ -788,6 +788,8 @@ LED indications
 
 The LEDs have the following functions:
 
+LED 1 (nRF9160 DK)/Purple LED (Thingy:91):
+   Lit for five seconds when the current location has been successfully retrieved by using the ``location get`` command.
 LED 3 (nRF9160 DK)/Blue LED (Thingy:91):
    Indicates the LTE registration status.
 

samples/nrf9160/modem_shell/src/link/link.c

@@ -31,6 +31,7 @@
 
 #include "uart/uart_shell.h"
 #include "mosh_print.h"
+#include "mosh_defines.h"
 
 #if defined(CONFIG_MOSH_SMS)
 #include "sms.h"
@@ -51,7 +52,6 @@ struct pdn_activation_status_info {
 	uint8_t cid;
 };
 
-#define REGISTERED_STATUS_LED          DK_LED3
 
 static bool link_subscribe_for_rsrp;
 
@@ -167,8 +167,9 @@ static void link_registered_work(struct k_work *unused)
 
 	ARG_UNUSED(unused);
 
+#if defined(CONFIG_DK_LIBRARY)
 	dk_set_led_on(REGISTERED_STATUS_LED);
-
+#endif
 	memset(pdn_act_status_arr, 0,
 	       PDN_CONTEXTS_MAX * sizeof(struct pdn_activation_status_info));
 
@@ -367,7 +368,9 @@ void link_ind_handler(const struct lte_lc_evt *const evt)
 		    evt->nw_reg_status == LTE_LC_NW_REG_REGISTERED_ROAMING) {
 			k_work_submit_to_queue(&mosh_common_work_q, &registered_work);
 		} else {
+#if defined(CONFIG_DK_LIBRARY)
 			dk_set_led_off(REGISTERED_STATUS_LED);
+#endif
 		}
 		break;
 	case LTE_LC_EVT_CELL_UPDATE:

samples/nrf9160/modem_shell/src/location/location_shell.c

@@ -15,10 +15,13 @@
 #include <net/nrf_cloud_rest.h>
 #endif
 #include <modem/location.h>
+#include <dk_buttons_and_leds.h>
+
 
 #include "mosh_print.h"
 #include "location_cmd_utils.h"
 
+#include "mosh_defines.h"
 
 enum location_shell_command {
 	LOCATION_CMD_NONE = 0,
@@ -38,6 +41,11 @@ struct gnss_location_work_data {
 };
 static struct gnss_location_work_data gnss_location_work_data;
 
+
+#if defined(CONFIG_DK_LIBRARY)
+static struct k_work_delayable location_evt_led_work;
+#endif
+
 /******************************************************************************/
 static const char location_usage_str[] =
 	"Usage: location <subcommand> [options]\n"
@@ -214,6 +222,13 @@ static void location_to_cloud_worker(struct k_work *work_item)
 	}
 }
 
+#if defined(CONFIG_DK_LIBRARY)
+static void location_evt_led_worker(struct k_work *work_item)
+{
+	dk_set_led_off(LOCATION_STATUS_LED);
+}
+#endif
+
 /******************************************************************************/
 
 void location_ctrl_event_handler(const struct location_event_data *event_data)
@@ -252,6 +267,12 @@ void location_ctrl_event_handler(const struct location_event_data *event_data)
 			gnss_location_work_data.format = gnss_location_to_cloud_format;
 			k_work_submit_to_queue(&mosh_common_work_q, &gnss_location_work_data.work);
 		}
+
+#if defined(CONFIG_DK_LIBRARY)
+		dk_set_led_on(LOCATION_STATUS_LED);
+		k_work_reschedule_for_queue(&mosh_common_work_q, &location_evt_led_work,
+			K_SECONDS(5));
+#endif
 		break;
 
 	case LOCATION_EVT_TIMEOUT:
@@ -292,6 +313,10 @@ void location_ctrl_init(void)
 {
 	int ret;
 
+#if defined(CONFIG_DK_LIBRARY)
+	k_work_init_delayable(&location_evt_led_work, location_evt_led_worker);
+#endif
+
 	ret = location_init(location_ctrl_event_handler);
 	if (ret) {
 		mosh_error("Initializing the Location library failed, err: %d\n", ret);
@@ -493,6 +518,8 @@ int location_shell(const struct shell *shell, size_t argc, char **argv)
 	/* Handle location subcommands */
 	switch (command) {
 	case LOCATION_CMD_CANCEL:
+		gnss_location_to_cloud = false;
+		k_work_cancel(&gnss_location_work_data.work);
 		ret = location_request_cancel();
 		if (ret) {
 			mosh_error("Canceling location request failed, err: %d", ret);

samples/nrf9160/modem_shell/src/main.c

@@ -182,6 +182,7 @@ static void mosh_print_version_info(void)
 #endif
 }
 
+#if defined(CONFIG_DK_LIBRARY)
 static void button_handler(uint32_t button_states, uint32_t has_changed)
 {
 	if (has_changed & button_states & DK_BTN1_MSK) {
@@ -203,6 +204,7 @@ static void button_handler(uint32_t button_states, uint32_t has_changed)
 		uart_toggle_power_state();
 	}
 }
+#endif
 
 void main(void)
 {
@@ -292,11 +294,16 @@ void main(void)
 	}
 #endif
 
+#if defined(CONFIG_DK_LIBRARY)
 	err = dk_buttons_init(button_handler);
 	if (err) {
 		printk("Failed to initialize DK buttons library, error: %d\n", err);
 	}
-
+	err = dk_leds_init();
+	if (err) {
+		printk("Cannot initialize LEDs (err: %d)\n", err);
+	}
+#endif
 	/* Application started successfully, mark image as OK to prevent
 	 * revert at next reboot.
 	 */
@@ -305,11 +312,6 @@ void main(void)
 #endif
 	k_poll_signal_init(&mosh_signal);
 
-	err = dk_leds_init();
-	if (err) {
-		printk("Cannot initialize LEDs (err: %d)\n", err);
-	}
-
 #if defined(CONFIG_SHELL_BACKEND_SERIAL)
 	/* Resize terminal width and height of the shell to have proper command editing. */
 	shell_execute_cmd(mosh_shell, "resize");

samples/nrf9160/modem_shell/src/mosh_defines.h

@@ -21,4 +21,7 @@ enum mosh_signals {
 	MOSH_SIGNAL_KILL,
 };
 
+#define LOCATION_STATUS_LED            DK_LED1
+#define REGISTERED_STATUS_LED          DK_LED3
+
 #endif /* MOSH_DEFINES_H */