嵌入式CLI项目使用教程

嵌入式CLI项目使用教程

项目介绍

embedded-cli 是一个为嵌入式系统（如Arduino或STM32）设计的单头文件命令行接口库。它支持历史记录和自动补全功能，使得在资源受限的环境中进行交互变得更加便捷。

项目快速启动

安装

1. 克隆项目仓库到本地：

   git clone https://github.com/FARLY7/embedded-cli.git
   

2. 将 embedded_cli.h 文件包含到你的项目中。

使用

1. 在你的代码中包含头文件：

   #include "embedded_cli.h"
   

2. 在一个编译单元（.c/.cpp文件）中定义宏以展开实现：

   #define EMBEDDED_CLI_IMPL
   #include "embedded_cli.h"
   

3. 初始化CLI：

   EmbeddedCliConfig *config = embeddedCliDefaultConfig();
   config->maxBindingCount = 16; // 根据需要修改配置
   EmbeddedCli *cli = embeddedCliNew(config);
   

4. 提供一个函数用于发送字符到另一端：

   void writeChar(EmbeddedCli *embeddedCli, char c) {
       // 实现写入字符的逻辑
   }
   cli->writeChar = writeChar;
   

5. 添加命令绑定：

   embeddedCliAddBinding(cli, {
       "get-led", // 命令名称
       "Get led status", // 帮助信息
       false, // 是否对参数进行分词
       nullptr, // 上下文指针
       onLed // 绑定函数
   });
   
   void onLed(EmbeddedCli *cli, char *args, void *context) {
       // 处理命令逻辑
   }
   

应用案例和最佳实践

案例1：LED控制

在嵌入式系统中，通过CLI控制LED的开关是一个常见的应用。以下是一个简单的实现：

void onLed(EmbeddedCli *cli, char *args, void *context) {
    if (strcmp(args, "on") == 0) {
        // 打开LED
    } else if (strcmp(args, "off") == 0) {
        // 关闭LED
    }
}

案例2：ADC读取

通过CLI读取ADC值也是一个常见的应用：

void onAdc(EmbeddedCli *cli, char *args, void *context) {
    int adcValue = readAdc();
    printf("ADC Value: %d\n", adcValue);
}

典型生态项目

项目1：Arduino CLI

Arduino CLI 是一个用于Arduino开发板的命令行工具，可以与embedded-cli结合使用，提供更强大的功能和更好的开发体验。

项目2：STM32 CLI

STM32 CLI 是一个专门为STM32微控制器设计的命令行接口库，可以与embedded-cli结合使用，提供更高效的嵌入式系统交互。

通过结合这些生态项目，可以进一步扩展embedded-cli的功能，使其更加适用于不同的嵌入式系统开发需求。