mcap

Макап

MCAP - это модульный формат контейнера и библиотека ведения журнала для пабов/суб -сообщений с произвольной сериализацией сообщений. Он в основном предназначен для использования в приложениях для робототехники и хорошо работает под различными рабочими нагрузками, ограничениями ресурсов и долговечности.

Документация

• Спецификация формата файла
  • Определение структуры Kaitai
• Мотивация
• Поддержка матрицы

Разработчик быстрый старт

Библиотеки MCAP предоставляются на следующих языках. Для руководства на каждом языке см. Его соответствующий Readme:

Язык	Ридме	API документы	Название пакета	Версия
C ++	Ридме	API документы	mcap
Идти	Ридме	API документы		Смотрите релизы
Питон	Ридме	API документы	mcap
JavaScript/TypeScript	Ридме	API документы	@mcap/core
Быстрый	Ридме	API документы		Смотрите релизы
Ржавчина	Ридме	API документы	mcap

Чтобы запустить тесты соответствия, вам нужно будет использовать GIT LFS, которые используются для хранения журналов тестов в разделе tests/conformance/data .

CLI инструмент

Взаимодействуйте с файлами MCAP из командной строки, используя инструмент MCAP CLI.

Загрузите последнюю версию mcap-cli со страницы релизов.

Лицензия

MIT Лицензия.

Процесс выпуска

Нумерация релиза следует за форматом major.minor.patch, сокращенного как «xyz» ниже.

CI создаст соответствующие пакеты после того, как теги будут нажаты, как описано ниже.

Go Библиотека

1. Обновите Version в Go/MCAP/version.go
2. Оставьте релиз, соответствующий номеру версии go/mcap/vX.YZ .

Кли

Оставьте релиз releases/mcap-cli/vX.YZ .

Номер версии устанавливается во время сборки на основе тега.

C ++

1. Обновите версию во всех соответствующих файлах
   • CPP/скамейка/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; Обновление любого следует за аналогичным процессом.

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 поможет распространить информацию о проекте и укрепить экосистему.