OpenKAI 项目使用教程

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

OpenKAI 项目的目录结构如下：

OpenKAI/
├── data/
├── firmware/
│   └── arduino/
├── src/
├── .gitignore
├── CMakeLists.txt
├── LICENSE
├── README.md
└── package.xml

目录结构介绍

• data/: 存放项目的数据文件，如配置文件、日志文件等。
• firmware/: 存放硬件固件相关的文件，特别是 arduino/ 目录下可能包含与 Arduino 相关的固件代码。
• src/: 项目的核心源代码目录，包含主要的 C++ 代码文件。
• .gitignore: Git 版本控制系统的忽略文件配置。
• CMakeLists.txt: CMake 构建系统的配置文件，用于编译项目。
• LICENSE: 项目的开源许可证文件，本项目使用 AGPL-3.0 许可证。
• README.md: 项目的介绍文件，包含项目的基本信息、使用说明等。
• package.xml: 项目的包配置文件，可能用于某些构建系统或包管理工具。

2. 项目的启动文件介绍

在 src/ 目录下，通常会有一个主要的启动文件，用于初始化项目并启动核心功能。假设启动文件名为 main.cpp，其主要功能如下：

// src/main.cpp

#include <iostream>
#include "core/Core.h"

int main(int argc, char** argv) {
    Core core;
    core.init();
    core.run();
    return 0;
}

启动文件介绍

• main.cpp: 这是项目的入口文件，负责初始化和启动整个项目。
• Core.h: 包含项目的核心类 Core，负责项目的初始化和运行。

3. 项目的配置文件介绍

项目的配置文件通常存放在 data/ 目录下，假设配置文件名为 config.json，其内容可能如下：

{
    "sensor": {
        "type": "IntelRealsense",
        "port": "/dev/ttyUSB0"
    },
    "actuator": {
        "type": "OrientalMotor",
        "port": "/dev/ttyUSB1"
    },
    "network": {
        "protocol": "Mavlink",
        "ip": "192.168.1.100",
        "port": 14550
    }
}

配置文件介绍

• sensor: 配置传感器相关的参数，如传感器类型和连接端口。
• actuator: 配置执行器相关的参数，如执行器类型和连接端口。
• network: 配置网络通信相关的参数，如协议类型、IP 地址和端口号。

通过以上配置文件，项目可以根据不同的硬件和网络环境进行灵活配置。