mcap

MCAP

MCAP是一种模块化容器格式和记录库，用于使用任意消息序列化的酒吧/子消息。它主要用于用于机器人技术应用程序，并在各种工作负载，资源限制和耐用性要求下都能很好地工作。

文档

• 文件格式规范
  • Kaitai结构定义
• 动机
• 支持矩阵

开发人员快速启动

MCAP库以以下语言提供。有关每种语言的指导，请参阅其相应的读数：

语言	读书我	API文档	软件包名称	版本
C ++	读书我	API文档	mcap
去	读书我	API文档		请参阅版本
Python	读书我	API文档	mcap
JavaScript/打字稿	读书我	API文档	@mcap/core
迅速	读书我	API文档		请参阅版本
锈	读书我	API文档	mcap

要运行一致性测试，您将需要使用git LFS，该测试用于将测试日志存储在tests/conformance/data下。

CLI工具

使用MCAP CLI工具从命令行与MCAP文件进行交互。

从“版本”页面下载最新的mcap-cli版本。

执照

麻省理工学院许可证。

发布过程

释放编号遵循一个Major.minor.patch格式，在下面缩写为“ XYZ”。

如下所述，一旦推动标签，CI将构建适当的软件包。

去图书馆

1. 在GO/MCAP/版本中更新Version
2. 标记匹配版本号go/mcap/vX.YZ的版本。

CLI

标记发布匹配releases/mcap-cli/vX.YZ 。

版本号是根据标签在构建时间设置的。

C ++

1. 在所有相关文件中更新版本
   • cpp/bench/conanfile.py
   • CPP/build-docs.sh
   • cpp/build.sh
   • cpp/docs/conanfile.py
   • CPP/示例/conanfile.py
   • cpp/mcap/include/mcap/types.hpp（ MCAP_LIBRARY_VERSION ）
   • cpp/mcap/include/conanfile.py
   • cpp/test/conanfile.py
2. 标记匹配版本号releases/cpp/vX.YZ版本

Python

有几个Python包；更新任何以下是类似的过程。

1. 在适当的__init.py__文件中更新版本
2. 标记版本
   • 对于核心MCAP库，匹配图案releases/python/vX.YZ
   • 对于其他软件包，使用releases/python/PACKAGE/vX.YZ
     • 例如， releases/python/mcap/v1.2.3

打字稿

有几个TS软件包；更新任何以下是类似的过程。

1. 在适当的package.json中更新版本。
2. 标记版本匹配releases/typescript/PACKAGE/vX.YZ
   • 例如， releases/typescript/core/v1.2.3

迅速

标记匹配版本号releases/swift/vX.YZ版本

锈

1. 在Rust/Cargo.toml中更新版本
2. 标记匹配版本编号releases/rust/vX.YZ版本

引用

如果您在研究中使用MCAP，请在您的工作中引用它。我们建议的引用格式是：

 @software{MCAP,
  title = {MCAP: serialization-agnostic log container file format},
  author = {{Foxglove Developers}},
  url = {https://mcap.dev},
  version = {your version},
  date = {your date of access},
  year = {2024},
  publisher = {{Foxglove Technologies}},
  note = {Available from https://github.com/foxglove/mcap}
}

请用所使用的软件的版本以及您获得的日期替换版本和日期字段。引用MCAP将有助于传播对项目的认识并加强生态系统。