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將有助於傳播對項目的認識並加強生態系統。