mcap

MCAP

MCAP es un formato de contenedor modular y una biblioteca de registro para mensajes de pub/sub con serialización de mensajes arbitrarios. Está destinado principalmente a su uso en aplicaciones de robótica, y funciona bien bajo varias cargas de trabajo, limitaciones de recursos y requisitos de durabilidad.

Documentación

• Especificación de formato de archivo
  • Definición de Kaitai Struct
• Motivación
• Matriz de soporte

Inicio rápido del desarrollador

Las bibliotecas MCAP se proporcionan en los siguientes idiomas. Para obtener orientación sobre cada idioma, consulte su readme correspondiente:

Idioma	Readme	Documentos de API	Nombre del paquete	Versión
C ++	readme	Documentos de API	mcap
Ir	readme	Documentos de API		Ver lanzamientos
Pitón	readme	Documentos de API	mcap
JavaScript/TypeScript	readme	Documentos de API	@mcap/core
Rápido	readme	Documentos de API		Ver lanzamientos
Óxido	readme	Documentos de API	mcap

Para ejecutar las pruebas de conformidad, deberá usar GIT LFS, que se utiliza para almacenar los registros de prueba en tests/conformance/data .

Herramienta CLI

Interactúe con los archivos MCAP desde la línea de comandos utilizando la herramienta MCAP CLI.

Descargue la última versión mcap-cli de la página de comunicados.

Licencia

Licencia MIT.

Proceso de lanzamiento

La numeración de lanzamiento sigue a un formato Major.Minor.patch, abreviado como "XYZ" a continuación.

CI construirá los paquetes apropiados una vez que se empujen las etiquetas, como se describe a continuación.

Biblioteca GO

1. Actualice la Version en Go/MCAP/Version.GO
2. Etiquete una versión que coincida con el número de versión go/mcap/vX.YZ .

CLI

Etiqueta un lanzamiento releases/mcap-cli/vX.YZ .

El número de versión se establece en la hora de compilación en función de la etiqueta.

C ++

1. Actualizar la versión en todos los archivos relevantes
   • CPP/Bench/Conanfile.py
   • cpp/build-docs.sh
   • cpp/build.sh
   • CPP/Docs/Conanfile.py
   • cpp/ejemplos/conanfile.py
   • CPP/MCAP/incluido/mcap/tipos.hpp ( MCAP_LIBRARY_VERSION )
   • CPP/MCAP/incluido/conanfile.py
   • CPP/Test/ConanFile.py
2. Etiqueta una versión que coincide con el número de versión releases/cpp/vX.YZ

Pitón

Hay varios paquetes de Python; La actualización de cualquiera sigue un proceso similar.

1. Actualice la versión en el archivo __init.py__ apropiado
2. Etiqueta un lanzamiento
   • Para la biblioteca Core MCAP, coincida con las releases/python/vX.YZ
   • Para otros paquetes, use releases/python/PACKAGE/vX.YZ
     • Por ejemplo, releases/python/mcap/v1.2.3

Mecanografiado

Hay varios paquetes TS; La actualización de cualquiera sigue un proceso similar.

1. Actualice la versión en el package.json apropiado.json
2. Etiqueta A Release Matching releases/typescript/PACKAGE/vX.YZ
   • Por ejemplo, releases/typescript/core/v1.2.3

Rápido

Etiqueta una versión que coincida con el número de versión releases/swift/vX.YZ

Óxido

1. Actualizar la versión en Rust/Cargo.toml
2. Etiqueta una versión que coincide con el número de versión releases/rust/vX.YZ

Citas

Si usa MCAP en su investigación, cíquelo en su trabajo. Nuestro formato de cita sugerido es:

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

Reemplace los campos de versión y fecha con la versión del software que utilizó y la fecha en que lo obtuvo. Citar MCAP ayudará a difundir la conciencia del proyecto y fortalecer el ecosistema.