Configuration
This is the default configuration of the middleware.
When any of the settings shall be modified, it shall be done in dedicated application config lwshell_opts.h
file.
Note
Check Getting started for guidelines on how to create and use configuration file.
- group LWSHELL_OPT
LwSHELL options.
Defines
-
LWSHELL_MEMSET(dst, val, len)
Memory set function.
Note
Function footprint is the same as memset
-
LWSHELL_MEMCPY(dst, src, len)
Memory copy function.
Note
Function footprint is the same as memcpy
-
LWSHELL_CFG_USE_DYNAMIC_COMMANDS
Enables
1
or disables0
dynamic command register with lwshell_register_cmd or lwshell_register_cmd_ex functions.See also
Note
Set to
1
by default for backward compatibility
-
LWSHELL_CFG_USE_STATIC_COMMANDS
Enables
1
or disables0
static command registration.When enabled, a single register call is used where application can pass constant array of the commands and respective callback functions.
This allows RAM reduction as lookup tables can be stored in the non-volatile memory
See also
Note
Set to
0
by default for backward compatibility
-
LWSHELL_CFG_MAX_CMDS
Maximum number of different dynamic registered commands.
- Deprecated:
Warning
Deprecated and replaced with LWSHELL_CFG_MAX_DYNAMIC_CMDS
-
LWSHELL_CFG_MAX_DYNAMIC_CMDS
Maximum number of different dynamic registered commands.
Note
Used only when LWSHELL_CFG_USE_DYNAMIC_COMMANDS is enabled
-
LWSHELL_CFG_MAX_INPUT_LEN
Maximum characters for command line input.
This includes new line character and trailing zero. Commands longer than this are automatically discarded
-
LWSHELL_CFG_MAX_CMD_NAME_LEN
Maximum characters for command name in bytes.
Note
Used only when LWSHELL_CFG_USE_DYNAMIC_COMMANDS is enabled
-
LWSHELL_CFG_MAX_CMD_ARGS
Maximum number of parameters accepted by command.
Number includes command name itself
-
LWSHELL_CFG_USE_OUTPUT
Enables
1
or disables0
output function to print data from library to application.This is useful to give library feedback to user
-
LWSHELL_CFG_USE_LIST_CMD
Enables
1
or disables0
generic ˙listcmd` command to list of registered commands.LWSHELL_CFG_USE_OUTPUT must be enabled to use this feature
-
LWSHELL_MEMSET(dst, val, len)