modules: battery: channel definition into per-module header

Separating battery channel definition into dedicated per-module header.

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

Author: DematteisGiacomo

app/src/common/message_channel.c

@@ -42,14 +42,6 @@ ZBUS_CHAN_DEFINE(NETWORK_CHAN,
 		 ZBUS_MSG_INIT(.type = NETWORK_DISCONNECTED)
 );
 
-ZBUS_CHAN_DEFINE(BATTERY_CHAN,
-		 struct battery_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

@@ -175,32 +175,7 @@ struct network_msg {
 
 #define MSG_TO_NETWORK_MSG(_msg)	(*(const struct network_msg *)_msg)
 
-/** BATTERY MODULE */
 
-enum battery_msg_type {
-	/* Output message types */
-
-	/* Response message to a request for a battery percentage sample. The sample is found in the
-	 * .percentage field of the message.
-	 */
-	BATTERY_PERCENTAGE_SAMPLE_RESPONSE = 0x1,
-
-	/* Input message types */
-
-	/* Request to retrieve the current battery percentage. The response is sent as a
-	 * BATTERY_PERCENTAGE_SAMPLE_RESPONSE message.
-	 */
-	BATTERY_PERCENTAGE_SAMPLE_REQUEST,
-};
-
-struct battery_msg {
-	enum battery_msg_type type;
-
-	/** Contains the current charge of the battery in percentage. */
-	double percentage;
-};
-
-#define MSG_TO_BATTERY_MSG(_msg)	(*(const struct battery_msg *)_msg)
 
 enum trigger_type {
 	TRIGGER_POLL_SHADOW = 0x1,
@@ -278,7 +253,6 @@ ZBUS_CHAN_DECLARE(
 	FOTA_STATUS_CHAN,
 	LED_CHAN,
 	NETWORK_CHAN,
-	BATTERY_CHAN,
 	TIME_CHAN,
 	TRIGGER_CHAN,
 	TRIGGER_MODE_CHAN,

app/src/modules/app/app.c

@@ -13,6 +13,7 @@
 
 #include "modules_common.h"
 #include "message_channel.h"
+#include "battery.h"
 
 /* Register log module */
 LOG_MODULE_REGISTER(app, CONFIG_APP_LOG_LEVEL);

app/src/modules/battery/CMakeLists.txt

@@ -5,3 +5,4 @@
 #
 
 target_sources(app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/battery.c)
+target_include_directories(app PRIVATE .)

app/src/modules/battery/battery.c

@@ -18,13 +18,23 @@
 #include "lp803448_model.h"
 #include "message_channel.h"
 #include "modules_common.h"
+#include "battery.h"
 
 /* Register log module */
 LOG_MODULE_REGISTER(battery, CONFIG_APP_BATTERY_LOG_LEVEL);
 
 /* Register subscriber */
 ZBUS_MSG_SUBSCRIBER_DEFINE(battery);
 
+/* Define channels provided by this module */
+ZBUS_CHAN_DEFINE(BATTERY_CHAN,
+		 struct battery_msg,
+		 NULL,
+		 NULL,
+		 ZBUS_OBSERVERS_EMPTY,
+		 ZBUS_MSG_INIT(0)
+);
+
 /* Observe channels */
 ZBUS_CHAN_ADD_OBS(BATTERY_CHAN, battery, 0);
 

app/src/modules/battery/battery.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#ifndef _BATTERY_H_
+#define _BATTERY_H_
+
+#include <zephyr/kernel.h>
+#include <zephyr/zbus/zbus.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Channels provided by this module */
+ZBUS_CHAN_DECLARE(
+	BATTERY_CHAN
+);
+
+enum battery_msg_type {
+	/* Output message types */
+
+	/* Response message to a request for a battery percentage sample. The sample is found in the
+	 * .percentage field of the message.
+	 */
+	BATTERY_PERCENTAGE_SAMPLE_RESPONSE = 0x1,
+
+	/* Input message types */
+
+	/* Request to retrieve the current battery percentage. The response is sent as a
+	 * BATTERY_PERCENTAGE_SAMPLE_RESPONSE message.
+	 */
+	BATTERY_PERCENTAGE_SAMPLE_REQUEST,
+};
+
+struct battery_msg {
+	enum battery_msg_type type;
+
+	/** Contains the current charge of the battery in percentage. */
+	double percentage;
+};
+
+#define MSG_TO_BATTERY_MSG(_msg)	(*(const struct battery_msg *)_msg)
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _BATTERY_H_ */

app/src/modules/button/button.c

@@ -11,6 +11,7 @@
 #include <date_time.h>
 
 #include "message_channel.h"
+#include "battery.h"
 
 /* Register log module */
 LOG_MODULE_REGISTER(button, CONFIG_APP_BUTTON_LOG_LEVEL);

app/src/modules/cloud/cloud_module.c

@@ -19,6 +19,7 @@
 
 #include "modules_common.h"
 #include "message_channel.h"
+#include "battery.h"
 
 /* Register log module */
 LOG_MODULE_REGISTER(cloud, CONFIG_APP_CLOUD_LOG_LEVEL);

tests/module/app/CMakeLists.txt

@@ -27,6 +27,7 @@ zephyr_include_directories(${ZEPHYR_BASE}/subsys/testsuite/include)
 zephyr_include_directories(../../../app/src/common)
 zephyr_include_directories(../../../app/src/modules/cloud)
 zephyr_include_directories(${NRF_DIR}/subsys/net/lib/nrf_cloud/include)
+zephyr_include_directories(../../../app/src/modules/battery)
 zephyr_include_directories(${NRF_DIR}/../modules/lib/cjson)
 
 target_link_options(app PRIVATE --whole-archive)

tests/module/app/src/checks.c

@@ -7,6 +7,7 @@
 #include <zephyr/zbus/zbus.h>
 #include <zephyr/logging/log.h>
 #include "message_channel.h"
+#include "battery.h"
 
 #include "checks.h"
 

tests/module/app/src/main.c

@@ -13,9 +13,19 @@
 
 #include "dk_buttons_and_leds.h"
 #include "message_channel.h"
+#include "battery.h"
 
 #include "checks.h"
 
+/* Define the channels for testing */
+ZBUS_CHAN_DEFINE(BATTERY_CHAN,
+		 struct battery_msg,
+		 NULL,
+		 NULL,
+		 ZBUS_OBSERVERS_EMPTY,
+		 ZBUS_MSG_INIT(0)
+);
+
 DEFINE_FFF_GLOBALS;
 
 #define HOUR_IN_SECONDS	3600

tests/module/battery/CMakeLists.txt

@@ -28,6 +28,7 @@ zephyr_include_directories(${ZEPHYR_NRFXLIB_MODULE_DIR}/nrf_fuel_gauge/include/)
 zephyr_include_directories(${ZEPHYR_BASE}/subsys/testsuite/include)
 zephyr_include_directories(${ASSET_TRACKER_TEMPLATE_DIR}/app/src/common)
 zephyr_include_directories(${ASSET_TRACKER_TEMPLATE_DIR}/app/src/modules/cloud)
+zephyr_include_directories(${ASSET_TRACKER_TEMPLATE_DIR}/app/src/modules/battery)
 
 # Options that cannot be passed through Kconfig fragments
 target_compile_definitions(app PRIVATE

tests/module/battery/src/main.c

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

tests/module/button/CMakeLists.txt

@@ -22,6 +22,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/battery)
 
 target_link_options(app PRIVATE --whole-archive)
 # Options that cannot be passed through Kconfig fragments

tests/module/button/src/main.c

@@ -10,6 +10,7 @@
 #include <zephyr/logging/log.h>
 
 #include "message_channel.h"
+#include "battery.h"
 
 #include <dk_buttons_and_leds.h>
 #include <date_time.h>

tests/module/cloud/CMakeLists.txt

@@ -22,6 +22,7 @@ zephyr_include_directories(${ZEPHYR_BASE}/include/zephyr/)
 zephyr_include_directories(${ZEPHYR_BASE}/subsys/testsuite/include)
 zephyr_include_directories(../../../app/src/modules/cloud)
 zephyr_include_directories(../../../app/src/common)
+zephyr_include_directories(../../../app/src/modules/battery)
 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

@@ -7,10 +7,20 @@
 
 #include <zephyr/fff.h>
 #include "message_channel.h"
+#include "battery.h"
 #include <zephyr/task_wdt/task_wdt.h>
 
 DEFINE_FFF_GLOBALS;
 
+/* Define the channels for testing */
+ZBUS_CHAN_DEFINE(BATTERY_CHAN,
+		 struct battery_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 *);
 FAKE_VALUE_FUNC(int, nrf_cloud_client_id_get, char *, size_t);