modules: environmental: channel def in module header

Environmental channel definition into dedicated header.

Signed-off-by: Giacomo Dematteis <giacomo.dematteis@nordicsemi.no>

Author: DematteisGiacomo

app/src/common/message_channel.c

@@ -18,14 +18,6 @@ ZBUS_CHAN_DEFINE(TRIGGER_CHAN,
 		 ZBUS_MSG_INIT(0)
 );
 
-ZBUS_CHAN_DEFINE(ENVIRONMENTAL_CHAN,
-		 struct environmental_msg,
-		 NULL,
-		 NULL,
-		 ZBUS_OBSERVERS_EMPTY,
-		 ZBUS_MSG_INIT(0)
-);
-
 ZBUS_CHAN_DEFINE(ERROR_CHAN,
 		 enum error_type,
 		 NULL,

app/src/common/message_channel.h

@@ -48,39 +48,6 @@ extern "C" {
 	k_sleep(K_SECONDS(10));							\
 } while (0)
 
-/** ENVIRONMENTAL MODULE */
-
-enum environmental_msg_type {
-	/* Output message types */
-
-	/* Response message to a request for current environmental sensor values.
-	 * The sampled values are found in the respective fields of the message structure.
-	 */
-	ENVIRONMENTAL_SENSOR_SAMPLE_RESPONSE = 0x1,
-
-	/* Input message types */
-
-	/* Request to sample the current environmental sensor values.
-	 * The response is sent as a ENVIRONMENTAL_SENSOR_SAMPLE_RESPONSE message.
-	 */
-	ENVIRONMENTAL_SENSOR_SAMPLE_REQUEST,
-};
-
-struct environmental_msg {
-	enum environmental_msg_type type;
-
-	/** Contains the current temperature in celsius. */
-	double temperature;
-
-	/** Contains the current humidity in percentage. */
-	double humidity;
-
-	/** Contains the current pressure in Pa. */
-	double pressure;
-};
-
-#define MSG_TO_ENVIRONMENTAL_MSG(_msg)	(*(const struct environmental_msg *)_msg)
-
 enum trigger_type {
 	TRIGGER_POLL_SHADOW = 0x1,
 	TRIGGER_FOTA_POLL,
@@ -124,7 +91,6 @@ ZBUS_CHAN_DECLARE(
 	CONFIG_CHAN,
 	ERROR_CHAN,
 	TIME_CHAN,
-	ENVIRONMENTAL_CHAN,
 	TRIGGER_CHAN
 );
 

app/src/modules/app/app.c

@@ -15,6 +15,7 @@
 #include "message_channel.h"
 #include "button.h"
 #include "network.h"
+#include "environmental.h"
 
 #if defined(CONFIG_APP_BATTERY)
 #include "battery.h"

app/src/modules/cloud/cloud_module.c

@@ -23,6 +23,7 @@
 #if defined(CONFIG_APP_BATTERY)
 #include "battery.h"
 #endif /* CONFIG_APP_BATTERY */
+#include "environmental.h"
 
 /* Register log module */
 LOG_MODULE_REGISTER(cloud, CONFIG_APP_CLOUD_LOG_LEVEL);

app/src/modules/environmental/CMakeLists.txt

@@ -7,3 +7,4 @@
 target_sources_ifdef(CONFIG_APP_ENVIRONMENTAL app PRIVATE
 	${CMAKE_CURRENT_SOURCE_DIR}/environmental.c
 )
+target_include_directories(app PRIVATE .)

app/src/modules/environmental/environmental.c

@@ -15,10 +15,20 @@
 
 #include "message_channel.h"
 #include "modules_common.h"
+#include "environmental.h"
 
 /* Register log module */
 LOG_MODULE_REGISTER(environmental_module, CONFIG_APP_ENVIRONMENTAL_LOG_LEVEL);
 
+/* Define channels provided by this module */
+ZBUS_CHAN_DEFINE(ENVIRONMENTAL_CHAN,
+		 struct environmental_msg,
+		 NULL,
+		 NULL,
+		 ZBUS_OBSERVERS_EMPTY,
+		 ZBUS_MSG_INIT(0)
+);
+
 /* Register subscriber */
 ZBUS_MSG_SUBSCRIBER_DEFINE(environmental);
 

app/src/modules/environmental/environmental.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#ifndef _ENVIRONMENTAL_H_
+#define _ENVIRONMENTAL_H_
+
+#include <zephyr/kernel.h>
+#include <zephyr/zbus/zbus.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/* Channels provided by this module */
+ZBUS_CHAN_DECLARE(
+	ENVIRONMENTAL_CHAN
+);
+
+enum environmental_msg_type {
+	/* Output message types */
+
+	/* Response message to a request for current environmental sensor values.
+	 * The sampled values are found in the respective fields of the message structure.
+	 */
+	ENVIRONMENTAL_SENSOR_SAMPLE_RESPONSE = 0x1,
+
+	/* Input message types */
+
+	/* Request to sample the current environmental sensor values.
+	 * The response is sent as a ENVIRONMENTAL_SENSOR_SAMPLE_RESPONSE message.
+	 */
+	ENVIRONMENTAL_SENSOR_SAMPLE_REQUEST,
+};
+
+struct environmental_msg {
+	enum environmental_msg_type type;
+
+	/** Contains the current temperature in celsius. */
+	double temperature;
+
+	/** Contains the current humidity in percentage. */
+	double humidity;
+
+	/** Contains the current pressure in Pa. */
+	double pressure;
+};
+
+#define MSG_TO_ENVIRONMENTAL_MSG(_msg)	(*(const struct environmental_msg *)_msg)
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _ENVIRONMENTAL_H_ */

tests/module/app/CMakeLists.txt

@@ -28,6 +28,8 @@ zephyr_include_directories(../../../app/src/modules/cloud)
 zephyr_include_directories(../../../app/src/modules/battery)
 zephyr_include_directories(../../../app/src/modules/button)
 zephyr_include_directories(../../../app/src/modules/network)
+zephyr_include_directories(../../../app/src/modules/environmental)
+
 
 target_link_options(app PRIVATE --whole-archive)
 

tests/module/app/src/main.c

@@ -15,6 +15,7 @@
 #include "message_channel.h"
 #include "battery.h"
 #include "network.h"
+#include "environmental.h"
 
 #include "checks.h"
 
@@ -47,6 +48,13 @@ ZBUS_CHAN_DEFINE(CLOUD_CHAN,
 		 ZBUS_OBSERVERS_EMPTY,
 		 ZBUS_MSG_INIT(CLOUD_DISCONNECTED)
 );
+ZBUS_CHAN_DEFINE(ENVIRONMENTAL_CHAN,
+		 struct environmental_msg,
+		 NULL,
+		 NULL,
+		 ZBUS_OBSERVERS_EMPTY,
+		 ZBUS_MSG_INIT(0)
+);
 
 DEFINE_FFF_GLOBALS;
 

tests/module/cloud/CMakeLists.txt

@@ -24,6 +24,7 @@ zephyr_include_directories(../../../app/src/modules/cloud)
 zephyr_include_directories(../../../app/src/common)
 zephyr_include_directories(../../../app/src/modules/battery)
 zephyr_include_directories(../../../app/src/modules/network)
+zephyr_include_directories(../../../app/src/modules/environmental)
 zephyr_include_directories(${NRF_DIR}/subsys/net/lib/nrf_cloud/include)
 zephyr_include_directories(${NRF_DIR}/../modules/lib/cjson)
 

tests/module/cloud/src/cloud_module_test.c

@@ -9,6 +9,7 @@
 #include "message_channel.h"
 #include "battery.h"
 #include "network.h"
+#include "environmental.h"
 #include <zephyr/task_wdt/task_wdt.h>
 
 DEFINE_FFF_GLOBALS;
@@ -28,6 +29,13 @@ ZBUS_CHAN_DEFINE(NETWORK_CHAN,
 		 ZBUS_OBSERVERS_EMPTY,
 		 ZBUS_MSG_INIT(.type = NETWORK_DISCONNECTED)
 );
+ZBUS_CHAN_DEFINE(ENVIRONMENTAL_CHAN,
+		 struct environmental_msg,
+		 NULL,
+		 NULL,
+		 ZBUS_OBSERVERS_EMPTY,
+		 ZBUS_MSG_INIT(0)
+);
 
 FAKE_VALUE_FUNC(int, task_wdt_feed, int);
 FAKE_VALUE_FUNC(int, task_wdt_add, uint32_t, task_wdt_callback_t, void *);

tests/module/environmental/CMakeLists.txt

@@ -25,6 +25,7 @@ zephyr_include_directories(${ZEPHYR_BASE}/include/zephyr/)
 zephyr_include_directories(${ZEPHYR_BASE}/subsys/testsuite/include)
 zephyr_include_directories(../../../app/src/common)
 zephyr_include_directories(../../../app/src/modules/cloud)
+zephyr_include_directories(../../../app/src/modules/environmental)
 
 target_link_options(app PRIVATE --whole-archive)
 # Options that cannot be passed through Kconfig fragments

tests/module/environmental/src/main.c

@@ -11,6 +11,7 @@
 #include <zephyr/logging/log.h>
 
 #include "message_channel.h"
+#include "environmental.h"
 
 DEFINE_FFF_GLOBALS;