michaelh/zephyr
1
0
Fork 0
Code Releases Activity

net: lwm2m: Clean up shell documentation

Browse source 
Move commands that require parameters first into the list.

Move syntax line first, command documentation second,
flags last. This is much like Unix commands do

❯ /bin/ls --help
Usage: /bin/ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).

Compared to:

uart:~$ lwm2m
lwm2m - LwM2M commands
Subcommands:
  read    :read PATH [OPTIONS]
          Read value from LwM2M resource
          -x   Read value as hex stream (default)
          -s   Read value as string

Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
This commit is contained in:
Seppo Takalo 2023-09-26 14:06:16 +03:00 • committed by Carles Cufí
commit ebfbf83153
2 changed files with 50 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

50
doc/connectivity/networking/api/lwm2m.rst
View file

@ -636,37 +636,55 @@ required actions from the server side.
uart:~$ lwm2m uart:~$ lwm2m
lwm2m - LwM2M commands lwm2m - LwM2M commands
Subcommands: Subcommands:
exec :Execute a resource send :send PATHS
exec PATH LwM2M SEND operation
read :Read value from LwM2M resource exec :exec PATH [PARAM]
read PATH [OPTIONS] Execute a resource
-s Read value as string (default)
read :read PATH [OPTIONS]
Read value from LwM2M resource
-x Read value as hex stream (default)
-s Read value as string
-b Read value as bool (1/0) -b Read value as bool (1/0)
-uX Read value as uintX_t -uX Read value as uintX_t
-sX Read value as intX_t -sX Read value as intX_t
-f Read value as float -f Read value as float
-t Read value as time_t
write :Write into LwM2M resource write :write PATH [OPTIONS] VALUE
write PATH [OPTIONS] VALUE Write into LwM2M resource
-s Value as string (default) -s Write value as string (default)
-b Value as bool -b Write value as bool
-uX Value as uintX_t -uX Write value as uintX_t
-sX Value as intX_t -sX Write value as intX_t
-f Value as float -f Write value as float
-t Write value as time_t
start :Start the LwM2M RD (Registration / Discovery) Client create :create PATH
start EP_NAME [BOOTSTRAP FLAG] Create object instance
cache :cache PATH NUM
Enable data cache for resource
PATH is LwM2M path
NUM how many elements to cache
start :start EP_NAME [BOOTSTRAP FLAG]
Start the LwM2M RD (Registration / Discovery) Client
-b Set the bootstrap flag (default 0) -b Set the bootstrap flag (default 0)
stop :Stop the LwM2M RD (De-register) Client stop :stop [OPTIONS]
stop [OPTIONS] Stop the LwM2M RD (De-register) Client
-f Force close the connection -f Force close the connection
update :Trigger Registration Update of the LwM2M RD Client update :Trigger Registration Update of the LwM2M RD Client
pause :LwM2M engine thread pause pause :LwM2M engine thread pause
resume :LwM2M engine thread resume resume :LwM2M engine thread resume
lock :Lock the LwM2M registry
unlock :Unlock the LwM2M registry
.. _lwm2m_api_reference: .. _lwm2m_api_reference:

22
subsys/net/lib/lwm2m/lwm2m_shell.c
View file

@ -22,10 +22,9 @@ LOG_MODULE_REGISTER(LOG_MODULE_NAME);
#include <lwm2m_util.h> #include <lwm2m_util.h>
#define LWM2M_HELP_CMD "LwM2M commands" #define LWM2M_HELP_CMD "LwM2M commands"
#define LWM2M_HELP_SEND "LwM2M SEND operation\nsend [OPTION]... [PATH]...\n" \ #define LWM2M_HELP_SEND "send PATHS\nLwM2M SEND operation\n"
"Root-level operation is unsupported" #define LWM2M_HELP_EXEC "exec PATH [PARAM]\nExecute a resource\n"
#define LWM2M_HELP_EXEC "Execute a resource\nexec PATH [PARAM]\n" #define LWM2M_HELP_READ "read PATH [OPTIONS]\nRead value from LwM2M resource\n" \
#define LWM2M_HELP_READ "Read value from LwM2M resource\nread PATH [OPTIONS]\n" \
"-x \tRead value as hex stream (default)\n" \ "-x \tRead value as hex stream (default)\n" \
"-s \tRead value as string\n" \ "-s \tRead value as string\n" \
"-b \tRead value as bool (1/0)\n" \ "-b \tRead value as bool (1/0)\n" \
@ -33,26 +32,25 @@ LOG_MODULE_REGISTER(LOG_MODULE_NAME);
"-sX\tRead value as intX_t\n" \ "-sX\tRead value as intX_t\n" \
"-f \tRead value as float\n" \ "-f \tRead value as float\n" \
"-t \tRead value as time_t\n" "-t \tRead value as time_t\n"
#define LWM2M_HELP_WRITE "Write into LwM2M resource\nwrite PATH [OPTIONS] VALUE\n" \ #define LWM2M_HELP_WRITE "write PATH [OPTIONS] VALUE\nWrite into LwM2M resource\n" \
"-s \tWrite value as string (default)\n" \ "-s \tWrite value as string (default)\n" \
"-b \tWrite value as bool\n" \ "-b \tWrite value as bool\n" \
"-uX\tWrite value as uintX_t\n" \ "-uX\tWrite value as uintX_t\n" \
"-sX\tWrite value as intX_t\n" \ "-sX\tWrite value as intX_t\n" \
"-f \tWrite value as float\n" \ "-f \tWrite value as float\n" \
"-t \tWrite value as time_t\n" "-t \tWrite value as time_t\n"
#define LWM2M_HELP_CREATE "Create object instance\ncreate PATH\n" #define LWM2M_HELP_CREATE "create PATH\nCreate object instance\n"
#define LWM2M_HELP_START "Start the LwM2M RD (Registration / Discovery) Client\n" \ #define LWM2M_HELP_START "start EP_NAME [BOOTSTRAP FLAG]\n" \
"start EP_NAME [BOOTSTRAP FLAG]\n" \ "Start the LwM2M RD (Registration / Discovery) Client\n" \
"-b \tSet the bootstrap flag (default 0)\n" "-b \tSet the bootstrap flag (default 0)\n"
#define LWM2M_HELP_STOP "Stop the LwM2M RD (De-register) Client\nstop [OPTIONS]\n" \ #define LWM2M_HELP_STOP "stop [OPTIONS]\nStop the LwM2M RD (De-register) Client\n" \
"-f \tForce close the connection\n" "-f \tForce close the connection\n"
#define LWM2M_HELP_UPDATE "Trigger Registration Update of the LwM2M RD Client\n" #define LWM2M_HELP_UPDATE "Trigger Registration Update of the LwM2M RD Client\n"
#define LWM2M_HELP_PAUSE "LwM2M engine thread pause" #define LWM2M_HELP_PAUSE "LwM2M engine thread pause"
#define LWM2M_HELP_RESUME "LwM2M engine thread resume" #define LWM2M_HELP_RESUME "LwM2M engine thread resume"
#define LWM2M_HELP_LOCK "Lock the LwM2M registry" #define LWM2M_HELP_LOCK "Lock the LwM2M registry"
#define LWM2M_HELP_UNLOCK "Unlock the LwM2M registry" #define LWM2M_HELP_UNLOCK "Unlock the LwM2M registry"
#define LWM2M_HELP_CACHE "Enable data cache for resource\n" \ #define LWM2M_HELP_CACHE "cache PATH NUM\nEnable data cache for resource\n" \
"cache PATH NUM\n" \
"PATH is LwM2M path\n" \ "PATH is LwM2M path\n" \
"NUM how many elements to cache\n" \ "NUM how many elements to cache\n" \
@ -597,6 +595,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
SHELL_CMD_ARG(read, NULL, LWM2M_HELP_READ, cmd_read, 2, 1), SHELL_CMD_ARG(read, NULL, LWM2M_HELP_READ, cmd_read, 2, 1),
SHELL_CMD_ARG(write, NULL, LWM2M_HELP_WRITE, cmd_write, 3, 1), SHELL_CMD_ARG(write, NULL, LWM2M_HELP_WRITE, cmd_write, 3, 1),
SHELL_CMD_ARG(create, NULL, LWM2M_HELP_CREATE, cmd_create, 2, 0), SHELL_CMD_ARG(create, NULL, LWM2M_HELP_CREATE, cmd_create, 2, 0),
SHELL_CMD_ARG(cache, NULL, LWM2M_HELP_CACHE, cmd_cache, 3, 0),
SHELL_CMD_ARG(start, NULL, LWM2M_HELP_START, cmd_start, 2, 2), SHELL_CMD_ARG(start, NULL, LWM2M_HELP_START, cmd_start, 2, 2),
SHELL_CMD_ARG(stop, NULL, LWM2M_HELP_STOP, cmd_stop, 1, 1), SHELL_CMD_ARG(stop, NULL, LWM2M_HELP_STOP, cmd_stop, 1, 1),
SHELL_CMD_ARG(update, NULL, LWM2M_HELP_UPDATE, cmd_update, 1, 0), SHELL_CMD_ARG(update, NULL, LWM2M_HELP_UPDATE, cmd_update, 1, 0),
@ -604,7 +603,6 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
SHELL_CMD_ARG(resume, NULL, LWM2M_HELP_RESUME, cmd_resume, 1, 0), SHELL_CMD_ARG(resume, NULL, LWM2M_HELP_RESUME, cmd_resume, 1, 0),
SHELL_CMD_ARG(lock, NULL, LWM2M_HELP_LOCK, cmd_lock, 1, 0), SHELL_CMD_ARG(lock, NULL, LWM2M_HELP_LOCK, cmd_lock, 1, 0),
SHELL_CMD_ARG(unlock, NULL, LWM2M_HELP_UNLOCK, cmd_unlock, 1, 0), SHELL_CMD_ARG(unlock, NULL, LWM2M_HELP_UNLOCK, cmd_unlock, 1, 0),
SHELL_CMD_ARG(cache, NULL, LWM2M_HELP_CACHE, cmd_cache, 3, 0),
SHELL_SUBCMD_SET_END); SHELL_SUBCMD_SET_END);
SHELL_COND_CMD_ARG_REGISTER(CONFIG_LWM2M_SHELL, lwm2m, &sub_lwm2m, SHELL_COND_CMD_ARG_REGISTER(CONFIG_LWM2M_SHELL, lwm2m, &sub_lwm2m,