applications: machine_learning: Rename ml_state to ml_app_mode

Emil Obalski · rlubos · commit b3f47cf78eff · 2022-01-20T09:49:39.000+01:00
ml_mode module is a module responsible for changing the application
mode between running the AI model and forwarding data.

This change makes its naming meaningful.

Jira: NCSDK-12535

Signed-off-by: Emil Obalski &lt;emil.obalski@nordicsemi.no&gt;
diff --git a/applications/machine_learning/README.rst b/applications/machine_learning/README.rst
@@ -540,8 +540,8 @@ The nRF Machine Learning application also uses the following dedicated applicati
   The module runs the machine learning model and provides results only if there is an active subsriber.
   An application module can inform that it is actively listening for results using :c:struct:`ml_result_signin_event`.
 
-``ml_state``
-  The module controls switching between running the machine learning model and forwarding the data.
+``ml_app_mode``
+  The module controls Application mode. It switches between running the machine learning model and forwarding the data.
   The change is triggered by a long press of the button defined in the module's configuration.
 
 ``sensor_sim_ctrl``
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/click_detector_def.h b/applications/machine_learning/configuration/nrf52840dk_nrf52840/click_detector_def.h
@@ -18,7 +18,7 @@ const struct {} click_detector_def_include_once;
 
 static const struct click_detector_config click_detector_config[] = {
 	{
-		.key_id = CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID,
+		.key_id = CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID,
 		.consume_button_event = true,
 	},
 };
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj.conf b/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj.conf
@@ -19,8 +19,8 @@ CONFIG_ML_APP_SENSOR_SIM_CTRL=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON_ID=0x0002
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=900
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_nus.conf b/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_nus.conf
@@ -24,8 +24,8 @@ CONFIG_ML_APP_SENSOR_SIM_CTRL=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON_ID=0x0002
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=900
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_release.conf b/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_release.conf
@@ -19,8 +19,8 @@ CONFIG_ML_APP_SENSOR_SIM_CTRL=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON_ID=0x0002
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=900
diff --git a/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/click_detector_def.h b/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/click_detector_def.h
@@ -18,7 +18,7 @@ const struct {} click_detector_def_include_once;
 
 static const struct click_detector_config click_detector_config[] = {
 	{
-		.key_id = CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID,
+		.key_id = CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID,
 		.consume_button_event = true,
 	},
 };
diff --git a/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/prj.conf b/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/prj.conf
@@ -19,8 +19,8 @@ CONFIG_ML_APP_SENSOR_SIM_CTRL=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON=y
 CONFIG_ML_APP_SENSOR_SIM_CTRL_TRIG_BUTTON_ID=0x0002
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=900
diff --git a/applications/machine_learning/configuration/thingy52_nrf52832/click_detector_def.h b/applications/machine_learning/configuration/thingy52_nrf52832/click_detector_def.h
@@ -18,7 +18,7 @@ const struct {} click_detector_def_include_once;
 
 static const struct click_detector_config click_detector_config[] = {
 	{
-		.key_id = CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID,
+		.key_id = CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID,
 		.consume_button_event = true,
 	},
 };
diff --git a/applications/machine_learning/configuration/thingy52_nrf52832/prj.conf b/applications/machine_learning/configuration/thingy52_nrf52832/prj.conf
@@ -22,8 +22,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_CAF=y
 
diff --git a/applications/machine_learning/configuration/thingy52_nrf52832/prj_release.conf b/applications/machine_learning/configuration/thingy52_nrf52832/prj_release.conf
@@ -22,8 +22,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_CAF=y
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/click_detector_def.h b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/click_detector_def.h
@@ -18,7 +18,7 @@ const struct {} click_detector_def_include_once;
 
 static const struct click_detector_config click_detector_config[] = {
 	{
-		.key_id = CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID,
+		.key_id = CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID,
 		.consume_button_event = true,
 	},
 };
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj.conf
@@ -22,8 +22,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_ML_APP_USB_STATE=y
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_release.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_release.conf
@@ -22,8 +22,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_CAF=y
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_rtt.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_rtt.conf
@@ -26,8 +26,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_CAF=y
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/click_detector_def.h b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/click_detector_def.h
@@ -18,7 +18,7 @@ const struct {} click_detector_def_include_once;
 
 static const struct click_detector_config click_detector_config[] = {
 	{
-		.key_id = CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID,
+		.key_id = CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID,
 		.consume_button_event = true,
 	},
 };
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj.conf
@@ -22,8 +22,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_ML_APP_USB_STATE=y
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj_release.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj_release.conf
@@ -22,8 +22,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_CAF=y
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj_rtt.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj_rtt.conf
@@ -26,8 +26,8 @@ CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=0
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=10
 
-CONFIG_ML_APP_ML_STATE=y
-CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID=0x0000
+CONFIG_ML_APP_MODE=y
+CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID=0x0000
 
 CONFIG_CAF=y
 
diff --git a/applications/machine_learning/src/events/CMakeLists.txt b/applications/machine_learning/src/events/CMakeLists.txt
@@ -12,8 +12,8 @@ target_sources_ifdef(CONFIG_ML_APP_ML_RESULT_EVENTS app PRIVATE
 	${CMAKE_CURRENT_SOURCE_DIR}/ml_result_event.c
 )
 
-target_sources_ifdef(CONFIG_ML_APP_ML_STATE_EVENTS app PRIVATE
-	${CMAKE_CURRENT_SOURCE_DIR}/ml_state_event.c
+target_sources_ifdef(CONFIG_ML_APP_MODE_EVENTS app PRIVATE
+	${CMAKE_CURRENT_SOURCE_DIR}/ml_app_mode_event.c
 )
 
 target_sources_ifdef(CONFIG_ML_APP_SENSOR_SIM_EVENTS app PRIVATE
diff --git a/applications/machine_learning/src/events/Kconfig b/applications/machine_learning/src/events/Kconfig
@@ -30,12 +30,12 @@ config ML_APP_INIT_LOG_ML_RESULT_SIGNIN_EVENTS
 	depends on LOG
 	default y
 
-config ML_APP_ML_STATE_EVENTS
-	bool "Enable machine learning state events"
+config ML_APP_MODE_EVENTS
+	bool "Enable machine learning mode events"
 
-config ML_APP_INIT_LOG_ML_STATE_EVENTS
-	bool "Log machine learning state events"
-	depends on ML_APP_ML_STATE_EVENTS
+config ML_APP_INIT_LOG_ML_APP_MODE_EVENTS
+	bool "Log machine learning mode events"
+	depends on ML_APP_MODE_EVENTS
 	depends on LOG
 	default y
 
diff --git a/applications/machine_learning/src/events/ml_app_mode_event.c b/applications/machine_learning/src/events/ml_app_mode_event.c
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <stdio.h>
+
+#include "ml_app_mode_event.h"
+
+static const char * const ml_app_mode_name[] = {
+	[ML_APP_MODE_MODEL_RUNNING] = "MODEL_RUNNING",
+	[ML_APP_MODE_DATA_FORWARDING] = "DATA_FORWARDING",
+};
+
+static int log_ml_app_mode_event(const struct event_header *eh, char *buf, size_t buf_len)
+{
+	const struct ml_app_mode_event *event = cast_ml_app_mode_event(eh);
+
+	BUILD_ASSERT(ARRAY_SIZE(ml_app_mode_name) == ML_APP_MODE_COUNT);
+	__ASSERT_NO_MSG(event->mode < ML_APP_MODE_COUNT);
+	__ASSERT_NO_MSG(ml_app_mode_name[event->mode] != NULL);
+
+	return snprintf(buf, buf_len, "state: %s", ml_app_mode_name[event->mode]);
+}
+
+EVENT_TYPE_DEFINE(ml_app_mode_event,
+		  IS_ENABLED(CONFIG_ML_APP_INIT_LOG_ML_APP_MODE_EVENTS),
+		  log_ml_app_mode_event,
+		  NULL);
diff --git a/applications/machine_learning/src/events/ml_app_mode_event.h b/applications/machine_learning/src/events/ml_app_mode_event.h
@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#ifndef _ML_APP_MODE_EVENT_H_
+#define _ML_APP_MODE_EVENT_H_
+
+/**
+ * @brief Machine Learning Application Mode Event
+ * @defgroup ml_app_mode_event Machine Learning Application Mode Event
+ * @{
+ */
+
+#include <event_manager.h>
+#include <event_manager_profiler_tracer.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** @brief Machine learning application modes. */
+enum ml_app_mode {
+	ML_APP_MODE_MODEL_RUNNING,
+	ML_APP_MODE_DATA_FORWARDING,
+
+	ML_APP_MODE_COUNT
+};
+
+
+/** @brief Machine learning application mode event. */
+struct ml_app_mode_event {
+	struct event_header header; /**< Event header. */
+
+	enum ml_app_mode mode; /**< Machine learning application mode. */
+};
+
+
+EVENT_TYPE_DECLARE(ml_app_mode_event);
+
+#ifdef __cplusplus
+}
+#endif
+
+/**
+ * @}
+ */
+
+#endif /* _ML_APP_MODE_EVENT_H_ */
diff --git a/applications/machine_learning/src/events/ml_state_event.c b/applications/machine_learning/src/events/ml_state_event.c
diff --git a/applications/machine_learning/src/events/ml_state_event.h b/applications/machine_learning/src/events/ml_state_event.h
diff --git a/applications/machine_learning/src/modules/CMakeLists.txt b/applications/machine_learning/src/modules/CMakeLists.txt
@@ -19,8 +19,8 @@ target_sources_ifdef(CONFIG_ML_APP_LED_STATE
 target_sources_ifdef(CONFIG_ML_APP_ML_RUNNER
 		     app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/ml_runner.c)
 
-target_sources_ifdef(CONFIG_ML_APP_ML_STATE
-		     app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/ml_state.c)
+target_sources_ifdef(CONFIG_ML_APP_MODE
+		     app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/ml_app_mode.c)
 
 target_sources_ifdef(CONFIG_ML_APP_USB_STATE
 		     app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/usb_state.c)
diff --git a/applications/machine_learning/src/modules/Kconfig b/applications/machine_learning/src/modules/Kconfig
diff --git a/applications/machine_learning/src/modules/Kconfig.led_state b/applications/machine_learning/src/modules/Kconfig.led_state
diff --git a/applications/machine_learning/src/modules/Kconfig.ml_app_mode b/applications/machine_learning/src/modules/Kconfig.ml_app_mode
diff --git a/applications/machine_learning/src/modules/ei_data_forwarder_bt_nus.c b/applications/machine_learning/src/modules/ei_data_forwarder_bt_nus.c
diff --git a/applications/machine_learning/src/modules/ei_data_forwarder_uart.c b/applications/machine_learning/src/modules/ei_data_forwarder_uart.c
diff --git a/applications/machine_learning/src/modules/led_state.c b/applications/machine_learning/src/modules/led_state.c
diff --git a/applications/machine_learning/src/modules/ml_app_mode.c b/applications/machine_learning/src/modules/ml_app_mode.c
diff --git a/applications/machine_learning/src/modules/ml_runner.c b/applications/machine_learning/src/modules/ml_runner.c
diff --git a/doc/nrf/releases/release-notes-changelog.rst b/doc/nrf/releases/release-notes-changelog.rst

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ const struct {} click_detector_def_include_once;`
`18`	`18`
`19`	`19`	`static const struct click_detector_config click_detector_config[] = {`
`20`	`20`	`{`
`21`		`- .key_id = CONFIG_ML_APP_ML_STATE_CONTROL_BUTTON_ID,`
	`21`	`+ .key_id = CONFIG_ML_APP_MODE_CONTROL_BUTTON_ID,`
`22`	`22`	`.consume_button_event = true,`
`23`	`23`	`},`
`24`	`24`	`};`