meshtastic-protobuf/README.md

33 wiersze
1.6 KiB
Markdown
Czysty Zwykły widok Historia

2020-03-02 17:44:55 +00:00
# Meshtastic-protobufs
2021-07-09 04:27:25 +00:00
[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-protobufs)
2022-01-20 18:03:25 +00:00
[![CI](https://github.com/meshtastic/Meshtastic-protobufs/actions/workflows/ci.yml/badge.svg)](https://github.com/meshtastic/Meshtastic-protobufs/actions/workflows/ci.yml)
2021-04-16 04:43:28 +00:00
The protobuf definitions for the Meshtastic project (used by apps and the device code)
2021-04-15 06:56:06 +00:00
For questions on using these protobufs please post in our [forum](meshtastic.discourse.group). We are friendly and we love people building/extending this work.
2021-11-23 18:44:00 +00:00
For documentation please visit:
* [Meshtastic Docs](https://meshtastic.org/docs/developers/protobufs/api).
For more information on protobufs (and tools to use them with the language of your choice) see
* https://developers.google.com/protocol-buffers/docs/proto3
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:
2021-11-23 19:26:32 +00:00
* /home/kevinh/packages/nanopb-0.4.4-linux-x86/generator-bin/protoc --nanopb_out=/tmp -I=app/src/main/proto mesh.proto
2021-11-23 18:44:00 +00:00
Nanopb binaries available here:
* https://jpa.kapsi.fi/nanopb/download/ use nanopb 0.4.4
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