Functions

General Description

Functions
cy_rslt_t	cy_command_console_init (cy_command_console_cfg_t *cfg)
	Initializes the Command console framework and spawns a thread that listens on the console for commands. More...
cy_rslt_t	cy_command_console_deinit (void)
	De-initializes the command console framework and terminates the thread. More...
cy_rslt_t	cy_command_console_add_table (const cy_command_console_cmd_t *commands)
	Invoked to register a table of cy_command_console_cmd_t entries. More...
cy_rslt_t	cy_command_console_delete_table (const cy_command_console_cmd_t *commands)
	De-registers the cy_command_console_cmd_t table. More...

Function Documentation

cy_command_console_init()

cy_rslt_t cy_command_console_init

(

cy_command_console_cfg_t *

cfg

)

Initializes the Command console framework and spawns a thread that listens on the console for commands.

To be called by the application once.

Parameters

[in]

cfg

: Pointer to the command console configuration.

Returns

CY_RSLT_SUCCESS if the initialization was successful; returns command-console-specific error codes. See above.

cy_command_console_deinit()

cy_rslt_t cy_command_console_deinit

(

void

)

De-initializes the command console framework and terminates the thread.

Returns

CY_RSLT_SUCCESS if the initialization was successful; returns command-console-specific error codes. See above.

cy_command_console_add_table()

cy_rslt_t cy_command_console_add_table

(

const cy_command_console_cmd_t *

commands

)

Invoked to register a table of cy_command_console_cmd_t entries.

Parameters

[in]

commands

: Pointer to the commands.

Returns

CY_RSLT_SUCCESS if the initialization was successful; returns command-console-specific error codes. See above.

cy_command_console_delete_table()

cy_rslt_t cy_command_console_delete_table

(

const cy_command_console_cmd_t *

commands

)

De-registers the cy_command_console_cmd_t table.

Parameters

[in]

commands

: Pointer to the commands.

Returns

CY_RSLT_SUCCESS if the initialization was successful; returns command-console-specific error codes. See above.