cli

步骤1 创建或打开工程

打开已有工程

如果用于测试的案例工程已存在，可参考《aos-studio使用说明之打开工程》打开已有工程。

创建新的工程

组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考《aos-studio使用说明之创建工程》。

步骤2 添加组件

案例下载完成后，以运行helloworld_demo为例，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：

depends:
  - cli: dev_aos  # helloworld_demo中引入cli组件

步骤3 下载组件

在已安装了 alios-studio 的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：

aos install cli

上述命令执行成功后，组件源码则被下载到了./components/cli路径中。

步骤4 添加示例

下面示例演示了注册cli命令的三种方式，分别是：

1. 注册单个cli命令

2. 同时注册多个cli命令

3. 通过宏注册单个cli命令

Example: 包含头文件 #include "aos/cli.h"

int ret;
void test_cmd(char *buf, int32_t len, int32_t argc, char **argv)
{
    /* test_cmd 命令实现 */
    aos_cli_printf("this is test cmd\r\n");
}

const struct cli_command cmd = {"test", "test cmd description", test_cmd};

ret = aos_cli_register_command(&cmd);
if (ret) {
  /* 错误处理 */
  aos_cli_printf("test cmd register fail\r\n");
}

int ret;
void test1_cmd(char *buf, int32_t len, int32_t argc, char **argv)
{
    /* test_cmd 命令实现 */
    aos_cli_printf("this is test cmd1\r\n");
}

void test2_cmd(char *buf, int32_t len, int32_t argc, char **argv)
{
    /* test_cmd 命令实现 */
    aos_cli_printf("this is test cmd2\r\n");
}

const struct cli_command cmds[] = {
     { "test1", "show test1 info", test1_cmd },
     { "test2", "show test2 info", test2_cmd },
};

ret = aos_cli_register_commands(&cmds, sizeof(cmds) / sizeof(struct cli_command));
if (ret) {
    /* 错误处理 */
    aos_cli_printf("test cmds register fail\r\n");
}

void test_cmd3(int32_t argc, char **argv)
{
    /* test_cmd3 命令实现 */
    aos_cli_printf("this is test cmd3\r\n");
}

/* 宏的参数说明：
 * 参数1. cmd具体实现
 * 参数2. 在串口下输入的命令
 * 参数3. cmd的描述信息
 */
ALIOS_CLI_CMD_REGISTER(test_cmd3, test3, show test3 info)

代码示例helloworld_demo注册cli命令，修改helloworld.c如下：

#include "aos/init.h"
#include "board.h"
#include <aos/errno.h>
#include <aos/kernel.h>
#include <k_api.h>
#include <stdio.h>
#include <stdlib.h>
#include "aos/cli.h" /* 加上头文件 */

void test_cmd(char *buf, int32_t len, int32_t argc, char **argv)
{
    /* test_cmd 命令实现 */
    aos_cli_printf("this is test cmd\r\n");
}

void test1_cmd(char *buf, int32_t len, int32_t argc, char **argv)
{
    /* test_cmd 命令实现 */
    aos_cli_printf("this is test cmd1\r\n");
}

void test2_cmd(char *buf, int32_t len, int32_t argc, char **argv)
{
    /* test_cmd 命令实现 */
    aos_cli_printf("this is test cmd2\r\n");
}

const struct cli_command cmd = {"test", "test cmd description", test_cmd};

const struct cli_command cmds[] = {
     { "test1", "show test1 info", test1_cmd },
     { "test2", "show test2 info", test2_cmd },
};


int application_start(int argc, char *argv[])
{
    int count = 0;
    int ret;

    printf("nano entry here!\r\n");

    ret = aos_cli_register_command(&cmd);
    if (ret) {
      /* 错误处理 */
      aos_cli_printf("test cmd register fail\r\n");
    }

    ret = aos_cli_register_commands(&cmds, sizeof(cmds) / sizeof(struct cli_command));
    if (ret) {
        /* 错误处理 */
        aos_cli_printf("test cmds register fail\r\n");
    }

    while (1) {
        //printf("hello world! count %d \r\n", count++);
        aos_msleep(1000);
    };
}

void test_cmd3(int32_t argc, char **argv)
{
    /* test_cmd3 命令实现 */
    aos_cli_printf("this is test cmd3\r\n");
}

/* 宏的参数说明：
 * 参数1. cmd具体实现
 * 参数2. 在串口下输入的命令
 * 参数3. cmd的描述信息
 */
ALIOS_CLI_CMD_REGISTER(test_cmd3, test3, show test3 info)

步骤5 编译固件

在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考《aos-studio使用说明之编译固件》。

步骤6 烧录固件

helloworld_demo案例的固件生成后，可参考《aos-studio使用说明之烧录固件》来烧录固件。

步骤7 打开串口

固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考《aos-studio使用说明之查看日志》。

步骤8 测试示例

CLI命令行输入：

help

test
test1
test2
test3

执行不同的命令，有相应的日志输出。