docs: patches: Include dummy shell in module patch

simensrostad · jorgenmk · commit 59fd5bb80144 · 2025-04-28T14:29:52.000+02:00
Include dummy shell in module patch to show users how a module can
be updated to have a shell interface.

This also improves testability.

Signed-off-by: Simen S. Røstad &lt;simen.rostad@nordicsemi.no&gt;
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -157,13 +157,27 @@ jobs:
           version: ${{ env.VERSION }}
           path: asset-tracker-template/app
 
-    # Asset Tracker Template firmware build with patches for Thingy91x
+      # Asset Tracker Template debug firmware build
+      - name: Build thingy91x debug firmware
+        if: ${{ github.event_name != 'pull_request' }}
+        uses: ./asset-tracker-template/.github/actions/build-step
+        with:
+          memfault_project_key: ${{ secrets.MEMFAULT_PROJECT_KEY }}
+          memfault_fw_type: ${{ env.MEMFAULT_FW_TYPE }}
+          memfault_fw_version_prefix: ${{ env.MEMFAULT_FW_VERSION_PREFIX }}
+          board: thingy91x/nrf9151/ns
+          short_board: thingy91x
+          version: ${{ env.VERSION }}-debug
+          path: asset-tracker-template/app
+          debug: true
+
+      # Asset Tracker Template firmware build with patches for Thingy91x
       - name: Apply patches for Thingy91x firmware
         if: ${{ github.event_name != 'pull_request' }}
         run: |
           git apply docs/patches/magnetometer.patch
           git apply docs/patches/dummy-module.patch
-        working-directory: asset-tracker-template/app
+        working-directory: asset-tracker-template
 
       - name: Build patched thingy91x firmware
         if: ${{ github.event_name != 'pull_request' }}
@@ -174,20 +188,6 @@ jobs:
           version: ${{ env.VERSION }}-patched
           path: asset-tracker-template/app
 
-      # Asset Tracker Template debug firmware build
-      - name: Build thingy91x debug firmware
-        if: ${{ github.event_name != 'pull_request' }}
-        uses: ./asset-tracker-template/.github/actions/build-step
-        with:
-          memfault_project_key: ${{ secrets.MEMFAULT_PROJECT_KEY }}
-          memfault_fw_type: ${{ env.MEMFAULT_FW_TYPE }}
-          memfault_fw_version_prefix: ${{ env.MEMFAULT_FW_VERSION_PREFIX }}
-          board: thingy91x/nrf9151/ns
-          short_board: thingy91x
-          version: ${{ env.VERSION }}-debug
-          path: asset-tracker-template/app
-          debug: true
-
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
diff --git a/docs/patches/dummy-module.patch b/docs/patches/dummy-module.patch
@@ -7,19 +7,32 @@ index e1948cc..8d20bcd 100644
  add_subdirectory_ifdef(CONFIG_APP_CLOUD src/modules/cloud)
  add_subdirectory_ifdef(CONFIG_APP_FOTA src/modules/fota)
 +add_subdirectory_ifdef(CONFIG_APP_DUMMY src/modules/dummy)
+diff --git a/app/Kconfig b/app/Kconfig
+index dad4070..684fe73 100644
+--- a/app/Kconfig
++++ b/app/Kconfig
+@@ -15,6 +15,7 @@ rsource "src/modules/led/Kconfig.led"
+ rsource "src/modules/fota/Kconfig.fota"
+ rsource "src/modules/environmental/Kconfig.environmental"
+ rsource "src/modules/button/Kconfig.button"
++rsource "src/modules/dummy/Kconfig.dummy"
+ 
+ endmenu
+ 
 diff --git a/app/src/modules/dummy/CMakeLists.txt b/app/src/modules/dummy/CMakeLists.txt
 new file mode 100644
-index 0000000..a299b3b
+index 0000000..8b69448
 --- /dev/null
 +++ b/app/src/modules/dummy/CMakeLists.txt
-@@ -0,0 +1,8 @@
+@@ -0,0 +1,9 @@
 +#
 +# Copyright (c) 2025 Nordic Semiconductor ASA
 +#
 +# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 +#
 +
 +target_sources_ifdef(CONFIG_APP_DUMMY app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/dummy.c)
++target_sources_ifdef(CONFIG_APP_DUMMY app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/dummy_shell.c)
 +target_include_directories(app PRIVATE .)
 diff --git a/app/src/modules/dummy/Kconfig.dummy b/app/src/modules/dummy/Kconfig.dummy
 new file mode 100644
@@ -66,7 +79,7 @@ index 0000000..2319814
 +endif # APP_DUMMY
 diff --git a/app/src/modules/dummy/dummy.c b/app/src/modules/dummy/dummy.c
 new file mode 100644
-index 0000000..8c2450a
+index 0000000..c2733b5
 --- /dev/null
 +++ b/app/src/modules/dummy/dummy.c
 @@ -0,0 +1,162 @@
@@ -149,7 +162,7 @@ index 0000000..8c2450a
 +/* State machine handlers */
 +static void state_running_run(void *o)
 +{
-+	const struct dummy_state *state_object = (const struct dummy_state *)o;
++	struct dummy_state *state_object = (struct dummy_state *)o;
 +
 +	if (&DUMMY_CHAN == state_object->chan) {
 +		struct dummy_msg msg = MSG_TO_DUMMY_MSG(state_object->msg_buf);
@@ -279,3 +292,69 @@ index 0000000..4d3816e
 +#endif
 +
 +#endif /* _DUMMY_H_ */
+diff --git a/app/src/modules/dummy/dummy_shell.c b/app/src/modules/dummy/dummy_shell.c
+new file mode 100644
+index 0000000..9a82441
+--- /dev/null
++++ b/app/src/modules/dummy/dummy_shell.c
+@@ -0,0 +1,60 @@
++/*
++ * Copyright (c) 2025 Nordic Semiconductor ASA
++ *
++ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
++ */
++
++#include <zephyr/kernel.h>
++#include <zephyr/shell/shell.h>
++#include <zephyr/zbus/zbus.h>
++#include <zephyr/logging/log.h>
++
++#include "dummy.h"
++
++/* Register log module */
++LOG_MODULE_REGISTER(dummy_shell_module, CONFIG_APP_DUMMY_LOG_LEVEL);
++
++/* Forward declarations */
++static void dummy_shell_callback(const struct zbus_channel *chan);
++
++/* Register zbus callback */
++ZBUS_LISTENER_DEFINE(dummy_shell, dummy_shell_callback);
++
++/* Add subscriber to channel */
++ZBUS_CHAN_ADD_OBS(DUMMY_CHAN, dummy_shell, 0);
++
++/* Static variable to store shell reference */
++static const struct shell *dummy_shell_ref;
++
++/* Shell command handler for sending dummy request */
++static int cmd_dummy_request(const struct shell *shell, size_t argc, char **argv)
++{
++	struct dummy_msg request = {
++		.type = DUMMY_SAMPLE_REQUEST,
++	};
++
++	/* Store the shell reference */
++	dummy_shell_ref = shell;
++
++	int err = zbus_chan_pub(&DUMMY_CHAN, &request, K_SECONDS(1));
++	if (err) {
++		shell_error(shell, "Failed to send request: %d", err);
++		return err;
++	}
++
++	shell_print(shell, "Dummy request sent");
++	return 0;
++}
++
++/* Shell command handler for receiving dummy response */
++static void dummy_shell_callback(const struct zbus_channel *chan)
++{
++	const struct dummy_msg *response = zbus_chan_const_msg(chan);
++
++	if (response->type == DUMMY_SAMPLE_RESPONSE) {
++		shell_print(dummy_shell_ref, "Response received: %d", response->value);
++	}
++}
++
++/* Register shell command */
++SHELL_CMD_REGISTER(att_dummy_request, NULL, "Asset Tracker Template Dummy CMDs", cmd_dummy_request);
diff --git a/tests/on_target/tests/conftest.py b/tests/on_target/tests/conftest.py
@@ -167,3 +167,15 @@ def bin_file():
             return os.path.join(artifacts_dir, file)
 
     pytest.fail("No matching firmware .bin file found in the artifacts directory")
+
+@pytest.fixture(scope="session")
+def hex_file_patched():
+    # Search for the firmware hex file in the artifacts folder
+    artifacts_dir = "artifacts/"
+    hex_pattern = f"asset-tracker-template-{r"[0-9a-z\.]+"}-patched-{DUT_DEVICE_TYPE}-nrf91.hex"
+
+    for file in os.listdir(artifacts_dir):
+        if re.match(hex_pattern, file):
+            return os.path.join(artifacts_dir, file)
+
+    pytest.fail("No matching firmware .hex file found in the artifacts directory")
diff --git a/tests/on_target/tests/test_functional/test_patched.py b/tests/on_target/tests/test_functional/test_patched.py
@@ -14,15 +14,15 @@
 
 logger = get_logger()
 
-def test_patched_firmware(dut_board, hex_file):
+def test_patched_firmware(dut_board, hex_file_patched):
     """Test the patched firmware with magnetometer functionality."""
     # Only run this test for thingy91x devices
     devicetype = os.getenv("DUT_DEVICE_TYPE")
     if devicetype != "thingy91x":
         pytest.skip("This test is only for thingy91x devices")
 
     # Flash the patched firmware
-    flash_device(os.path.abspath(hex_file))
+    flash_device(os.path.abspath(hex_file_patched))
     dut_board.uart.xfactoryreset()
 
     # Log patterns to check
@@ -52,4 +52,8 @@ def test_patched_firmware(dut_board, hex_file):
     # These ranges are typical for magnetometer readings in microtesla
     assert -1000 <= x <= 1000, f"Magnetometer X value {x} out of expected range"
     assert -1000 <= y <= 1000, f"Magnetometer Y value {y} out of expected range"
-    assert -1000 <= z <= 1000, f"Magnetometer Z value {z} out of expected range"
+    assert -1000 <= z <= 1000, f"Magnetometer Z value {z} out of expected range"
+
+    dut_board.uart.write("att_dummy_request\r\n")
+    dut_board.uart.wait_for_str("Dummy request sent", timeout=10)
+    dut_board.uart.wait_for_str("Response received", timeout=10)
