Copper Rs 项目使用教程

Copper Rs 项目使用教程

copper-rs Purpose-built, Rust-native software engine for robotics 项目地址: https://gitcode.com/gh_mirrors/co/copper-rs

1. 项目目录结构及介绍

Copper Rs 是一个为机器人开发量身定制的 Rust 原生软件引擎。以下是项目的目录结构及其介绍：

copper-rs/
├── .config/              # 配置文件目录
├── .github/              # GitHub 工作流配置
├── components/           # 项目组件代码
├── core/                 # Copper Rs 核心代码
├── doc/                  # 文档目录
├── examples/             # 示例项目目录
├── patches/              # 补丁文件目录
├── support/              # 支持文件目录
├── templates/            # 项目模板目录
├── .gitignore            # Git 忽略文件
├── CONTRIBUTE.md         # 贡献指南
├── Cargo.toml            # Rust 项目配置文件
├── LICENSE               # 项目许可证
├── README.md             # 项目自述文件

• components/: 包含了 Copper Rs 的各种传感器、执行器、监控器等组件。
• core/: Copper Rs 的核心代码，包括任务图、运行时生成器等。
• examples/: 提供了一些使用 Copper Rs 的示例项目。
• templates/: 包含了可以用来生成新项目的模板。

2. 项目的启动文件介绍

项目的启动文件通常是 main.rs，在 examples/ 目录下的示例项目中可以找到。以下是启动文件的基本结构：

// 引入必要的模块和宏
use copper::prelude::*;

// 定义应用结构体
struct MyApplication;

// 实现任务 trait
impl CuSrcTask for MyApplication {
    // 定义输出消息类型
    type Output = OutputMsg<MyApplication, RPGpioPayload>;

    // 实现任务的 `new` 方法
    fn new(_config: Option<&copper::config::ComponentConfig>) -> CuResult<Self> {
        Ok(MyApplication)
    }

    // 实现任务的 `process` 方法
    fn process(&mut self, _clock: &RobotClock, output: Self::Output) -> CuResult<()> {
        // 处理任务逻辑
        output.set_payload(RPGpioPayload { /* ... */ });
        Ok(())
    }
}

// 主函数
fn main() {
    // 设置日志路径
    let logger_path = "/tmp/mylogfile.copper";
    // 初始化日志和运行时
    let copper_ctx = basic_copper_setup(&PathBuf::from(logger_path), true).expect("Failed to setup logger.");
    // 运行应用
    // ...
}

在 main.rs 中，你将定义自己的任务，并实现相应的 trait。Copper Rs 会调用这些方法来执行任务。

3. 项目的配置文件介绍

Copper Rs 使用 RON（Rust ON）文件格式来描述任务图和配置。配置文件通常是项目根目录下的 copperconfig.ron。以下是配置文件的一个简单示例：

(
    tasks: [
        (
            id: "src",
            type: "FlippingSource",
        ),
        (
            id: "gpio",
            type: "cu_rp_gpio::RPGpio",
            config: {
                "pin": 4,
            },
        ),
    ],
    cnx: [
        (
            src: "src",
            dst: "gpio",
            msg: "cu_rp_gpio::RPGpioMsg",
        ),
    ],
)

在这个配置文件中，我们定义了两个任务（src 和 gpio）以及它们之间的连接。每个任务可以有配置参数，例如 gpio 任务的 pin 属性。

以上就是 Copper Rs 项目的目录结构、启动文件和配置文件的介绍。通过这些基础的了解，你可以开始构建和运行自己的机器人应用。

copper-rs Purpose-built, Rust-native software engine for robotics 项目地址: https://gitcode.com/gh_mirrors/co/copper-rs