samples: esb_monitor: Implemented shell commands

Implemented shell commands for runtime configuration updates

JIRA: NCSDK-35071

Signed-off-by: Michał Strządała <[email protected]>

Author: Tryton77

samples/esb/esb_monitor/CMakeLists.txt

@@ -10,5 +10,5 @@ project(NONE)
 
 # NORDIC SDK APP START
 target_sources(app PRIVATE src/main.c)
-target_sources_ifdef(CONFIG_ESB_SNIFFER app PRIVATE src/sniffer.c)
+target_sources_ifdef(CONFIG_ESB_SNIFFER app PRIVATE src/sniffer.c src/sniffer_shell.c)
 # NORDIC SDK APP END

samples/esb/esb_monitor/Kconfig

@@ -17,6 +17,7 @@ config LED_ENABLE
 config ESB_SNIFFER
 	bool "Turn sample into a functional ESB sniffer"
 	select USE_SEGGER_RTT
+	select SHELL
 	help
 	  Enable sniffer functionality with RTT backend and runtime configuration updates through UART shell.
 	  Disable logging received packets through UART.

samples/esb/esb_monitor/README.rst

@@ -38,7 +38,49 @@ All LEDs:
 
        The next four packets turn them off again in the same order.
 
-   To disable LEDs, unset the :kconfig:option:`CONFIG_LED_ENABLE` Kconfig option.
+   To disable LEDs, unset the :ref:`CONFIG_LED_ENABLE <CONFIG_LED_ENABLE>` Kconfig option.
+
+The following ``sniffer`` shell subcommands are available when the :ref:`CONFIG_ESB_SNIFFER <CONFIG_ESB_SNIFFER>` Kconfig option is set:
+
+   .. list-table:: Sniffer shell commands
+      :header-rows: 1
+
+      * - Subcommand
+        - Arguments
+        - Description
+      * - ``show``
+        -
+        - Print actual sniffer configuration
+      * - ``start``
+        -
+        - Start listening
+      * - ``stop``
+        -
+        - Stop listening
+      * - ``set addr0``
+        - <xx.xx.xx.xx>
+        - Set base address 0
+      * - ``set addr1``
+        - <xx.xx.xx.xx>
+        - Set base address 1
+      * - ``set bitrate``
+        - <bitrate>
+        - Set bitrate
+      * - ``set channel``
+        - <channel number>
+        - Set ESB channel
+      * - ``set prefix``
+        - <xx.xx.xx.xx> <xx.xx.xx.xx>
+        - Set prefix0 and prefix1
+      * - ``pipe enable``
+        - <pipe number> <pipe number> ... or ``all``
+        - Enable selected pipes, or all pipes when argument is ``all``
+      * - ``pipe disable``
+        - <pipe number> <pipe number> ... or ``all``
+        - Disable selected pipes, or all pipes when argument is ``all``
+      * - ``pipe prefix``
+        - <pipe number> <prefix>
+        - Set <prefix> on <pipe number>
 
 Configuration
 *************
@@ -50,10 +92,17 @@ Configuration options
 
 Check and configure the following options:
 
+.. _CONFIG_LED_ENABLE:
+
+CONFIG_LED_ENABLE
+   Enable led changes while receiving packets.
+   It is intended to use together with the :ref:`Transmitter <esb_ptx>` sample.
+   This option is enabled by default.
+
 .. _CONFIG_ESB_SNIFFER:
 
 CONFIG_ESB_SNIFFER
-   Disable logging received packets through UART, and set RTT as transport layer for the packets.
+   Disable logging received packets through UART, set RTT as transport layer for the packets, and enable the shell.
    It is intended for use together with :file:`scripts/esb_sniffer/main.py` or :file:`scripts/esb_sniffer/capture_to_pcap.py` scripts.
    This option is disabled by default.
 

samples/esb/esb_monitor/src/sniffer.c

@@ -183,5 +183,7 @@ int sniffer_init(void)
 				NULL, NULL, NULL,
 				CONFIG_ESB_SNIFFER_THREAD_PRIORITY, 0, K_NO_WAIT);
 
+	sniffer_shell_init(&sniffer_cfg);
+
 	return 0;
 }

samples/esb/esb_monitor/src/sniffer.h

@@ -28,6 +28,7 @@ struct rtt_frame {
 } __packed;
 
 int sniffer_init(void);
+void sniffer_shell_init(struct esb_sniffer_cfg *sniffer_cfg);
 
 #ifdef __cplusplus
 }