applications: machine_learning: Add App specific event descr option

Emil Obalski · rlubos · commit 484b2246c594 · 2022-01-20T15:10:15.000+01:00
This change adds default Application specific Kconfig option that
defines sensor event descriptor that application modules are listening
to.

This commit also makes use of this option in machine_learning
application.

Signed-off-by: Emil Obalski &lt;emil.obalski@nordicsemi.no&gt;
diff --git a/applications/machine_learning/Kconfig b/applications/machine_learning/Kconfig
@@ -5,6 +5,7 @@
 #
 
 menu "Machine learning application"
+rsource "src/Kconfig.ml_app"
 rsource "src/events/Kconfig"
 rsource "src/modules/Kconfig"
 endmenu
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj.conf b/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj.conf
@@ -6,12 +6,12 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_sim_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_UART=y
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 
 CONFIG_ML_APP_ML_RUNNER=y
-CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=1
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=0
 
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_nus.conf b/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_nus.conf
@@ -9,14 +9,14 @@
 # This ZDebug build type configuration uses Bluetooth NUS for data forwarding instead of the default UART.
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_sim_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 
 CONFIG_ML_APP_ML_RUNNER=y
-CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=1
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=0
 
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_release.conf b/applications/machine_learning/configuration/nrf52840dk_nrf52840/prj_release.conf
@@ -6,12 +6,12 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_sim_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_UART=y
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 
 CONFIG_ML_APP_ML_RUNNER=y
-CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=1
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=0
 
diff --git a/applications/machine_learning/configuration/nrf52840dk_nrf52840/sensor_manager_def.h b/applications/machine_learning/configuration/nrf52840dk_nrf52840/sensor_manager_def.h
@@ -34,7 +34,7 @@ static const struct sm_sampled_channel accel_chan[] = {
 static const struct sm_sensor_config sensor_configs[] = {
 	{
 		.dev_name = CONFIG_SENSOR_SIM_DEV_NAME,
-		.event_descr = "accel_sim_xyz",
+		.event_descr = CONFIG_ML_APP_SENSOR_EVENT_DESCR,
 		.chans = accel_chan,
 		.chan_cnt = ARRAY_SIZE(accel_chan),
 		.sampling_period_ms = 20,
diff --git a/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/prj.conf b/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/prj.conf
@@ -6,12 +6,12 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESC="accel_sim_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_UART=y
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 
 CONFIG_ML_APP_ML_RUNNER=y
-CONFIG_ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR="accel_sim_xyz"
 CONFIG_ML_APP_ML_RUNNER_WINDOW_SHIFT=1
 CONFIG_ML_APP_ML_RUNNER_FRAME_SHIFT=0
 
diff --git a/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/sensor_manager_def.h b/applications/machine_learning/configuration/nrf5340dk_nrf5340_cpuapp/sensor_manager_def.h
@@ -34,7 +34,7 @@ static const struct sm_sampled_channel accel_chan[] = {
 static const struct sm_sensor_config sensor_configs[] = {
 	{
 		.dev_name = CONFIG_SENSOR_SIM_DEV_NAME,
-		.event_descr = "accel_sim_xyz",
+		.event_descr = CONFIG_ML_APP_SENSOR_EVENT_DESCR,
 		.chans = accel_chan,
 		.chan_cnt = ARRAY_SIZE(accel_chan),
 		.sampling_period_ms = 20,
diff --git a/applications/machine_learning/configuration/thingy52_nrf52832/prj.conf b/applications/machine_learning/configuration/thingy52_nrf52832/prj.conf
@@ -6,19 +6,19 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESC="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
diff --git a/applications/machine_learning/configuration/thingy52_nrf52832/prj_release.conf b/applications/machine_learning/configuration/thingy52_nrf52832/prj_release.conf
@@ -6,19 +6,19 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESC="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
diff --git a/applications/machine_learning/configuration/thingy52_nrf52832/sensor_manager_def.h b/applications/machine_learning/configuration/thingy52_nrf52832/sensor_manager_def.h
@@ -26,7 +26,7 @@ static const struct sm_sampled_channel accel_chan[] = {
 static const struct sm_sensor_config sensor_configs[] = {
 	{
 		.dev_name = "LIS2DH12-ACCEL",
-		.event_descr = "accel_xyz",
+		.event_descr = CONFIG_ML_APP_SENSOR_EVENT_DESCR,
 		.chans = accel_chan,
 		.chan_cnt = ARRAY_SIZE(accel_chan),
 		.sampling_period_ms = 20,
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj.conf
@@ -6,19 +6,19 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_release.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_release.conf
@@ -6,19 +6,19 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_rtt.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/prj_rtt.conf
@@ -10,19 +10,19 @@
 #
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/sensor_manager_def.h b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp/sensor_manager_def.h
@@ -41,7 +41,7 @@ static const struct sm_sampled_channel accel_chan[] = {
 static const struct sm_sensor_config sensor_configs[] = {
 	{
 		.dev_name = "ADXL362",
-		.event_descr = "accel_xyz",
+		.event_descr = CONFIG_ML_APP_SENSOR_EVENT_DESCR,
 		.chans = accel_chan,
 		.chan_cnt = ARRAY_SIZE(accel_chan),
 		.sampling_period_ms = 20,
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj.conf b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/prj.conf
@@ -6,19 +6,19 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
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
@@ -6,19 +6,19 @@
 ################################################################################
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
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
@@ -10,19 +10,19 @@
 #
 # Application configuration
 
+CONFIG_ML_APP_SENSOR_EVENT_DESCR="accel_xyz"
+
 CONFIG_ML_APP_EI_DATA_FORWARDER=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_BT_NUS=y
 CONFIG_ML_APP_EI_DATA_FORWARDER_PIPELINE_COUNT=3
 CONFIG_ML_APP_EI_DATA_FORWARDER_BUF_COUNT=6
-CONFIG_ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR="accel_xyz"
 
 CONFIG_ML_APP_LED_STATE=y
 CONFIG_ML_APP_LED_STATE_VALUE_THRESH=700
 CONFIG_ML_APP_LED_STATE_ANOMALY_THRESH=300
 CONFIG_ML_APP_LED_STATE_PREDICTION_STREAK_THRESH=3
 
 CONFIG_ML_APP_ML_RUNNER=y
-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
 
diff --git a/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/sensor_manager_def.h b/applications/machine_learning/configuration/thingy53_nrf5340_cpuapp_ns/sensor_manager_def.h
@@ -41,7 +41,7 @@ static const struct sm_sampled_channel accel_chan[] = {
 static const struct sm_sensor_config sensor_configs[] = {
 	{
 		.dev_name = "ADXL362",
-		.event_descr = "accel_xyz",
+		.event_descr = CONFIG_ML_APP_SENSOR_EVENT_DESCR,
 		.chans = accel_chan,
 		.chan_cnt = ARRAY_SIZE(accel_chan),
 		.sampling_period_ms = 20,
diff --git a/applications/machine_learning/src/Kconfig.ml_app b/applications/machine_learning/src/Kconfig.ml_app
@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2022 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+menu "Application options"
+
+config ML_APP_SENSOR_EVENT_DESCR
+	string "Description of handled sensor event"
+	default ""
+	help
+	  The application handles sensor events with predefined description.
+	  Other sensor events are ignored.
+
+endmenu
diff --git a/applications/machine_learning/src/modules/Kconfig.ei_data_forwarder b/applications/machine_learning/src/modules/Kconfig.ei_data_forwarder
@@ -31,7 +31,7 @@ endchoice
 
 config ML_APP_EI_DATA_FORWARDER_SENSOR_EVENT_DESCR
 	string "Description of forwarded sensor event"
-	default ""
+	default ML_APP_SENSOR_EVENT_DESCR
 	help
 	  The module forwards data related to sensor events with predefined description.
 	  Other sensor events are ignored.
diff --git a/applications/machine_learning/src/modules/Kconfig.ml_runner b/applications/machine_learning/src/modules/Kconfig.ml_runner
@@ -14,7 +14,7 @@ if ML_APP_ML_RUNNER
 
 config ML_APP_ML_RUNNER_SENSOR_EVENT_DESCR
 	string "Description of handled sensor event"
-	default ""
+	default ML_APP_SENSOR_EVENT_DESCR
 	help
 	  The module handles data related to sensor events with predefined description.
 	  Other sensor events are ignored.
diff --git a/doc/nrf/releases/release-notes-changelog.rst b/doc/nrf/releases/release-notes-changelog.rst
@@ -77,6 +77,10 @@ nRF9160: Asset Tracker v2
 nRF Machine Learning (Edge Impulse)
 -----------------------------------
 
+* Added:
+
+  * Added :kconfig:`CONFIG_ML_APP_SENSOR_EVENT_DESCR` option that globally defines sensor used by the application modules.
+
 * Updated:
 
   * Renamed ``ml_state`` module to ``ml_app_mode`` module.

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`#`
`6`	`6`
`7`	`7`	`menu "Machine learning application"`
	`8`	`+rsource "src/Kconfig.ml_app"`
`8`	`9`	`rsource "src/events/Kconfig"`
`9`	`10`	`rsource "src/modules/Kconfig"`
`10`	`11`	`endmenu`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ static const struct sm_sampled_channel accel_chan[] = {`
`34`	`34`	`static const struct sm_sensor_config sensor_configs[] = {`
`35`	`35`	`{`
`36`	`36`	`.dev_name = CONFIG_SENSOR_SIM_DEV_NAME,`
`37`		`- .event_descr = "accel_sim_xyz",`
	`37`	`+ .event_descr = CONFIG_ML_APP_SENSOR_EVENT_DESCR,`
`38`	`38`	`.chans = accel_chan,`
`39`	`39`	`.chan_cnt = ARRAY_SIZE(accel_chan),`
`40`	`40`	`.sampling_period_ms = 20,`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ static const struct sm_sampled_channel accel_chan[] = {`
`26`	`26`	`static const struct sm_sensor_config sensor_configs[] = {`
`27`	`27`	`{`
`28`	`28`	`.dev_name = "LIS2DH12-ACCEL",`
`29`		`- .event_descr = "accel_xyz",`
	`29`	`+ .event_descr = CONFIG_ML_APP_SENSOR_EVENT_DESCR,`
`30`	`30`	`.chans = accel_chan,`
`31`	`31`	`.chan_cnt = ARRAY_SIZE(accel_chan),`
`32`	`32`	`.sampling_period_ms = 20,`