mcap

MCAP

MCAP ist ein modulares Containerformat und eine Protokollierungsbibliothek für Pub/Sub -Nachrichten mit einer willkürlichen Nachrichtenserialisierung. Es ist in erster Linie für die Verwendung in Robotikanwendungen gedacht und funktioniert unter verschiedenen Workloads, Ressourcenbeschränkungen und Haltbarkeitsanforderungen gut.

Dokumentation

• Dateiformatspezifikation
  • Kaitai Struct Definition
• Motivation
• Stützmatrix

Entwickler schneller Start

MCAP -Bibliotheken werden in den folgenden Sprachen bereitgestellt. Für Anleitung zu jeder Sprache finden Sie in der entsprechenden Readme:

Sprache	Readme	API -Dokumente	Paketname	Version
C ++	Readme	API -Dokumente	mcap
Gehen	Readme	API -Dokumente		Siehe Veröffentlichungen
Python	Readme	API -Dokumente	mcap
JavaScript/TypeScript	Readme	API -Dokumente	@mcap/core
Schnell	Readme	API -Dokumente		Siehe Veröffentlichungen
Rost	Readme	API -Dokumente	mcap

Um die Konformitätstests auszuführen, müssen Sie Git -LFS verwenden, mit denen die in tests/conformance/data zu Testprotokolle gespeicherten Testprotokolle gespeichert werden.

CLI -Werkzeug

Interagieren Sie mit MCAP -Dateien aus der Befehlszeile mit dem MCAP -CLI -Tool.

Laden Sie die neueste mcap-cli Version von der Releases-Seite herunter.

Lizenz

MIT -Lizenz.

Freigabeprozess

Die Veröffentlichungsnummerierung folgt einem Major.minor.patch -Format, das unten als "xyz" abgekürzt wird.

CI erstellt die entsprechenden Pakete, sobald die Tags wie unten beschrieben gedrückt sind.

Bibliothek gehen

1. Aktualisieren Sie die Version in Go/McAP/Version.go
2. Markieren Sie eine Version, die mit der Versionsnummer go/mcap/vX.YZ entspricht.

Cli

Tag ein Release-Matching releases/mcap-cli/vX.YZ .

Die Versionsnummer wird basierend auf dem Tag in der Build -Zeit festgelegt.

C ++

1. Aktualisieren Sie die Version in allen relevanten Dateien
   • CPP/Bank/Conanfil.py
   • CPP/Build-docs.sh
   • CPP/Build.sh
   • cpp/docs/conanfil.py
   • CPP/Beispiele/conanfile.py
   • CPP/MCAP/include/mcap/Typen.hpp ( MCAP_LIBRARY_VERSION )
   • CPP/MCAP/include/conanFile.py
   • cpp/test/conanfil.py
2. Tag ein Release, das mit den Versionsnummer releases/cpp/vX.YZ entspricht

Python

Es gibt mehrere Python -Pakete; Die Aktualisierung eines ähnlichen Vorgangs.

1. Aktualisieren Sie die Version in der entsprechenden __init.py__ -Datei
2. Markieren Sie eine Veröffentlichung
   • Für die Core MCAP -Bibliothek übereinstimmen die releases/python/vX.YZ
   • Verwenden Sie für andere Pakete releases/python/PACKAGE/vX.YZ
     • Zum Beispiel releases/python/mcap/v1.2.3

Typoskript

Es gibt mehrere TS -Pakete; Die Aktualisierung eines ähnlichen Vorgangs.

1. Aktualisieren Sie die Version im entsprechenden package.json
2. Tag ein Release -Matching releases/typescript/PACKAGE/vX.YZ
   • Beispielsweise releases/typescript/core/v1.2.3

Schnell

Markieren Sie eine Version, die den Versionsnummer releases/swift/vX.YZ entspricht

Rost

1. Aktualisieren Sie die Version in Rust/Cargo.toml
2. Markieren Sie eine Veröffentlichung, die den Versionsnummer releases/rust/vX.YZ entspricht

Zitate

Wenn Sie MCAP in Ihrer Recherche verwenden, zitieren Sie diese bitte in Ihrer Arbeit. Unser vorgeschlagenes Zitierformat lautet:

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

Bitte ersetzen Sie die Versions- und Datumsfelder durch die Version der von Ihnen verwendeten Software und das Datum, das Sie erhalten haben. Unter Berufung auf MCAP wird das Bewusstsein für das Projekt verteilt und das Ökosystem stärken.