NCSDK-31749: trim down the sample shell

Removed some shell commands from the sample application, including ping
and data send functionality (as they were somewhat unreliable and
arbitrary), AT shell (this already exists in the NCS and is now enabled
in the project configuration) and PSM and EDRX setting (these can be done
directly via AT commands).

Signed-off-by: Kacper Radoszewski <kacper.radoszewski@nordicsemi.no>

Author: kacperradoszewski

doc/links.txt

@@ -145,6 +145,7 @@
 
 .. ### Source: github.com
 
+.. _`sdk-nrf`: https://github.com/nrfconnect/sdk-nrf
 .. _`sdk-nrfxlib`: https://github.com/nrfconnect/sdk-nrfxlib
 .. _`nRF Cloud JSON protocol schemas`: https://github.com/nRFCloud/application-protocols
 .. _`nRF Cloud Utils`: https://github.com/nRFCloud/utils

doc/sample.rst

@@ -90,7 +90,7 @@ After programming the sample and all prerequisites to the development kit, test
 
      <inf> sb_fota: Next update check in 14 days, 09:20:10
 
-#. Use ``sb_fota_clock_set()`` to set the modem time to trick the update to happen (Or simply wait ~14 days).
+#. Use ``sb_fota_clock_set()`` to set the modem time to trick the update to happen (or simply wait ~14 days).
 
    For example, if ``AT+CCLK`` returns ``25/03/04,01:30:40+04``, then use the ``app clock`` shell command to set the clock::
 
@@ -126,6 +126,10 @@ This sample uses the following `sdk-nrfxlib`_ library:
 
 * `Modem library <nrfxlib_nrf_modem_>`_
 
+It uses the following `sdk-nrf`_ library:
+
+* `AT shell`
+
 It uses the following |addon|.
 
 * SoftBank FOTA library

sample/prj.conf

@@ -49,6 +49,9 @@ CONFIG_MPU_ALLOW_FLASH_WRITE=y
 # HTTP Client
 CONFIG_HTTP_CLIENT=y
 
+# AT Shell
+CONFIG_AT_SHELL=y
+
 # JSON Parser
 CONFIG_JSON_LIBRARY=y
 

sample/src/shell.c

@@ -5,97 +5,14 @@
  */
 
 #include <zephyr/shell/shell.h>
-#include <nrf_modem_at.h>
-#include <zephyr/net/socket.h>
-#include <modem/lte_lc.h>
-#include <modem/modem_info.h>
 #include <sb_fota.h>
 
-#define DEFAULT_DATA_SEND_INTERVAL 10
-
-static int fd = -1;
-static struct addrinfo *addrinfo_res;
-static const char dummy_data[] = "01234567890123456789012345678901"
-				 "01234567890123456789012345678901"
-				 "01234567890123456789012345678901"
-				 "01234567890123456789012345678901"
-				 "01234567890123456789012345678901"
-				 "01234567890123456789012345678901"
-				 "01234567890123456789012345678901"
-				 "01234567890123456789012345678901";
-static char response_buf[4096];
-
-int ping(const char *local, const char *remote, int count);
-
-static void udp_socket_open(void)
-{
-	int err;
-	struct addrinfo hints = {
-		.ai_family = AF_INET,
-		.ai_socktype = SOCK_DGRAM,
-	};
-
-	/* Use dummy destination address and port */
-	err = getaddrinfo("192.168.123.45", NULL, &hints, &addrinfo_res);
-	if (err) {
-		printk("getaddrinfo() failed, err %d\n", errno);
-	}
-
-	((struct sockaddr_in *)addrinfo_res->ai_addr)->sin_port = htons(61234);
-
-	fd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
-}
-
-void data_send_work_handler(struct k_work *work)
-{
-	sendto(fd, dummy_data, sizeof(dummy_data) - 1, 0, addrinfo_res->ai_addr,
-	       sizeof(struct sockaddr_in));
-}
-
-K_WORK_DEFINE(data_send_work, data_send_work_handler);
-
-void data_send_timer_handler(struct k_timer *dummy)
-{
-	k_work_submit(&data_send_work);
-}
-
-K_TIMER_DEFINE(data_send_timer, data_send_timer_handler, NULL);
-
-#define FOTA_APP_BUILD_VERSION "1.1"
-static int app_cmd_ver(const struct shell *shell, size_t argc, char **argv)
-{
-	ARG_UNUSED(argc);
-	ARG_UNUSED(argv);
-
-	int ret = modem_info_init();
-
-	if (ret) {
-		shell_error(shell, "modem_info_init() failed, %d", ret);
-		return ret;
-	}
-
-	response_buf[0] = '\0';
-	ret = modem_info_string_get(MODEM_INFO_FW_VERSION, response_buf, sizeof(response_buf));
-	if (ret < 0) {
-		shell_error(shell, "modem_info_string_get() failed, %d", ret);
-		return ret;
-	}
-	shell_print(shell, "App FW version:\t\t%s", FOTA_APP_BUILD_VERSION);
-	shell_print(shell, "Modem FW version:\t%s", response_buf);
-#if CONFIG_LTE_NETWORK_MODE_NBIOT
-	shell_print(shell, "System mode:\t\tCat.NB");
-#else
-	shell_print(shell, "System mode:\t\tCat.M");
-#endif
-
-	return 0;
-}
-
 static int app_cmd_clock(const struct shell *shell, size_t argc, char **argv)
 {
 	ARG_UNUSED(argc);
 
 	int err;
+
 	err = sb_fota_clock_set(argv[1]);
 	if (err) {
 		shell_error(shell, "clock: invalid time string");
@@ -105,188 +22,14 @@ static int app_cmd_clock(const struct shell *shell, size_t argc, char **argv)
 	return 0;
 }
 
-static int app_cmd_at(const struct shell *shell, size_t argc, char **argv)
-{
-	ARG_UNUSED(argc);
-
-	int err;
-	err = nrf_modem_at_cmd(response_buf, sizeof(response_buf), "%s", argv[1]);
-	if (err) {
-		shell_error(shell, "ERROR");
-		return -EINVAL;
-	}
-
-	shell_print(shell, "%sOK", response_buf);
-
-	return 0;
-}
-
-static int app_cmd_ping(const struct shell *shell, size_t argc, char **argv)
-{
-	int err;
-	char ipv4[16];
-	char *tmp1, *tmp2;
-	int count = 1;
-
-	err = nrf_modem_at_cmd(response_buf, sizeof(response_buf), "AT+CGPADDR");
-	if (err) {
-		shell_error(shell, "AT ERROR");
-		return -EINVAL;
-	}
-
-	/* parse +CGPADDR: 0,"10.145.192.136" */
-	tmp1 = strstr(response_buf, "\"");
-	if (tmp1 == NULL) {
-		shell_error(shell, "AT ERROR");
-		return -EINVAL;
-	}
-	tmp1++;
-	tmp2 = strstr(tmp1, "\"");
-	if (tmp2 == NULL) {
-		shell_error(shell, "AT ERROR");
-		return -EINVAL;
-	}
-
-	memset(ipv4, 0x00, 16);
-	strncpy(ipv4, (const char *)tmp1, (size_t)(tmp2 - tmp1));
-	if (argc > 2) {
-		count = strtoul(argv[2], NULL, 10);
-	}
-	ping(ipv4, argv[1], count);
-
-	return 0;
-}
-
-static int app_cmd_data_start(const struct shell *shell, size_t argc, char **argv)
-{
-	int period = 0;
-
-	if (fd < 0) {
-		udp_socket_open();
-	}
-
-	if (fd >= 0) {
-		if (argc > 1) {
-			period = atoi(argv[1]);
-		}
-		if (period < 1) {
-			period = DEFAULT_DATA_SEND_INTERVAL;
-		}
-		shell_print(shell, "start: sending periodic data every %d seconds", period);
-		k_timer_start(&data_send_timer, K_NO_WAIT, K_SECONDS(period));
-	} else {
-		shell_error(shell, "start: socket not open");
-		return -EINVAL;
-	}
-
-	return 0;
-}
-
-static int app_cmd_data_stop(const struct shell *shell, size_t argc, char **argv)
-{
-	ARG_UNUSED(argc);
-	ARG_UNUSED(argv);
-
-	if (k_timer_remaining_get(&data_send_timer) > 0) {
-		k_timer_stop(&data_send_timer);
-		shell_print(shell, "stop: periodic data stopped");
-	} else {
-		shell_error(shell, "stop: periodic data not started");
-		return -ENOEXEC;
-	}
-
-	return 0;
-}
-
-static int app_cmd_edrx_enable(const struct shell *shell, size_t argc, char **argv)
-{
-	ARG_UNUSED(argc);
-	ARG_UNUSED(argv);
-
-	int ret = lte_lc_edrx_req(true);
-	if (ret) {
-		shell_print(shell, "Failed to enable eDRX");
-	}
-
-	return ret;
-}
-
-static int app_cmd_edrx_disable(const struct shell *shell, size_t argc, char **argv)
-{
-	ARG_UNUSED(argc);
-	ARG_UNUSED(argv);
-
-	int ret = lte_lc_edrx_req(false);
-	if (ret) {
-		shell_print(shell, "Failed to disable eDRX");
-	}
-
-	return ret;
-}
-
-static int app_cmd_psm_enable(const struct shell *shell, size_t argc, char **argv)
-{
-	ARG_UNUSED(argc);
-	ARG_UNUSED(argv);
-
-	int ret = lte_lc_psm_req(true);
-	if (ret) {
-		shell_print(shell, "Failed to enable PSM");
-	}
-
-	return ret;
-}
-
-static int app_cmd_psm_disable(const struct shell *shell, size_t argc, char **argv)
-{
-	ARG_UNUSED(argc);
-	ARG_UNUSED(argv);
-
-	int ret = lte_lc_psm_req(false);
-	if (ret) {
-		shell_print(shell, "Failed to disable PSM");
-	}
-
-	return ret;
-}
-
-SHELL_STATIC_SUBCMD_SET_CREATE(app_data_cmds,
-			       SHELL_CMD(start, NULL,
-					 "'app data start [interval in seconds]' starts "
-					 "periodic UDP data sending. The default "
-					 "interval is 10 seconds.",
-					 app_cmd_data_start),
-			       SHELL_CMD(stop, NULL, "Stop periodic UDP data sending.",
-					 app_cmd_data_stop),
-			       SHELL_SUBCMD_SET_END);
-
-SHELL_STATIC_SUBCMD_SET_CREATE(app_edrx_cmds,
-			       SHELL_CMD(enable, NULL, "'app edrx enable' enable eDRX",
-					 app_cmd_edrx_enable),
-			       SHELL_CMD(disable, NULL, "'app edrx disable' disable eDRX",
-					 app_cmd_edrx_disable),
-			       SHELL_SUBCMD_SET_END);
-
-SHELL_STATIC_SUBCMD_SET_CREATE(
-	app_psm_cmds, SHELL_CMD(enable, NULL, "'app psm enable' enable PSM", app_cmd_psm_enable),
-	SHELL_CMD(disable, NULL, "'app psm disable' disable PSM", app_cmd_psm_disable),
-	SHELL_SUBCMD_SET_END);
-
 SHELL_STATIC_SUBCMD_SET_CREATE(
-	app_cmds, SHELL_CMD_ARG(ver, NULL, "Firmware version.", app_cmd_ver, 1, 0),
+	app_cmds,
 	SHELL_CMD_ARG(clock, NULL,
-		      "'app clock <yy/MM/dd,hh:mm:ss-/+zz>' sets "
-		      "modem clock (see modem AT command "
-		      "specification for AT+CCLK for detailed "
-		      "format description)",
+		      "Set modem clock (see modem AT command specification for AT+CCLK for "
+		      "detailed format description)\n"
+		      "Usage:\n"
+		      "app clock <yy/MM/dd,hh:mm:ss-/+zz>",
 		      app_cmd_clock, 2, 0),
-	SHELL_CMD_ARG(at, NULL, "Execute an AT command.", app_cmd_at, 2, 0),
-	SHELL_CMD_ARG(ping, NULL, "Ping remote host by 'ping <ip> [count]'.", app_cmd_ping, 2, 1),
-	SHELL_CMD(data, &app_data_cmds,
-		  "Send periodic UDP data over default "
-		  "APN.",
-		  NULL),
-	SHELL_CMD(edrx, &app_edrx_cmds, "Enable or disable eDRX.", NULL),
-	SHELL_CMD(psm, &app_psm_cmds, "Enable or disable PSM.", NULL), SHELL_SUBCMD_SET_END);
+);
 
-SHELL_CMD_REGISTER(app, &app_cmds, "Commands for controlling the FOTA sample application", NULL);
+SHELL_CMD_REGISTER(app, &app_cmds, "Commands for controlling the SoftBank FOTA sample application", NULL);