跳到主要内容

添加模块

XRobot 提供了 xrobot_add_mod 工具，用于：

  • 添加远程模块仓库（添加到 modules.yaml 并拉取）
  • 添加模块实例（添加到 xrobot.yaml 并生成代码）

1. 添加远程模块​

你可以通过提供模块仓库地址快速添加模块：

xrobot_add_mod xrobot-org/BlinkLED@master

输出示例：

[SUCCESS] Added repo module 'xrobot-org/BlinkLED@master' to Modules/modules.yaml

然后运行初始化命令：

xrobot_init_mod

该命令会自动拉取所有模块：

[INFO] Cloning new module: xrobot-org/BlinkLED
Cloning into 'Modules/BlinkLED'...
remote: Enumerating objects: 37, done.
remote: Counting objects: 100% (37/37), done.
remote: Compressing objects: 100% (25/25), done.
remote: Total 37 (delta 11), reused 33 (delta 10), pack-reused 0 (from 0)
Receiving objects: 100% (37/37), 7.48 KiB | 3.74 MiB/s, done.
Resolving deltas: 100% (11/11), done.
Already on 'master'
Your branch is up to date with 'origin/master'.
[SUCCESS] All modules and their dependencies processed.

2. 添加模块实例（生成代码配置）​

假设你已拉取 BlinkLED 模块：

xrobot_add_mod BlinkLED

输出如下：

[SUCCESS] Appended module instance 'BlinkLED' as id 'BlinkLED_0' to User/xrobot.yaml

此时 xrobot.yaml 配置文件中将新增：

modules:
- id: BlinkLED_0
  name: BlinkLED
  constructor_args:
    blink_cycle: 250

你可以直接运行 xrobot_gen_main 生成主函数：

xrobot_gen_main

3. 自定义实例 ID​

默认实例 ID 为 模块名_序号，如 BlinkLED_0，可手动指定：

xrobot_add_mod BlinkLED --instance-id myled

4. 将别的模块实例作为参数​

你可以将别的模块实例作为参数传递给模块：

modules:
- id: BlinkLED_0
  name: BlinkLED
  constructor_args:
    blink_cycle: 250
- id: TestModule_0
  name: TestModule
  constructor_args:
    test_arg5: '@BlinkLED_0'

会生成以下代码:

static BlinkLED BlinkLED_0(hw, appmgr, 250);
static TestModule TestModule_0(hw, appmgr, BlinkLED_0);

还支持'@obj->GetMember()'或'@obj.member'这样的语法，用于访问别的模块实例的成员。

5. 配置文件位置说明​

配置类型默认路径内容
模块仓库列表Modules/modules.yaml存储模块地址/版本信息
实例配置文件User/xrobot.yaml存储模块实例参数和 ID 等信息