API_CommandLine

Functions

KZSTATUS_t KzCmdlineStart (void)
 Command Line Start.
KZSTATUS_t KzCmdlineExit (void)
 Command Line Exit.
KZSTATUS_t KzCmdlineAdd (const KzCmdRegist_t *exe)
 Add a Command.
KZSTATUS_t KzCmdlineAddMany (const KzCmdRegist_t *exes)
 Add Many Commands.
KZSTATUS_t KzFilesystemStart (void)
 Filesystem start.
KZSTATUS_t KzAddCmdFilesystem (void)
 Add Filesystem commands.
KZSTATUS_t KzAddCmdDeviceDriver (void)
 Add DeviceDriver commands.

Function Documentation

KZSTATUS_t KzAddCmdDeviceDriver ( void   ) 

Add DeviceDriver commands.

Returns:
KZ_OK Success
Lack of memory space for the command. See KzCmdlineAddMany
Note:
After this function call. User can use following commands.
  • swled
  • wink
  • mems
  • echo
KZSTATUS_t KzAddCmdFilesystem ( void   ) 

Add Filesystem commands.

Returns:
KZ_OK Success
Lack of memory space for the command. See KzCmdlineAddMany
Note:
After this function call. User can use following commands.
  • ls
  • pwd
  • cd
  • mkdir
  • rmdir
  • cp
  • rm
  • mv
  • dump
  • more
KZSTATUS_t KzCmdlineAdd ( const KzCmdRegist_t exe  ) 

Add a Command.

Parameters:
exe add command
Returns:
KZ_OK Success
KZ_ERR Lack of memory space for the command
Note:
if KZ_ERR is occured, you can revise KZCMDLINE_MAX_COMMANDS
in kzconfig.h to increse the number of the command line.
KZSTATUS_t KzCmdlineAddMany ( const KzCmdRegist_t exe  ) 

Add Many Commands.

Parameters:
exe add command, must be terminated by ZERO
Returns:
KZ_OK Success
KZ_ERR Lack of memory space for the command
Note:
if KZ_ERR is occured, you can revise KZCMDLINE_MAX_COMMANDS
in kzconfig.h to increse the number of the command line.
KZSTATUS_t KzCmdlineExit ( void   ) 

Command Line Exit.

Returns:
KZ_OK Success (constant)
KZSTATUS_t KzCmdlineStart ( void   ) 

Command Line Start.

Returns:
KZ_OK Success (constant)
Note:
The function does not return until KzCmdlineExit() is called
KZSTATUS_t KzFilesystemStart ( void   ) 

Filesystem start.

Returns:
KZ_OK Success
KZ_ERR Filesystem cannot start. ( mainly SD-Card is not inserted )
Warning:
Before this function call. User must insert SD-Card, otherwise filesystem won't start and this function returns KZ_ERR.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated by  doxygen 1.6.2