/protocol-buffers

Primary LanguageCMakeGNU General Public License v3.0GPL-3.0

Protocol Buffers

Build Status

This repo contains the message structures (as protocol buffers) currently defined for inter application communication. Applications using protocol buffers should git submodule this repo.

Building the protos

You will need gRPC and cmake installed on your system :

$ mkdir build
$ cd build 
$ cmake -DCMAKE_CXX_FLAGS="-std=c++11" ..
$ make

Alternatively you can use the docker and conveniently build with a single docker-compose command:

$ docker-compose run c-build

Proto messages for other languages

You can find packaged proto messages for NodeJS in the npm and Pypi repos.

Contributing

As a general guideline, protocol buffers should be backwards compatible, so make sure any changes you do, are in fact backwards compatible.

Changes done to messages will impact many applications, so make sure you create a documented pull request with your changes and you reference all relevant reviewers (MALOS, MatrixOS, Vision Services) teams.

You should always keep your application compatible with the latest version of the protocol buffers, so make sure you run git submodule update --remote the protocol buffer submodule, or git pull origin master inside the submodule.

License