mcap

MCAP

MCAP est un format de conteneur modulaire et une bibliothèque de journalisation pour les messages pub / sous avec sérialisation des messages arbitraires. Il est principalement destiné à être utilisé dans les applications robotiques et fonctionne bien sous diverses charges de travail, contraintes de ressources et exigences de durabilité.

Documentation

• Spécification du format de fichier
  • Définition de structure Kaitai
• Motivation
• Matrice de support

Département rapide du développeur

Les bibliothèques MCAP sont fournies dans les langues suivantes. Pour obtenir des conseils sur chaque langue, consultez sa lecture correspondante:

Langue	Réadmettre	Docs API	Nom de package	Version
C ++	réadmettre	Docs API	mcap
Aller	réadmettre	Docs API		Voir les versions
Python	réadmettre	Docs API	mcap
JavaScript / TypeScript	réadmettre	Docs API	@mcap/core
Rapide	réadmettre	Docs API		Voir les versions
Rouiller	réadmettre	Docs API	mcap

Pour exécuter les tests de conformité, vous devrez utiliser GIT LFS, qui est utilisé pour stocker les journaux de test sous tests/conformance/data .

Outil CLI

Interagissez avec les fichiers MCAP à partir de la ligne de commande à l'aide de l'outil MCAP CLI.

Téléchargez la dernière version mcap-cli depuis la page des versions.

Licence

Licence MIT.

Processus de libération

La numérotation des versions suit un format majeur.minor.patch, abrégé en "xyz" ci-dessous.

CI créera les packages appropriés une fois les balises poussées, comme décrit ci-dessous.

Bibliothèque

1. Mettez à jour la Version dans go / mcap / version.go
2. Tag une version correspondant au numéro de version go/mcap/vX.YZ

CLI

Marquez une version releases/mcap-cli/vX.YZ

Le numéro de version est défini au moment de la construction en fonction de la balise.

C ++

1. Mettez à jour la version dans tous les fichiers pertinents
   • cpp / banc / conanfile.py
   • cpp / build-docs.sh
   • cpp / build.sh
   • cpp / docs / conanfile.py
   • cpp / exemples / conanfile.py
   • CPP / MCAP / include / mcap / types.hpp ( MCAP_LIBRARY_VERSION )
   • cpp / mcap / include / conanfile.py
   • cpp / test / conanfile.py
2. Marquez une version correspondant aux releases/cpp/vX.YZ

Python

Il existe plusieurs packages Python; La mise à jour de n'importe quel suit un processus similaire.

1. Mettez à jour la version dans le fichier __init.py__ approprié
2. Marquez une version
   • Pour la bibliothèque Core MCAP, faites correspondre les releases/python/vX.YZ
   • Pour d'autres packages, utilisez releases/python/PACKAGE/vX.YZ
     • Par exemple, releases/python/mcap/v1.2.3

Manuscrit

Il existe plusieurs packages TS; La mise à jour de n'importe quel suit un processus similaire.

1. Mettez à jour la version dans le package.json approprié.json
2. Marquez une version releases/typescript/PACKAGE/vX.YZ
   • Par exemple, releases/typescript/core/v1.2.3

Rapide

Tag une version correspondant aux releases/swift/vX.YZ

Rouiller

1. Mettez à jour la version dans Rust / Cargo.toml
2. Marquez une version correspondant aux releases/rust/vX.YZ

Citations

Si vous utilisez MCAP dans votre recherche, veuillez le citer dans votre travail. Notre format de citation suggéré est:

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

Veuillez remplacer les champs de version et de date par la version du logiciel que vous avez utilisé et la date que vous l'avez obtenue. Citant MCAP aidera à faire connaître le projet et à renforcer l'écosystème.