mcap

McAp

O MCAP é um formato de contêiner modular e biblioteca de registro para mensagens pub/sub com serialização de mensagens arbitrárias. É destinado principalmente ao uso em aplicativos de robótica e funciona bem sob várias cargas de trabalho, restrições de recursos e requisitos de durabilidade.

Documentação

• Especificação de formato de arquivo
  • Definição da estrutura de Kaitai
• Motivação
• Matriz de suporte

Desenvolvedor Início rápido

As bibliotecas MCAP são fornecidas nos seguintes idiomas. Para obter orientações sobre cada idioma, consulte seu ReadMe correspondente:

Linguagem	Readme	API Docs	Nome do pacote	Versão
C ++	Readme	API Docs	mcap
Ir	Readme	API Docs		Veja lançamentos
Python	Readme	API Docs	mcap
JavaScript/TypeScript	Readme	API Docs	@mcap/core
Swift	Readme	API Docs		Veja lançamentos
Ferrugem	Readme	API Docs	mcap

Para executar os testes de conformidade, você precisará usar o GIT LFS, que é usado para armazenar os logs de teste em tests/conformance/data .

Ferramenta da CLI

Interaja com os arquivos MCAP da linha de comando usando a ferramenta MCAP CLI.

Faça o download da versão mais recente mcap-cli na página de lançamentos.

Licença

MIT Licença.

Processo de liberação

A numeração de liberação segue um formato major.Minor.patch, abreviado como "xyz" abaixo.

O CI criará os pacotes apropriados assim que as tags forem pressionadas, conforme descrito abaixo.

Biblioteca Go

1. Atualize a Version em go/mcap/versão.go
2. Marque uma versão correspondente ao número da versão go/mcap/vX.YZ .

CLI

Tag A Liberação releases/mcap-cli/vX.YZ .

O número da versão é definido no horário de construção com base na tag.

C ++

1. Atualize a versão em todos os arquivos relevantes
   • CPP/BENCH/CONANFILE.PY
   • cpp/build-docs.sh
   • cpp/build.sh
   • cpp/docs/conanfile.py
   • cpp/exemplos/conanfile.py
   • CPP/MCAP/Incluir/MCAP/Types.hpp ( MCAP_LIBRARY_VERSION )
   • CPP/MCAP/incluir/conanfile.py
   • cpp/test/conanfile.py
2. Tag Um lançamento correspondendo às releases/cpp/vX.YZ

Python

Existem vários pacotes Python; Atualizando qualquer seguinte um processo semelhante.

1. Atualize a versão no arquivo __init.py__ apropriado
2. Marque uma versão
   • Para a biblioteca MCAP Core, corresponda às releases/python/vX.YZ
   • Para outros pacotes, use releases/python/PACKAGE/vX.YZ
     • Por exemplo, releases/python/mcap/v1.2.3

TypeScript

Existem vários pacotes TS; Atualizando qualquer seguinte um processo semelhante.

1. Atualize a versão no package.json apropriado
2. Tag A Liberação releases/typescript/PACKAGE/vX.YZ
   • Por exemplo, releases/typescript/core/v1.2.3

Swift

Tag Um lançamento correspondendo aos releases/swift/vX.YZ

Ferrugem

1. Atualize a versão em ferrugem/carga.toml
2. Tag Um lançamento correspondendo às versões do número da versão releases/rust/vX.YZ

Citações

Se você usar o MCAP em sua pesquisa, cite -o em seu trabalho. Nosso formato de citação sugerido é:

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

Substitua a versão e os campos de data pela versão do software que você usou e a data em que a obteve. Citar o MCAP ajudará a espalhar a conscientização do projeto e fortalecerá o ecossistema.