![]() |
LibRTOSConsole-C-Library 1.0
Library Code documentation
|
The following code documentation is a set of tipps and diagramms as well as function and structure descriptions which help when using the library. It is used to increase the implementation speed. Some examples are attached in this documentation as well
CONSOLE_USERNAME: The username in the console which is printed at least on power up before changing the username
CONSOLE_USE_DYNAMIC_USERNAME: The username can be changed on runtime which is enabled with this DEFINE
CONSOLE_LINE_HISTORY: specifies the maximum number of entries of the "last commands" buffer
CONSOLE_LINE_SIZE: Specifies the number of chars per line. When exceeding this number without a newline,
the console prints a buffer overflow and clears the input. All inputs are then invalidated within
this line
CONSOLE_COMMAND_MAX_LENGTH: Specifies the maximum number of chars per command
CONSOLE_HELP_MAX_LENGTH: Specifies the maximum number of chars per command help text
The following example shows how to create a instance of the console library and how to attach a function for console usage. This is called registering a command
The following example shows a really simple console function and how it is used to work with the console and arguments passed by the user