meshtastic-protobuf/README.md

1.7 KiB

Meshtastic-protobufs

Open in Visual Studio Code CI CLA assistant

The protobuf definitions for the Meshtastic project (used by apps and the device code)

For questions on using these protobufs please post in our forum. We are friendly and we love people building/extending this work.

For documentation please visit:

For more information on protobufs (and tools to use them with the language of your choice) see

We are not placing any of these defs inside a package, because if you do the resulting nanopb version is super verbose package mesh.

Protobuf build instructions:

  • To build java classes for reading writing:
  • protoc -I=. --java_out /tmp mesh.proto

To generate Nanopb c code:

  • /home/kevinh/packages/nanopb-0.4.5-linux-x86/generator-bin/protoc --nanopb_out=/tmp -I=app/src/main/proto mesh.proto

Nanopb binaries available here:

To lint:

  • Install protolint: brew tap yoheimuta/protolint; brew install protolint
  • Run it from the main directory: protolint lint .
  • (optional) Have it fix the mundane warnings: protolint lint -fix .
  • See https://github.com/yoheimuta/protolint for more info