mcap

Mcap

MCAP adalah format wadah modular dan perpustakaan logging untuk pesan pub/sub dengan serialisasi pesan sewenang -wenang. Ini terutama dimaksudkan untuk digunakan dalam aplikasi robotika, dan bekerja dengan baik di bawah berbagai beban kerja, kendala sumber daya, dan persyaratan daya tahan.

Dokumentasi

• Spesifikasi Format File
  • Definisi struct Kaitai
• Motivasi
• Matriks Dukungan

Pengembang Start Quick

Perpustakaan MCAP disediakan dalam bahasa berikut. Untuk panduan pada setiap bahasa, lihat readme yang sesuai:

Bahasa	Readme	API Docs	Nama paket	Versi
C ++	readme	API Docs	mcap
Pergi	readme	API Docs		Lihat rilis
Python	readme	API Docs	mcap
JavaScript/naskah	readme	API Docs	@mcap/core
Cepat	readme	API Docs		Lihat rilis
Karat	readme	API Docs	mcap

Untuk menjalankan tes kesesuaian, Anda perlu menggunakan GIT LFS, yang digunakan untuk menyimpan log uji di bawah tests/conformance/data .

Alat CLI

Berinteraksi dengan file MCAP dari baris perintah menggunakan alat MCAP CLI.

Unduh versi mcap-cli terbaru dari halaman rilis.

Lisensi

Lisensi MIT.

Proses rilis

Penomoran rilis mengikuti format Major.Minor.Patch, disingkat sebagai "XYZ" di bawah ini.

CI akan membangun paket yang sesuai setelah tag didorong, seperti yang dijelaskan di bawah ini.

Pergi Perpustakaan

1. Perbarui Version di Go/MCAP/Versi.go
2. Tag rilis yang cocok dengan nomor versi go/mcap/vX.YZ .

Cli

Tandai rilis rilis rilis releases/mcap-cli/vX.YZ .

Nomor versi diatur pada waktu build berdasarkan tag.

C ++

1. Perbarui versi di semua file yang relevan
   • CPP/Bench/Conanfile.py
   • CPP/build-docs.sh
   • cpp/build.sh
   • cpp/docs/conanfile.py
   • CPP/Contoh/conanfile.py
   • CPP/MCAP/termasuk/mcap/type.hpp ( MCAP_LIBRARY_VERSION )
   • CPP/MCAP/termasuk/conanfile.py
   • cpp/test/conanfile.py
2. Tag rilis yang cocok dengan releases/cpp/vX.YZ

Python

Ada beberapa paket Python; Memperbarui setiap proses serupa.

1. Perbarui versi dalam file __init.py__ yang sesuai
2. Tandai rilis
   • Untuk perpustakaan MCAP inti, cocokkan releases/python/vX.YZ
   • Untuk paket lain, gunakan releases/python/PACKAGE/vX.YZ
     • Misalnya, releases/python/mcap/v1.2.3

Naskah

Ada beberapa paket TS; Memperbarui setiap proses serupa.

1. Perbarui versi dalam package.json yang sesuai.json
2. Tandai rilis releases/typescript/PACKAGE/vX.YZ
   • Misalnya, releases/typescript/core/v1.2.3

Cepat

Tag rilis yang cocok dengan nomor versi releases/swift/vX.YZ

Karat

1. Perbarui Versi di Rust/Cargo.toml
2. Tag rilis yang cocok dengan nomor versi releases/rust/vX.YZ

Kutipan

Jika Anda menggunakan MCAP dalam riset Anda, silakan mengutipnya dalam pekerjaan Anda. Format kutipan yang kami sarankan adalah:

 @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}
}

Harap ganti bidang versi dan tanggal dengan versi perangkat lunak yang Anda gunakan, dan tanggal Anda memperolehnya. Mengutip MCAP akan membantu menyebarkan kesadaran proyek dan memperkuat ekosistem.