fix: update from upstream

See https://github.com/nrfconnect/sdk-nrf/tree/a9330627f952d0532706acb24a313ca8a02a0a88/applications/asset_tracker_v2

Author: GitHub Actions

doc/ui_module.rst

@@ -40,23 +40,32 @@ LED indication
 The module supports multiple LED patterns to visualize the operating state of the application.
 The following table describes the supported LED states:
 
-+---------------------------+-------------------------+-----------------------+
-| State                     | Thingy:91 RGB LED       | nRF9160 DK solid LEDs |
-+===========================+=========================+=======================+
-| LTE connection search     | Yellow, blinking        | LED1 blinking         |
-+---------------------------+-------------------------+-----------------------+
-| GNSS fix search           | Purple, blinking        | LED2 blinking         |
-+---------------------------+-------------------------+-----------------------+
-| Publishing data           | Green, blinking         | LED3 blinking         |
-+---------------------------+-------------------------+-----------------------+
-| Active mode               | Light blue, blinking    | LED4 blinking         |
-+---------------------------+-------------------------+-----------------------+
-| Passive mode              | Dark blue, slow blinking| LED4 slow blinking    |
-+---------------------------+-------------------------+-----------------------+
-| Error                     | Red, static             | all 4 LEDs blinking   |
-+---------------------------+-------------------------+-----------------------+
-| Completion of FOTA update | White, rapid blinking   | all 4 LEDs on         |
-+---------------------------+-------------------------+-----------------------+
++---------------------------+------------------------------+----------------------------+
+| State                     | Thingy:91 RGB LED            | nRF9160 DK solid LEDs      |
++===========================+==============================+============================+
+| LTE connection search     | Yellow, blinking             | LED1 blinking              |
++---------------------------+------------------------------+----------------------------+
+| GNSS fix search           | Purple, blinking             | LED2 blinking              |
++---------------------------+------------------------------+----------------------------+
+| Cloud association         | White, double pulse blinking | LED3 double pulse blinking |
++---------------------------+------------------------------+----------------------------+
+| Connecting to cloud       | Green, triple pulse blinking | LED3 triple pulse blinking |
++---------------------------+------------------------------+----------------------------+
+| Publishing data           | Green, blinking              | LED3 blinking              |
++---------------------------+------------------------------+----------------------------+
+| Active mode               | Light blue, blinking         | LED4 blinking              |
++---------------------------+------------------------------+----------------------------+
+| Passive mode              | Dark blue, blinking          | LED3 and LED4 blinking     |
++---------------------------+------------------------------+----------------------------+
+| Error                     | Red, static                  | All 4 LEDs blinking        |
++---------------------------+------------------------------+----------------------------+
+| FOTA update               | Orange, rapid blinking       | LED1 and LED2 blinking     |
++---------------------------+------------------------------+----------------------------+
+| Completion of FOTA update | Orange, static               | LED1 and LED2 static       |
++---------------------------+------------------------------+----------------------------+
+
+.. note::
+   The LED pattern that indicates the device mode is visible for a few seconds after an update has been sent to cloud.
 
 Configuration options
 *********************
@@ -73,14 +82,20 @@ The UI module continuously updates its internal state based on the mode and oper
 This ensures that the correct LED pattern is displayed when the application changes its state of operation.
 The UI module has an internal state machine with the following states:
 
-* ``STATE_ACTIVE`` - The application is in the active mode, revert to the active mode LED pattern.
-* ``STATE_PASSIVE`` - The application is in the passive mode, revert to the passive mode LED pattern.
+* ``STATE_INIT`` - The initial state of the module.
+* ``STATE_RUNNING`` - The module has performed all the required initializations and can initiate the display of LED patterns based on incoming events from other modules.
 
-   * ``SUB_STATE_GNSS_ACTIVE`` - The application is performing a GNSS search, revert to the GNSS search LED pattern.
-   * ``SUB_STATE_GNSS_INACTIVE`` - A GNSS search is not being performed.
+   * ``SUB_STATE_ACTIVE`` - The application is in the active mode. The module reverts to the active mode LED pattern after cloud publication.
+   * ``SUB_STATE_PASSIVE`` - The application is in the passive mode. The module reverts to the passive mode LED pattern after cloud publication.
 
-* ``STATE_SHUTDOWN`` - The module has been shut down after receiving a request from the utility module.
+      * ``SUB_SUB_STATE_GNSS_ACTIVE`` - The application is performing a GNSS search. The module reverts to the GNSS search LED pattern.
+      * ``SUB_SUB_STATE_GNSS_INACTIVE`` - A GNSS search is not being performed.
 
+* ``STATE_LTE_CONNECTING`` - The modem module is performing an LTE connection search. The UI module triggers the LTE connection search LED pattern.
+* ``STATE_CLOUD_CONNECTING`` - The cloud module is connecting to cloud. The UI module triggers the cloud connection LED pattern.
+* ``STATE_CLOUD_ASSOCIATING`` - The cloud module is performing user association. The UI module triggers the cloud association LED pattern.
+* ``STATE_FOTA_UPDATING`` - The cloud module is performing a FOTA update. The UI module triggers the FOTA update LED pattern.
+* ``STATE_SHUTDOWN`` - The module has been shut down after receiving a request from the utility module. It triggers the appropriate LED pattern that corresponds to the shutdown reason.
 
 Module events
 *************
@@ -99,8 +114,7 @@ API documentation
 *****************
 
 | Header file: :file:`asset_tracker_v2/src/events/ui_module_event.h`
-| Source files: :file:`asset_tracker_v2/src/events/ui_module_event.c`
-                :file:`asset_tracker_v2/src/modules/ui_module.c`
+| Source files: :file:`asset_tracker_v2/src/events/ui_module_event.c`, :file:`asset_tracker_v2/src/modules/ui_module.c`
 
 .. doxygengroup:: ui_module_event
    :project: nrf

include/nrf9160dk_nrf9160_ns/led_state_def.h

@@ -25,27 +25,45 @@ enum led_id {
 	LED_ID_COUNT,
 
 	LED_ID_CONNECTING = LED_ID_1,
+	LED_ID_CLOUD_CONNECTING = LED_ID_3,
 	LED_ID_SEARCHING = LED_ID_2,
 	LED_ID_PUBLISHING = LED_ID_3,
-	LED_ID_MODE = LED_ID_4,
+	LED_ID_ASSOCIATING = LED_ID_3,
+	LED_ID_ASSOCIATED = LED_ID_3,
+	LED_ID_FOTA_1 = LED_ID_1,
+	LED_ID_FOTA_2 = LED_ID_2,
+	LED_ID_PASSIVE_MODE_1 = LED_ID_3,
+	LED_ID_PASSIVE_MODE_2 = LED_ID_4,
+	LED_ID_ACTIVE_MODE = LED_ID_4,
 };
 
-#define LED_PERIOD_NORMAL	500
-#define LED_PERIOD_LONG		3500
+#define LED_PERIOD_NORMAL	350
+#define LED_PERIOD_RAPID	100
+#define LED_TICKS_DOUBLE	2
+#define LED_TICKS_TRIPLE	3
 
 static const struct led_effect asset_tracker_led_effect[] = {
 	[LED_STATE_LTE_CONNECTING]	= LED_EFFECT_LED_BLINK(LED_PERIOD_NORMAL,
-								LED_COLOR(100, 100, 100)),
+							       LED_COLOR(100, 100, 100)),
 	[LED_STATE_GNSS_SEARCHING]	= LED_EFFECT_LED_BLINK(LED_PERIOD_NORMAL,
-								LED_COLOR(100, 100, 100)),
+							       LED_COLOR(100, 100, 100)),
 	[LED_STATE_CLOUD_PUBLISHING]	= LED_EFFECT_LED_BLINK(LED_PERIOD_NORMAL,
-								LED_COLOR(100, 100, 100)),
+							       LED_COLOR(100, 100, 100)),
+	[LED_STATE_CLOUD_CONNECTING]	= LED_EFFECT_LED_CLOCK(LED_TICKS_TRIPLE,
+							       LED_COLOR(100, 100, 100)),
+	[LED_STATE_CLOUD_ASSOCIATING]	= LED_EFFECT_LED_CLOCK(LED_TICKS_DOUBLE,
+							       LED_COLOR(100, 100, 100)),
+	[LED_STATE_CLOUD_ASSOCIATED]	= LED_EFFECT_LED_ON_GO_OFF(LED_COLOR(100, 100, 100),
+								   LED_PERIOD_NORMAL,
+								   LED_PERIOD_RAPID),
 	[LED_STATE_ACTIVE_MODE]		= LED_EFFECT_LED_BLINK(LED_PERIOD_NORMAL,
-								LED_COLOR(100, 100, 100)),
-	[LED_STATE_PASSIVE_MODE]	= LED_EFFECT_LED_BLINK(LED_PERIOD_LONG,
-								LED_COLOR(100, 100, 100)),
+							       LED_COLOR(100, 100, 100)),
+	[LED_STATE_PASSIVE_MODE]	= LED_EFFECT_LED_BLINK(LED_PERIOD_NORMAL,
+							       LED_COLOR(100, 100, 100)),
 	[LED_STATE_ERROR_SYSTEM_FAULT]	= LED_EFFECT_LED_BLINK(LED_PERIOD_NORMAL,
-								LED_COLOR(100, 100, 100)),
+							       LED_COLOR(100, 100, 100)),
+	[LED_STATE_FOTA_UPDATING]	= LED_EFFECT_LED_BLINK(LED_PERIOD_RAPID,
+							       LED_COLOR(100, 100, 100)),
 	[LED_STATE_FOTA_UPDATE_REBOOT]	= LED_EFFECT_LED_ON(LED_COLOR(100, 100, 100)),
 	[LED_STATE_TURN_OFF]		= LED_EFFECT_LED_OFF(),
 };

include/thingy91_nrf9160_ns/led_state_def.h

@@ -22,15 +22,22 @@ enum led_id {
 	LED_ID_COUNT,
 
 	LED_ID_CONNECTING = LED_ID_1,
+	LED_ID_CLOUD_CONNECTING = LED_ID_1,
 	LED_ID_SEARCHING = LED_ID_1,
 	LED_ID_PUBLISHING = LED_ID_1,
-	LED_ID_MODE = LED_ID_1,
+	LED_ID_ASSOCIATING = LED_ID_1,
+	LED_ID_ASSOCIATED = LED_ID_1,
+	LED_ID_FOTA_1 = LED_ID_1,
+	LED_ID_FOTA_2 = LED_ID_1,
+	LED_ID_PASSIVE_MODE_1 = LED_ID_1,
+	LED_ID_PASSIVE_MODE_2 = LED_ID_1,
+	LED_ID_ACTIVE_MODE = LED_ID_1,
 };
 
-
-#define LED_PERIOD_NORMAL	500
-#define LED_PERIOD_LONG		3500
-#define LED_PERIOD_RAPID	200
+#define LED_PERIOD_NORMAL	350
+#define LED_PERIOD_RAPID	100
+#define LED_TICKS_DOUBLE	2
+#define LED_TICKS_TRIPLE	3
 
 static const struct led_effect asset_tracker_led_effect[] = {
 	[LED_STATE_LTE_CONNECTING]	= LED_EFFECT_LED_BREATH(LED_PERIOD_NORMAL,
@@ -39,12 +46,20 @@ static const struct led_effect asset_tracker_led_effect[] = {
 								LED_COLOR(255, 0, 255)),
 	[LED_STATE_CLOUD_PUBLISHING]	= LED_EFFECT_LED_BREATH(LED_PERIOD_NORMAL,
 								LED_COLOR(0, 255, 0)),
+	[LED_STATE_CLOUD_CONNECTING]	= LED_EFFECT_LED_CLOCK(LED_TICKS_TRIPLE,
+							       LED_COLOR(0, 255, 0)),
+	[LED_STATE_CLOUD_ASSOCIATING]	= LED_EFFECT_LED_CLOCK(LED_TICKS_DOUBLE,
+							       LED_COLOR(255, 255, 255)),
+	[LED_STATE_CLOUD_ASSOCIATED]	= LED_EFFECT_LED_ON_GO_OFF(LED_COLOR(255, 255, 255),
+								   LED_PERIOD_NORMAL,
+								   LED_PERIOD_RAPID),
 	[LED_STATE_ACTIVE_MODE]		= LED_EFFECT_LED_BREATH(LED_PERIOD_NORMAL,
 								LED_COLOR(0, 255, 255)),
-	[LED_STATE_PASSIVE_MODE]	= LED_EFFECT_LED_BREATH(LED_PERIOD_LONG,
+	[LED_STATE_PASSIVE_MODE]	= LED_EFFECT_LED_BREATH(LED_PERIOD_NORMAL,
 								LED_COLOR(0, 0, 255)),
 	[LED_STATE_ERROR_SYSTEM_FAULT]	= LED_EFFECT_LED_ON(LED_COLOR(255, 0, 0)),
-	[LED_STATE_FOTA_UPDATE_REBOOT]	= LED_EFFECT_LED_BREATH(LED_PERIOD_RAPID,
-								LED_COLOR(255, 255, 255)),
+	[LED_STATE_FOTA_UPDATING]	= LED_EFFECT_LED_BREATH(LED_PERIOD_RAPID,
+								LED_COLOR(255, 165, 0)),
+	[LED_STATE_FOTA_UPDATE_REBOOT]	= LED_EFFECT_LED_ON(LED_COLOR(255, 165, 0)),
 	[LED_STATE_TURN_OFF]		= LED_EFFECT_LED_OFF(),
 };

src/cloud/cloud_wrapper.h

@@ -35,6 +35,10 @@ enum cloud_wrap_event_type {
 	 *  Payload is of type @ref cloud_wrap_event_data.
 	 */
 	CLOUD_WRAP_EVT_DATA_RECEIVED,
+	/** User association request received from cloud. */
+	CLOUD_WRAP_EVT_USER_ASSOCIATION_REQUEST,
+	/** User association completed. */
+	CLOUD_WRAP_EVT_USER_ASSOCIATED,
 	/** A-GPS data received from the cloud integration layer.
 	 *  Payload is of type @ref cloud_wrap_event_data.
 	 */

src/cloud/nrf_cloud_integration.c

@@ -19,6 +19,8 @@ LOG_MODULE_REGISTER(MODULE, CONFIG_CLOUD_INTEGRATION_LOG_LEVEL);
  */
 #define CELL_POS_FILTER_STRING "CELL_POS"
 
+static struct k_work_delayable user_associating_work;
+
 static cloud_wrap_evt_handler_t wrapper_evt_handler;
 
 static void cloud_wrapper_notify_event(const struct cloud_wrap_event *evt)
@@ -30,6 +32,25 @@ static void cloud_wrapper_notify_event(const struct cloud_wrap_event *evt)
 	}
 }
 
+/* Work item that is called if user association fails to succeed within
+ * CONFIG_CLOUD_USER_ASSOCIATION_TIMEOUT_SEC.
+ */
+static void user_association_work_fn(struct k_work *work)
+{
+	/* Report an irrecoverable error in case user association fails. Will cause a reboot of the
+	 * application.
+	 */
+	struct cloud_wrap_event cloud_wrap_evt = {
+		.type = CLOUD_WRAP_EVT_ERROR,
+		.err = -ETIMEDOUT
+	};
+
+	LOG_ERR("Failed to associate the device within: %d seconds",
+		CONFIG_CLOUD_USER_ASSOCIATION_TIMEOUT_SEC);
+
+	cloud_wrapper_notify_event(&cloud_wrap_evt);
+}
+
 static int send_service_info(void)
 {
 	int err;
@@ -40,10 +61,12 @@ static int send_service_info(void)
 	};
 	struct nrf_cloud_svc_info_ui ui_info = {
 		.gps = true,
+#if defined(CONFIG_BOARD_THINGY91_NRF9160_NS)
 		.humidity = true,
 		.air_pressure = true,
-		.rsrp = true,
 		.temperature = true,
+#endif
+		.rsrp = true,
 		.button = true
 	};
 	struct nrf_cloud_svc_info service_info = {
@@ -88,6 +111,8 @@ static void nrf_cloud_event_handler(const struct nrf_cloud_evt *evt)
 	switch (evt->type) {
 	case NRF_CLOUD_EVT_TRANSPORT_CONNECTING:
 		LOG_DBG("NRF_CLOUD_EVT_TRANSPORT_CONNECTING");
+		cloud_wrap_evt.type = CLOUD_WRAP_EVT_CONNECTING;
+		notify = true;
 		break;
 	case NRF_CLOUD_EVT_TRANSPORT_CONNECTED:
 		LOG_DBG("NRF_CLOUD_EVT_TRANSPORT_CONNECTED");
@@ -116,11 +141,21 @@ static void nrf_cloud_event_handler(const struct nrf_cloud_evt *evt)
 	case NRF_CLOUD_EVT_SENSOR_DATA_ACK:
 		LOG_DBG("NRF_CLOUD_EVT_SENSOR_DATA_ACK");
 		break;
+	case NRF_CLOUD_EVT_FOTA_START:
+		LOG_DBG("NRF_CLOUD_EVT_FOTA_START");
+		cloud_wrap_evt.type = CLOUD_WRAP_EVT_FOTA_START;
+		notify = true;
+		break;
 	case NRF_CLOUD_EVT_FOTA_DONE:
 		LOG_DBG("NRF_CLOUD_EVT_FOTA_DONE");
 		cloud_wrap_evt.type = CLOUD_WRAP_EVT_FOTA_DONE;
 		notify = true;
 		break;
+	case NRF_CLOUD_EVT_FOTA_ERROR:
+		LOG_DBG("NRF_CLOUD_EVT_FOTA_ERROR");
+		cloud_wrap_evt.type = CLOUD_WRAP_EVT_FOTA_ERROR;
+		notify = true;
+		break;
 	case NRF_CLOUD_EVT_RX_DATA:
 		LOG_DBG("NRF_CLOUD_EVT_RX_DATA");
 
@@ -141,36 +176,41 @@ static void nrf_cloud_event_handler(const struct nrf_cloud_evt *evt)
 		break;
 	case NRF_CLOUD_EVT_USER_ASSOCIATION_REQUEST:
 		LOG_WRN("NRF_CLOUD_EVT_USER_ASSOCIATION_REQUEST");
-		LOG_WRN("Add the device to nRF Cloud and wait for it to reconnect");
-
-		/* A disconnect/reconnect is required by nRF Cloud after the
-		 * NRF_CLOUD_EVT_USER_ASSOCIATED event is received. This event is sent from
-		 * nRF Cloud when the device has been added to an nRF Cloud account.
-		 * However, it is likely that the device is in PSM when this occurs and not able to
-		 * receive this event.
-		 *
-		 * Due to this, we explicitly disconnect the application
-		 * when the NRF_CLOUD_EVT_USER_ASSOCIATION_REQUEST event is received and depend on
-		 * the reconnection routine in the cloud module to reconnect the application until
-		 * the device has been registered to the nRF Cloud account.
-		 *
-		 * It is expected that the application will disconnect and reconnect to nRF Cloud
-		 * several times during device association.
+		LOG_WRN("Add the device to nRF Cloud to complete user association");
+
+		/* Schedule a work item that causes an error in case user association is not
+		 * carried out within a configurable amount of time.
 		 */
-		err = nrf_cloud_disconnect();
-		if (err) {
-			LOG_ERR("nrf_cloud_disconnect failed, error: %d", err);
+		k_work_schedule(&user_associating_work,
+				K_SECONDS(CONFIG_CLOUD_USER_ASSOCIATION_TIMEOUT_SEC));
 
-			/* If disconnection from nRF Cloud fails, the cloud module is notified with
-			 * an error. The application is expected to perform a reboot in order
-			 * to reconnect to nRF Cloud and complete device association.
-			 */
-			cloud_wrap_evt.type = CLOUD_WRAP_EVT_ERROR;
-			notify = true;
-		}
+		cloud_wrap_evt.type = CLOUD_WRAP_EVT_USER_ASSOCIATION_REQUEST;
+		notify = true;
 		break;
 	case NRF_CLOUD_EVT_USER_ASSOCIATED:
 		LOG_DBG("NRF_CLOUD_EVT_USER_ASSOCIATED");
+
+		/* Disconnect/reconnect the device to apply the appropriate device policies and to
+		 * complete the user association process.
+		 */
+		if (k_work_delayable_is_pending(&user_associating_work)) {
+			err = nrf_cloud_disconnect();
+			if (err) {
+				LOG_ERR("nrf_cloud_disconnect, error: %d", err);
+
+				cloud_wrap_evt.type = CLOUD_WRAP_EVT_ERROR;
+				cloud_wrap_evt.err = err;
+				cloud_wrapper_notify_event(&cloud_wrap_evt);
+				return;
+			}
+
+			/* Cancel user association timeout upon completion of user association. */
+			k_work_cancel_delayable(&user_associating_work);
+
+			/* Notify the rest of the applicaiton that user association succeeded. */
+			cloud_wrap_evt.type = CLOUD_WRAP_EVT_USER_ASSOCIATED;
+			notify = true;
+		}
 		break;
 	default:
 		LOG_ERR("Unknown nRF Cloud event type: %d", evt->type);
@@ -202,6 +242,8 @@ int cloud_wrap_init(cloud_wrap_evt_handler_t event_handler)
 	LOG_DBG(" Endpoint:    %s", CONFIG_NRF_CLOUD_HOST_NAME);
 	LOG_DBG("********************************************");
 
+	k_work_init_delayable(&user_associating_work, user_association_work_fn);
+
 	wrapper_evt_handler = event_handler;
 
 	return 0;

src/events/cloud_module_event.c

@@ -19,6 +19,10 @@ static char *get_evt_type_str(enum cloud_module_event_type type)
 		return "CLOUD_EVT_CONNECTING";
 	case CLOUD_EVT_CONNECTION_TIMEOUT:
 		return "CLOUD_EVT_CONNECTION_TIMEOUT";
+	case CLOUD_EVT_USER_ASSOCIATION_REQUEST:
+		return "CLOUD_EVT_USER_ASSOCIATION_REQUEST";
+	case CLOUD_EVT_USER_ASSOCIATED:
+		return "CLOUD_EVT_USER_ASSOCIATED";
 	case CLOUD_EVT_CONFIG_RECEIVED:
 		return "CLOUD_EVT_CONFIG_RECEIVED";
 	case CLOUD_EVT_CONFIG_EMPTY:
@@ -27,8 +31,12 @@ static char *get_evt_type_str(enum cloud_module_event_type type)
 		return "CLOUD_EVT_DATA_ACK";
 	case CLOUD_EVT_SHUTDOWN_READY:
 		return "CLOUD_EVT_SHUTDOWN_READY";
+	case CLOUD_EVT_FOTA_START:
+		return "CLOUD_EVT_FOTA_START";
 	case CLOUD_EVT_FOTA_DONE:
 		return "CLOUD_EVT_FOTA_DONE";
+	case CLOUD_EVT_FOTA_ERROR:
+		return "CLOUD_EVT_FOTA_ERROR";
 	case CLOUD_EVT_ERROR:
 		return "CLOUD_EVT_ERROR";
 	default: