/**
 * @file tal_cli.h
 * @brief Header file for the Command Line Interface (CLI) commands.
 *
 * This file defines the structure and callback types for implementing CLI
 * commands within the TAL framework. It provides the necessary types and
 * declarations for registering, handling, and executing CLI commands, including
 * command name, help text, and the callback function to be invoked when the
 * command is executed. The CLI functionality is designed to facilitate
 * debugging and configuration through a command line interface.
 *
 * @copyright Copyright (c) 2021-2024 Tuya Inc. All Rights Reserved.
 *
 */

#ifndef __TAL_CLI_H__
#define __TAL_CLI_H__

#ifdef __cplusplus
extern "C" {
#endif

#include "stdint.h"

/**
 * @brief callback for one cli command
 *
 * @param[in] argc The number of argumnet
 * @param[in] argv The point date of argument
 *
 */
typedef void (*cli_cmd_func_cb_t)(int argc, char *argv[]);

typedef struct {
    /** cli command name */
    char *name;
    /** cli command help */
    char *help;
    /** the callback of one command */
    cli_cmd_func_cb_t func;
} cli_cmd_t;

/**
 * @brief cli init function,default uart0
 *
 * @return OPRT_OK on success. Others on error, please refer to
 * tuya_error_code.h
 *
 */
int tal_cli_init(void);

/**
 * @brief cli command register
 *
 * @param[in] cmd Info of one command
 * @param[in] num Number
 *
 * @return OPRT_OK on success. Others on error, please refer to
 * tuya_error_code.h
 *
 */
int tal_cli_cmd_register(const cli_cmd_t *cmd, uint8_t num);

/**
 * @brief uart cli init
 *
 * @param[in] uart_num The number of UART
 *
 * @return OPRT_OK on success. Others on error, please refer to
 * tuya_error_code.h
 *
 */
int tal_cli_init_with_uart(uint8_t uart_num);

/**
 * @brief cli echo string
 *
 * @param[in] string context
 *
 * @return None
 *
 */
void tal_cli_echo(char *string);

#ifdef __cplusplus
}
#endif
#endif