Vision Apps User Guide
app_cli.h File Reference

Go to the source code of this file.

Data Structures

struct  app_cli_init_prm_t
 

Macros

#define APP_CLI_MAX_PROMPT_NAME   (16u)
 

Typedefs

typedef int32_t(* app_cli_cmd_handler_f) (int argc, char *argv[])
 
typedef int(* app_cli_device_send_string_f) (char *string, uint32_t max_size)
 
typedef int(* app_cli_device_get_string_f) (char *string, uint32_t max_size, uint32_t *string_size)
 

Functions

void appCliInitPrmSetDefault (app_cli_init_prm_t *)
 
int32_t appCliInit (app_cli_init_prm_t *)
 
int32_t appCliDeInit ()
 
int32_t appCliRegisterSystemCmd (char *cmd, char *desc, app_cli_cmd_handler_f cmd_handler)
 
int32_t appCliRegisterAppCmd (char *cmd, char *desc, app_cli_cmd_handler_f cmd_handler)
 
int32_t appCliRegisterAppSubCmd (char *cmd, char *desc, app_cli_cmd_handler_f cmd_handler)
 
int32_t appCliShowPrompt (uint32_t *is_exit)
 
void appCliShowBanner (void)
 

Macro Definition Documentation

◆ APP_CLI_MAX_PROMPT_NAME

#define APP_CLI_MAX_PROMPT_NAME   (16u)

Typedef Documentation

◆ app_cli_cmd_handler_f

typedef int32_t(* app_cli_cmd_handler_f) (int argc, char *argv[])

◆ app_cli_device_send_string_f

typedef int(* app_cli_device_send_string_f) (char *string, uint32_t max_size)

◆ app_cli_device_get_string_f

typedef int(* app_cli_device_get_string_f) (char *string, uint32_t max_size, uint32_t *string_size)

Function Documentation

◆ appCliInitPrmSetDefault()

void appCliInitPrmSetDefault ( app_cli_init_prm_t )

◆ appCliInit()

int32_t appCliInit ( app_cli_init_prm_t )

◆ appCliDeInit()

int32_t appCliDeInit ( )

◆ appCliRegisterSystemCmd()

int32_t appCliRegisterSystemCmd ( char *  cmd,
char *  desc,
app_cli_cmd_handler_f  cmd_handler 
)

◆ appCliRegisterAppCmd()

int32_t appCliRegisterAppCmd ( char *  cmd,
char *  desc,
app_cli_cmd_handler_f  cmd_handler 
)

◆ appCliRegisterAppSubCmd()

int32_t appCliRegisterAppSubCmd ( char *  cmd,
char *  desc,
app_cli_cmd_handler_f  cmd_handler 
)

◆ appCliShowPrompt()

int32_t appCliShowPrompt ( uint32_t *  is_exit)

◆ appCliShowBanner()

void appCliShowBanner ( void  )