ANTIRTOS 项目使用教程

ANTIRTOS 项目使用教程

1. 项目目录结构及介绍

ANTIRTOS 项目是一个轻量级、健壮、安全和高效的通用 C++ 库，用于物联网和嵌入式应用中的任务管理。以下是项目的目录结构及其简要介绍：

ANTIRTOS/
├── examples/              # 示例代码文件夹
├── LICENSE               # 项目许可文件
├── README.md             # 项目说明文件
├── antirtos.h            # 库的主头文件
├── keywords.txt          # 关键字文件
└── library.properties    # 库属性文件

• examples/：包含使用 ANTIRTOS 库的示例代码。
• LICENSE：项目的 MIT 许可文件，说明项目的使用和分发条款。
• README.md：项目的说明文件，包含项目的基本信息和如何使用。
• antirtos.h：库的主头文件，包含所有的类和函数声明。
• keywords.txt：包含项目使用的关键字。
• library.properties：库的属性文件，用于配置库的参数。

2. 项目的启动文件介绍

项目的启动主要是通过在 Arduino 或其他平台的项目中包含 antirtos.h 头文件来进行的。以下是一个基本的启动示例：

#include <antirtos.h>

// 创建队列
fQ F1(4);
fQ F2(4);
fQ F3(8);

// 中断服务程序中推送任务
void button1Interrupt() {
    F1.push(dealAssociatedButton1);
}

void button2Interrupt() {
    F2.push(dealAssociatedButton2);
    F2.push(secondDealAssociatedButton2);
}

void timer1ElapsedInterrupt() {
    F3.push(dealAssociatedTimer1);
}

// 主循环中拉取任务
void loop() {
    F1.pull();
    F2.pull();
    F3.pull();
}

在这个例子中，我们创建了三个任务队列，并在中断服务程序中向这些队列推送任务。然后在主循环中，我们持续地从队列中拉取并执行任务。

3. 项目的配置文件介绍

ANTIRTOS 库的配置主要通过 library.properties 文件进行。此文件用于定义库的元数据，如名称、版本和作者等。以下是 library.properties 文件的一个示例：

name=ANTIRTOS
version=1.0.0
author=WeSpeakEnglish
sentence=A lightweight, robust, secure and efficient universal C++ library for task management in IoT and embedded applications.
url=https://github.com/WeSpeakEnglish/ANTIRTOS

在这个文件中：

• name：库的名称。
• version：库的当前版本号。
• author：库的作者。
• sentence：库的简短描述。
• url：库的 GitHub 仓库链接。

通过修改这个文件，可以自定义库的属性，以便更好地集成到其他项目中。