modules: app: Merge with trigger module to simplify application

The app and trigger modules are merged to simplify the
application logic. It's now all in the app module.

This also allows for the environmental module to have only one
state and hence no need for state machine, as triggers will
not be sent if time is not available.

Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>

Author: jtguggedal

app/CMakeLists.txt

@@ -13,7 +13,6 @@ project("Asset Tracker Template")
 add_subdirectory(src/common)
 
 # Include mandatory module source folders
-add_subdirectory(src/modules/trigger)
 add_subdirectory(src/modules/battery)
 add_subdirectory(src/modules/network)
 add_subdirectory(src/modules/transport)

app/Kconfig

@@ -13,7 +13,6 @@ config APP_PAYLOAD_CHANNEL_BUFFER_MAX_SIZE
 	  Maximum size of the buffer sent over the payload channel.
 	  Contains encoded CBOR data sampled and encoded in the various modules.
 
-rsource "src/modules/trigger/Kconfig.trigger"
 rsource "src/modules/battery/Kconfig.battery"
 rsource "src/modules/network/Kconfig.network"
 rsource "src/modules/transport/Kconfig.transport"

app/prj.conf

@@ -221,7 +221,6 @@ CONFIG_APP_FOTA_LOG_LEVEL_DBG=y
 CONFIG_APP_BATTERY_LOG_LEVEL_DBG=y
 CONFIG_APP_LOCATION_LOG_LEVEL_DBG=y
 CONFIG_APP_TRANSPORT_LOG_LEVEL_DBG=y
-CONFIG_APP_TRIGGER_LOG_LEVEL_DBG=y
 CONFIG_APP_NETWORK_LOG_LEVEL_DBG=y
 CONFIG_APP_LED_LOG_LEVEL_DBG=y
 CONFIG_APP_ENVIRONMENTAL_LOG_LEVEL_DBG=y

app/src/common/message_channel.h

@@ -223,7 +223,7 @@ struct cloud_msg {
 #define MSG_TO_CLOUD_MSG(_msg)	(*(const struct cloud_msg *)_msg)
 
 enum trigger_type {
-	TRIGGER_POLL = 0x1,
+	TRIGGER_POLL_SHADOW = 0x1,
 	TRIGGER_FOTA_POLL,
 	TRIGGER_DATA_SAMPLE,
 };

app/src/modules/app/Kconfig.app

@@ -5,6 +5,13 @@
 #
 menu "App"
 
+config APP_MODULE_TRIGGER_TIMEOUT_SECONDS
+	int "Trigger timer timeout"
+	default 600
+	help
+	  Timeout for the trigger timer. On timeout, the module will send triggers for
+	  sensor sampling, location search and polling of shadow and FOTA status from cloud.
+
 config APP_MODULE_THREAD_STACK_SIZE
 	int "Thread stack size"
 	default 3200

app/src/modules/app/app.c

@@ -8,12 +8,249 @@
 #include <zephyr/logging/log.h>
 #include <zephyr/zbus/zbus.h>
 #include <date_time.h>
+#include <zephyr/task_wdt/task_wdt.h>
+#include <zephyr/smf.h>
 
+#include "modules_common.h"
 #include "message_channel.h"
 
 /* Register log module */
 LOG_MODULE_REGISTER(app, CONFIG_APP_LOG_LEVEL);
 
+/* Define a ZBUS listener for this module */
+static void app_callback(const struct zbus_channel *chan);
+ZBUS_LISTENER_DEFINE(app_listener, app_callback);
+
+/* Observe channels */
+ZBUS_CHAN_ADD_OBS(CONFIG_CHAN, app_listener, 0);
+ZBUS_CHAN_ADD_OBS(CLOUD_CHAN, app_listener, 0);
+ZBUS_CHAN_ADD_OBS(BUTTON_CHAN, app_listener, 0);
+ZBUS_CHAN_ADD_OBS(TIME_CHAN, app_listener, 0);
+
+/* Forward declarations */
+static void trigger_work_fn(struct k_work *work);
+static void date_time_handler(const struct date_time_evt *evt);
+static const struct smf_state states[];
+
+/* Delayable work used to schedule triggers */
+static K_WORK_DELAYABLE_DEFINE(trigger_work, trigger_work_fn);
+
+/* State machine definitions */
+static const struct smf_state states[];
+
+/* Forward declarations of state handlers */
+static void init_entry(void *o);
+static void init_run(void *o);
+
+static void connected_entry(void *o);
+static void connected_run(void *o);
+
+static void disconnected_entry(void *o);
+static void disconnected_run(void *o);
+
+/* Defining the hierarchical trigger module states:
+ *
+ *   STATE_INIT: Initial state where the module waits for time to be available.
+ *   STATE_DISCONNECTED: Cloud connection is not established or paused
+ *   STATE_CONNECTED: Cloud connection is established and ready to send data
+ */
+enum state {
+	STATE_INIT,
+	STATE_CONNECTED,
+	STATE_DISCONNECTED,
+};
+
+/* Construct state table */
+static const struct smf_state states[] = {
+	[STATE_INIT] = SMF_CREATE_STATE(
+		init_entry,
+		init_run,
+		NULL,
+		NULL,
+		NULL
+	),
+	[STATE_CONNECTED] = SMF_CREATE_STATE(
+		connected_entry,
+		connected_run,
+		NULL,
+		NULL,
+		NULL
+	),
+	[STATE_DISCONNECTED] = SMF_CREATE_STATE(
+		disconnected_entry,
+		disconnected_run,
+		NULL,
+		NULL,
+		NULL
+	)
+};
+
+/* State ovject for the app module.
+ * Used to transfer data between state changes.
+ */
+static struct state_object {
+	/* This must be first */
+	struct smf_ctx ctx;
+
+	/* Last channel type that a message was received on */
+	const struct zbus_channel *chan;
+
+	/* Trigger interval */
+	uint64_t interval_sec;
+
+	/* Button number */
+	uint8_t button_number;
+
+	/* Time available */
+	enum time_status time_status;
+
+	/* Cloud status */
+	enum cloud_msg_type status;
+} app_state;
+
+static void triggers_send(void)
+{
+	int err;
+	struct network_msg network_msg = {
+		.type = NETWORK_QUALITY_SAMPLE_REQUEST,
+	};
+	struct battery_msg battery_msg = {
+		.type = BATTERY_PERCENTAGE_SAMPLE_REQUEST,
+	};
+	enum trigger_type poll_trigger = TRIGGER_FOTA_POLL;
+
+	err = zbus_chan_pub(&NETWORK_CHAN, &network_msg, K_SECONDS(1));
+	if (err) {
+		LOG_ERR("zbus_chan_pub, error: %d", err);
+		SEND_FATAL_ERROR();
+		return;
+	}
+
+	err = zbus_chan_pub(&BATTERY_CHAN, &battery_msg, K_SECONDS(1));
+	if (err) {
+		LOG_ERR("zbus_chan_pub, error: %d", err);
+		SEND_FATAL_ERROR();
+		return;
+	}
+
+	/* Send FOTA poll trigger */
+	err = zbus_chan_pub(&TRIGGER_CHAN, &poll_trigger, K_SECONDS(1));
+	if (err) {
+		LOG_ERR("zbus_chan_pub FOTA trigger, error: %d", err);
+		SEND_FATAL_ERROR();
+		return;
+	}
+
+	/* Send trigger for shadow polling */
+	poll_trigger = TRIGGER_POLL_SHADOW;
+
+	err = zbus_chan_pub(&TRIGGER_CHAN, &poll_trigger, K_SECONDS(1));
+	if (err) {
+		LOG_ERR("zbus_chan_pub shadow trigger, error: %d", err);
+		SEND_FATAL_ERROR();
+		return;
+	}
+
+	/* Trigger location search and environmental data sample */
+	poll_trigger = TRIGGER_DATA_SAMPLE;
+
+	err = zbus_chan_pub(&TRIGGER_CHAN, &poll_trigger, K_SECONDS(1));
+	if (err) {
+		LOG_ERR("zbus_chan_pub data sample trigger, error: %d", err);
+		SEND_FATAL_ERROR();
+		return;
+	}
+}
+
+/* Zephyr State Machine framework handlers */
+
+/* STATE_INIT */
+
+static void init_entry(void *o)
+{
+	ARG_UNUSED(o);
+
+	LOG_DBG("%s", __func__);
+
+	/* Setup handler for date_time library */
+	date_time_register_handler(date_time_handler);
+}
+
+static void init_run(void *o)
+{
+	struct state_object *user_object = o;
+
+	LOG_DBG("%s", __func__);
+
+	if ((user_object->chan == &TIME_CHAN) && (user_object->time_status == TIME_AVAILABLE)) {
+		LOG_DBG("Time available, going into disconnected state");
+		STATE_SET(app_state, STATE_DISCONNECTED);
+		return;
+	}
+}
+
+/* STATE_DISCONNECTED */
+
+static void disconnected_entry(void *o)
+{
+	ARG_UNUSED(o);
+
+	LOG_DBG("%s", __func__);
+
+	k_work_cancel_delayable(&trigger_work);
+}
+
+static void disconnected_run(void *o)
+{
+	struct state_object *user_object = o;
+
+	LOG_DBG("%s", __func__);
+
+	if ((user_object->chan == &CLOUD_CHAN) &&
+	    (user_object->status == CLOUD_CONNECTED_READY_TO_SEND)) {
+		STATE_SET(app_state, STATE_CONNECTED);
+		return;
+	}
+}
+
+/* STATE_CONNECTED */
+
+static void connected_entry(void *o)
+{
+	ARG_UNUSED(o);
+
+	LOG_DBG("%s", __func__);
+
+	k_work_reschedule(&trigger_work, K_NO_WAIT);
+}
+
+static void connected_run(void *o)
+{
+	struct state_object *user_object = o;
+
+	LOG_DBG("%s", __func__);
+
+	if ((user_object->chan == &CLOUD_CHAN) &&
+	    ((user_object->status == CLOUD_CONNECTED_PAUSED) ||
+	     (user_object->status == CLOUD_DISCONNECTED))) {
+		LOG_DBG("Cloud disconnected/paused, going into disconnected state");
+		STATE_SET(app_state, STATE_DISCONNECTED);
+		return;
+	}
+
+	if (user_object->chan == &BUTTON_CHAN) {
+		LOG_DBG("Button %d pressed!", user_object->button_number);
+		k_work_reschedule(&trigger_work, K_NO_WAIT);
+		return;
+	}
+
+	if (user_object->chan == &CONFIG_CHAN) {
+		LOG_DBG("Configuration update, new interval: %lld", user_object->interval_sec);
+		k_work_reschedule(&trigger_work, K_SECONDS(user_object->interval_sec));
+		return;
+	}
+}
+
 static void date_time_handler(const struct date_time_evt *evt) {
 	if (evt->type != DATE_TIME_NOT_OBTAINED) {
 		int err;
@@ -27,10 +264,73 @@ static void date_time_handler(const struct date_time_evt *evt) {
 	}
 }
 
+/* Delayable work used to send triggers to the rest of the system */
+static void trigger_work_fn(struct k_work *work)
+{
+	ARG_UNUSED(work);
+
+	LOG_DBG("Sending data sample trigger");
+
+	triggers_send();
+
+	k_work_reschedule(&trigger_work, K_SECONDS(app_state.interval_sec));
+}
+
+/* Function called when there is a message received on a channel that the module listens to */
+static void app_callback(const struct zbus_channel *chan)
+{
+	int err;
+
+	if ((chan != &CONFIG_CHAN) &&
+	    (chan != &CLOUD_CHAN) &&
+	    (chan != &BUTTON_CHAN) &&
+	    (chan != &TIME_CHAN)) {
+		LOG_ERR("Unknown channel");
+		return;
+	}
+
+	LOG_DBG("Received message on channel %s", zbus_chan_name(chan));
+
+	/* Update the state object with the channel that the message was received on */
+	app_state.chan = chan;
+
+	/* Copy corresponding data to the state object depending on the incoming channel */
+	if (&CONFIG_CHAN == chan) {
+		const struct configuration *config = zbus_chan_const_msg(chan);
+
+		if (config->update_interval_present) {
+			app_state.interval_sec = config->update_interval;
+		}
+	} else if (&CLOUD_CHAN == chan) {
+		const enum cloud_msg_type *status = zbus_chan_const_msg(chan);
+
+		app_state.status = *status;
+	} else if (&BUTTON_CHAN == chan) {
+		const int *button_number = zbus_chan_const_msg(chan);
+
+		app_state.button_number = (uint8_t)*button_number;
+	} else if (&TIME_CHAN == chan) {
+		const enum time_status *time_status = zbus_chan_const_msg(chan);
+
+		app_state.time_status = *time_status;
+	}
+
+	LOG_DBG("Running SMF");
+
+	/* State object updated, run SMF */
+	err = STATE_RUN(app_state);
+	if (err) {
+		LOG_ERR("smf_run_state, error: %d", err);
+		SEND_FATAL_ERROR();
+		return;
+	}
+}
+
 static int app_init(void)
 {
-	/* Setup handler for date_time library */
-	date_time_register_handler(date_time_handler);
+	app_state.interval_sec = CONFIG_APP_MODULE_TRIGGER_TIMEOUT_SECONDS;
+
+	STATE_SET_INITIAL(app_state, STATE_INIT);
 
 	return 0;
 }