SimpleCLI 项目教程

1. 项目的目录结构及介绍

SimpleCLI 项目的目录结构如下：

SimpleCLI/
├── examples/
│   ├── BasicUsage/
│   ├── CommandQueue/
│   ├── ErrorQueue/
│   ├── HelpCommand/
│   ├── MultiCommand/
│   └── MultiParameter/
├── src/
│   ├── SimpleCLI.cpp
│   └── SimpleCLI.h
├── keywords.txt
├── library.properties
└── README.md

目录结构介绍：

• examples/: 包含多个示例项目，展示了如何使用 SimpleCLI 库。每个示例项目都是一个独立的 Arduino 项目，帮助用户理解如何在自己的项目中集成和使用 SimpleCLI。

• src/: 包含 SimpleCLI 库的核心源代码文件。SimpleCLI.cpp 是库的实现文件，SimpleCLI.h 是库的头文件。

• keywords.txt: 包含库的关键字，用于 Arduino IDE 的语法高亮显示。

• library.properties: 包含库的元数据，如库的名称、版本、作者等信息。

• README.md: 项目的说明文档，包含项目的简介、安装方法、使用示例等信息。

2. 项目的启动文件介绍

SimpleCLI 项目没有传统意义上的“启动文件”，因为它是一个库，而不是一个独立的应用程序。用户在使用 SimpleCLI 时，通常会在自己的 Arduino 项目中包含 SimpleCLI.h 头文件，并在 setup() 函数中初始化 SimpleCLI 实例。

以下是一个简单的启动示例：

#include <SimpleCLI.h>

SimpleCLI cli;

void setup() {
    Serial.begin(9600);
    while (!Serial) ; // Wait for serial connection

    // 初始化 SimpleCLI
    cli = SimpleCLI();

    // 添加命令
    Command myCommand = cli.addCommand("myCommand");
    myCommand.addPositionalArgument("arg1");
    myCommand.addPositionalArgument("arg2");

    // 处理命令
    cli.onCommand(handleCommand);
}

void loop() {
    // 处理串口输入
    if (Serial.available()) {
        String input = Serial.readStringUntil('\n');
        cli.parse(input);
    }
}

void handleCommand(cmd) {
    // 处理命令逻辑
}

在这个示例中，setup() 函数负责初始化 SimpleCLI 实例，并添加命令。loop() 函数负责处理串口输入并解析命令。

3. 项目的配置文件介绍

SimpleCLI 项目没有专门的配置文件。所有的配置和初始化都在代码中完成。用户可以通过修改代码来定制 SimpleCLI 的行为，例如添加自定义命令、设置命令队列大小等。

以下是一些常见的配置示例：

设置命令队列大小

SimpleCLI cli(20, 20); // 设置命令队列大小为20，错误队列大小为20

添加自定义命令

Command myCommand = cli.addCommand("myCommand");
myCommand.addPositionalArgument("arg1");
myCommand.addPositionalArgument("arg2");

处理命令

cli.onCommand(handleCommand);

void handleCommand(cmd) {
    // 处理命令逻辑
}

通过这些配置，用户可以根据自己的需求定制 SimpleCLI 的行为。