app: led: Add LED pattern for FOTA

Add pattern (purple blinking) when FOTA image is downloading.

Signed-off-by: Jan Tore Guggedal <[email protected]>

Author: jtguggedal

app/src/modules/led/led.c

@@ -29,6 +29,7 @@ ZBUS_CHAN_ADD_OBS(CONFIG_CHAN, led, 0);
 ZBUS_CHAN_ADD_OBS(NETWORK_CHAN, led, 0);
 ZBUS_CHAN_ADD_OBS(TRIGGER_MODE_CHAN, led, 0);
 ZBUS_CHAN_ADD_OBS(LOCATION_CHAN, led, 0);
+ZBUS_CHAN_ADD_OBS(FOTA_STATUS_CHAN, led, 0);
 
 /* Zephyr SMF states */
 enum state {
@@ -41,6 +42,8 @@ enum state {
 	STATE_POLL,
 	/* Sub-state to STATE_LED_NOT_SET */
 	STATE_NORMAL,
+	/* Sub-state to STATE_LED_NOT_SET */
+	STATE_FOTA,
 	STATE_ERROR,
 };
 
@@ -331,6 +334,15 @@ static void led_not_set_running(void *o)
 		smf_set_state(SMF_CTX(user_object), &states[STATE_LED_SET]);
 		return;
 	}
+
+	if (&FOTA_STATUS_CHAN == user_object->chan) {
+		const enum fota_status *status = zbus_chan_const_msg(user_object->chan);
+
+		if (*status == FOTA_STATUS_START) {
+			smf_set_state(SMF_CTX(user_object), &states[STATE_FOTA]);
+			return;
+		}
+	}
 }
 
 /* STATE_POLL */
@@ -415,6 +427,43 @@ static void normal_running(void *o)
 	}
 }
 
+/* STATE_FOTA */
+
+static void fota_entry(void *o)
+{
+	ARG_UNUSED(o);
+
+	LOG_DBG("fota_entry");
+
+	transition_list_clear();
+	transition_list_append(LED_FOTA, HOLD_FOREVER, 0, 0, 0);
+
+	k_work_reschedule(&led_pattern_update_work, K_NO_WAIT);
+}
+
+static void fota_running(void *o)
+{
+	struct s_object *user_object = o;
+
+	LOG_DBG("fota_running");
+
+	if (&FOTA_STATUS_CHAN == user_object->chan) {
+		const enum fota_status *status = zbus_chan_const_msg(user_object->chan);
+
+		if (*status == FOTA_STATUS_STOP) {
+			smf_set_state(SMF_CTX(user_object), &states[STATE_LED_NOT_SET]);
+			return;
+		}
+	}
+
+	/* We do not want to change LED pattern while downloading FOTA image */
+	if ((&TRIGGER_MODE_CHAN == user_object->chan) ||
+	    (&LOCATION_CHAN == user_object->chan)) {
+		smf_set_handled(SMF_CTX(&user_object));
+		return;
+	}
+}
+
 /* STATE_ERROR */
 
 static void error_entry(void *o)
@@ -469,6 +518,13 @@ static const struct smf_state states[] = {
 		&states[STATE_LED_NOT_SET],
 		NULL
 	),
+	[STATE_FOTA] = SMF_CREATE_STATE(
+		fota_entry,
+		fota_running,
+		NULL,
+		&states[STATE_LED_NOT_SET],
+		NULL
+	),
 	[STATE_ERROR] = SMF_CREATE_STATE(
 		error_entry,
 		NULL,

app/src/modules/led/led.h

@@ -56,6 +56,7 @@ extern "C" {
 #define LED_LTE_CONNECTING_COLOR	LED_COLOR_YELLOW
 #define LED_LOCATION_SEARCHING_COLOR	LED_COLOR_GREEN
 #define LED_POLL_MODE_COLOR		LED_COLOR_BLUE
+#define LED_FOTA_COLOR			LED_COLOR_PURPLE
 #define LED_ERROR_SYSTEM_FAULT_COLOR	LED_COLOR_RED
 #define LED_OFF_COLOR			LED_COLOR_OFF
 
@@ -66,6 +67,7 @@ enum led_state {
 	LED_LOCATION_SEARCHING,
 	LED_ERROR_SYSTEM_FAULT,
 	LED_ERROR_IRRECOVERABLE,
+	LED_FOTA,
 	LED_CONFIGURED,
 	LED_OFF,
 	LED_PATTERN_COUNT,

app/src/modules/led/led_pwm.c

@@ -70,6 +70,11 @@ static const struct led_effect effect[] = {
 					LED_OFF_PERIOD_NORMAL,
 					LED_LOCATION_SEARCHING_COLOR
 				   ),
+	[LED_FOTA]		 = LED_EFFECT_LED_BREATHE(
+					LED_ON_PERIOD_NORMAL,
+					LED_OFF_PERIOD_NORMAL,
+					LED_FOTA_COLOR
+				   ),
 	[LED_ERROR_SYSTEM_FAULT] = LED_EFFECT_LED_BREATHE(
 					LED_ON_PERIOD_ERROR,
 					LED_OFF_PERIOD_ERROR,

docs/about.rst

@@ -25,6 +25,8 @@ The following table describes the supported LED states:
 +----------------+------------+----------------------------------------------+-----------------------------------------------------+
 | Blinking slow  | Blue       | Device is actively polling cloud             | 10 minutes after last config update or button press |
 +----------------+------------+----------------------------------------------+-----------------------------------------------------+
+| Blinking       | Purple     | Device is downloading FOTA image             | Until the download has completed or failed          |
++----------------+------------+----------------------------------------------+-----------------------------------------------------+
 | Solid          | Configured | Device has received an LED configuration     | NA                                                  |
 +----------------+------------+----------------------------------------------+-----------------------------------------------------+
 | Blinking rapid | Red        | Fatal error, the device will reboot          | NA                                                  |