Google Git
Sign in
android / platform / external / nanopb-c / e39787e03951bc779e63797dd33f113c38f8a8b1
commite39787e03951bc779e63797dd33f113c38f8a8b1[log] [tgz]
authorCole Faust <colefaust@google.com>Thu Sep 08 18:35:07 2022 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Thu Sep 08 18:35:07 2022 +0000
tree6c8f99caa41441d024d8d75c5b99ccc241ce94a0
parente59a7b2378971262bb098042147323f454cdccde [diff]
parent495c9a97b5a6f34919bca73f386cb96854f7ea99 [diff]
Convert protoc-gen-nanopb to python 3 am: cd9c9aa9f1 am: 495c9a97b5

Original change: https://android-review.googlesource.com/c/platform/external/nanopb-c/+/2208439

Change-Id: Ibc3004a5a75d923dc98af97dbd438bc5c338994f
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: 6c8f99caa41441d024d8d75c5b99ccc241ce94a0
  1. .github/
  2. docs/
  3. examples/
  4. extra/
  5. generator/
  6. patches/
  7. spm-test/
  8. spm_headers/
  9. tests/
  10. tools/
  11. .gitignore
  12. .travis.yml
  13. Android.bp
  14. AUTHORS.txt
  15. BUILD
  16. CHANGELOG.txt
  17. CleanSpec.mk
  18. CMakeLists.txt
  19. CONTRIBUTING.md
  20. library.json
  21. LICENSE.txt
  22. METADATA
  23. MODULE_LICENSE_BSD_LIKE
  24. NOTICE
  25. OWNERS
  26. Package.swift
  27. pb.h
  28. pb_common.c
  29. pb_common.h
  30. pb_decode.c
  31. pb_decode.h
  32. pb_encode.c
  33. pb_encode.h
  34. README.md
  35. WORKSPACE
README.md

Nanopb - Protocol Buffers for Embedded Systems

Build Status

Nanopb is a small code-size Protocol Buffers implementation in ansi C. It is especially suitable for use in microcontrollers, but fits any memory restricted system.

Using the nanopb library

To use the nanopb library, you need to do two things:

  1. Compile your .proto files for nanopb, using protoc.
  2. Include pb_encode.c, pb_decode.c and pb_common.c in your project.

The easiest way to get started is to study the project in “examples/simple”. It contains a Makefile, which should work directly under most Linux systems. However, for any other kind of build system, see the manual steps in README.txt in that folder.

Using the Protocol Buffers compiler (protoc)

The nanopb generator is implemented as a plugin for the Google‘s own protoc compiler. This has the advantage that there is no need to reimplement the basic parsing of .proto files. However, it does mean that you need the Google’s protobuf library in order to run the generator.

If you have downloaded a binary package for nanopb (either Windows, Linux or Mac OS X version), the protoc binary is included in the ‘generator-bin’ folder. In this case, you are ready to go. Simply run this command:

generator-bin/protoc --nanopb_out=. myprotocol.proto

However, if you are using a git checkout or a plain source distribution, you need to provide your own version of protoc and the Google‘s protobuf library. On Linux, the necessary packages are protobuf-compiler and python-protobuf. On Windows, you can either build Google’s protobuf library from source or use one of the binary distributions of it. In either case, if you use a separate protoc, you need to manually give the path to nanopb generator:

protoc --plugin=protoc-gen-nanopb=nanopb/generator/protoc-gen-nanopb ...

Running the tests

If you want to perform further development of the nanopb core, or to verify its functionality using your compiler and platform, you'll want to run the test suite. The build rules for the test suite are implemented using Scons, so you need to have that installed (ex: sudo apt install scons on Ubuntu). To run the tests:

cd tests
scons

This will show the progress of various test cases. If the output does not end in an error, the test cases were successful.

Note: Mac OS X by default aliases ‘clang’ as ‘gcc’, while not actually supporting the same command line options as gcc does. To run tests on Mac OS X, use: “scons CC=clang CXX=clang”. Same way can be used to run tests with different compilers on any platform.