Skip to content

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

78 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

qdu-future-modules

青岛大学未来战队电控/视觉模块源 / Control and Vision Module Source of the QDU Future Team

index.yaml 是 QDU-Robomaster 的 XRobot 模块源,地址为 https://qdu-robomaster.github.io/qdu-future-modules/index.yaml。modules 列出模块仓库, bsps 列出 BSP 仓库,供 xrobot source list --type bsp 查询。GitHub 地址给出包标识 QDU-Robomaster/<仓库名>。

index.yaml is the XRobot Module Source of QDU-Robomaster, served at https://qdu-robomaster.github.io/qdu-future-modules/index.yaml. modules lists the Module repositories and bsps lists the BSP repositories that xrobot source list --type bsp shows. A GitHub URL gives the package identity QDU-Robomaster/<repository>.

使用 / Use

在 BSP 根目录把本源加入 Modules/sources.yaml:

In the BSP root, the following command adds this Source to Modules/sources.yaml:

xrobot source add-source https://qdu-robomaster.github.io/qdu-future-modules/index.yaml --priority 0

查询并使用模块:

Querying and using a Module:

xrobot source list --type module
xrobot source list --type bsp
xrobot source get QDU-Robomaster/RMMotor
xrobot module add QDU-Robomaster/RMMotor@same-or-dev
xrobot setup

输出示例:

Sample output:

$ xrobot source list --type module
QDU-Robomaster/Aimer [module] https://github.com/QDU-Robomaster/Aimer.git
QDU-Robomaster/ArmorDetector [module] https://github.com/QDU-Robomaster/ArmorDetector.git
......

基础库 / Base Libraries

modules 列表同时包含可实例化的模块和只被其他模块依赖的基础库。基础库不能从列表中删除,否则依赖解析会失败。

基础库在自己的主头文件 manifest 中写 standalone: false(当前为 Motor、CameraBase、VisionPreview、AutoAimTypes):它们不能在应用配置中实例化,模块 CI 只编译其源码。xrobot 以 manifest 为准,不读取 index.yaml 中的 module_metadata。

modules contains both instantiable Modules and base libraries that only other Modules depend on. The base libraries stay in the list; dependency resolution fails without them.

A base library writes standalone: false in the manifest of its primary header (currently Motor, CameraBase, VisionPreview and AutoAimTypes): it cannot be instantiated in an application configuration, and Module CI only compiles its sources. xrobot follows the manifest and does not read module_metadata in index.yaml.

添加模块 / Adding a Module

通过 PR 把仓库地址加入 index.yaml 的 modules。仓库需符合 XRobot 1.0 模块结构:主头文件 Repo.hpp 声明普通类 Repo,含 MODULE MANIFEST V2,CI 调用共享工作流 xrobot-org/XRobot/.github/workflows/module-ci.yml。见 https://xrobot.work/docs/proj_man/proj-man-create-mod。

A Module is added by a pull request that appends its repository URL to modules in index.yaml. The repository follows the XRobot 1.0 Module layout: the primary header Repo.hpp declares a plain class Repo and contains a MODULE MANIFEST V2 block, and CI calls the shared workflow xrobot-org/XRobot/.github/workflows/module-ci.yml. See https://xrobot.work/docs/proj_man/proj-man-create-mod.

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors