IPC@CHIP® RTOS-LNX – API Documentation

Header image

Main page


Command shell: RTOS commands


MEM: Display memory usage
Displays the memory usage, including the name of the process owning the memory.
Example:
mem
Since
V0.87


TASKS [-s=<sort order>]: Display list of tasks

Displays a lists of all RTX tasks, including the CPU load caused by the task, the task status and the stack space usage.
The "load" value is the amount of CPU time this task has used since a previous call. In this way the period over which a task's CPU load is measured can be controlled by the time between calls to "tasks" command. Consequently, this command will not show any CPU load values at first invocation.

The listed task state is only a one moment snapshot. The task state bit field is a 16 bit hexadecimal value.

The set of system tasks are listed here.

Tasks marked with a "!" sign are in the RTX_ZOMBIE state. Something bad happened in this case.

By specifying the -s commandline option, the list output can be sorted by different criteria.
     -s=prio or -s=p: Sort by task priority (default when no argument is given)
     -s=name or -s=n: Sort by task name
     -s=id or -s=i: Sort by task ID
     -s=load or -s=l: Sort by CPU load
     -s=unsort or -s=u: Unsorted.
Example:
tasks
tasks -s=load
Since
V0.80
Changes:
V1.05 - CPU load values are now displayed.
V1.17 - Add sort option -s


VER: Display @CHIP-RTOS-LNX Version
Output the IPC@CHIP® serial number, @CHIP-RTOS-LNX version and build date.
Example:
ver
Since
V0.80


ERRORS [R]: Display detected errors

See description of API function BIOS_Set_Error_Handler() for further details concerning this command's console output.

Command Line Arguments

The following case insensitive command line arguments can be used with the ERRORS shell command. Only the first letter of these arguments needs to be entered and this is all that is inspected (no spelling test here). A space must be present between the arguments.

Examples:
errors
errors R
Since
V0.86


TIME [hh:mm:ss]: Display/Set time
This command can set or display the current time of the RTOS and the onboard RTC.
Example:
time           <- display RTOS and RTC time
time 14:25:30  <- set RTOS time
time getRTC    <- get RTC time and set RTOS time accordingly
time setRTC    <- get RTOS time and set RTC time accordingly
Since
V1.02


DATE [day.month.year]: Display/Set date
This command can set or display the current date of the RTOS and the onboard RTC.
Example:
date            <- display RTOS and RTC date
date 02.01.2015 <- set RTOS date
date getRTC     <- get RTC date and set RTOS date accordingly
date setRTC     <- get RTOS date and set RTC date accordingly
Since
V1.02


KILL DOSn: Kill an application program

This command removes a program's process from the system. All @CHIP-RTOS-LNX resources owned by that program will be released and the process address space will vanish.

The command line argument which specifies which program is to be killed can specify either the DOS program index that is indicated on the TASKS command console output or the program's process number.

The three letters "DOS" can be left out for a short hand notation.

A final method of specifying a program is by process number. A 'P' precedes the process number. (This method is not expected to be used very often, but has the advantage that process numbers are unique where as DOS program numbers are recycled on subsequent launches.)

Examples:
KILL DOS1
KILL 1
KILL P2880
See also
RTX_GetProcessNum() RTX_Kill_Program()
Since
V1.05





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Tue Dec 12 2017 09:23:36 by Doxygen 1.8.13