C Python CMake Shell Makefile Batchfile
Permalink
Failed to load latest commit information.
docs More backslash escape fixes Apr 11, 2018
examples examples/simple: fix warning about printf format Jan 6, 2018
extra Fix typo in comment Apr 5, 2018
generator Add --no-strip-path command line option (#326) May 31, 2018
tests Add check for large extension field number (issue #306) Apr 9, 2018
tools Use pyinstaller for linux binary packages instead of old bbfreeze Sep 17, 2017
.gitignore Add script for making linux binary package Dec 29, 2013
.travis.yml travis: Invoke scons directly Sep 15, 2017
AUTHORS.txt Update changelog & authors Apr 9, 2018
BUILD Bazel: export LICENSE.txt file. Aug 10, 2016
CHANGELOG.txt Fix dates in changelog (#329) Jul 21, 2018
CMakeLists.txt Add nanopb_PROTOC_PATH variable to CMakeLists.txt Jan 8, 2018
CONTRIBUTING.md Add contributing.md to provide issue templates on github Oct 24, 2015
LICENSE.txt Moving files around Dec 29, 2013
README.md Update download links (changes in webhost system) Feb 13, 2017
WORKSPACE bazel: Add WORKSPACE Jul 9, 2017
library.json Publishing nanopb-0.3.9 Sep 23, 2017
pb.h Fix decoding of non-packable fixed count repeated fields Feb 14, 2018
pb_common.c Fix multiple oneofs in same message (issue #229) Dec 31, 2016
pb_common.h Rename poorly named identifier to avoid name conflicts. Aug 18, 2014
pb_decode.c Handle a single non-packed repeated fixed count field Feb 14, 2018
pb_decode.h Added pb_decode_delimited_noinit Sep 18, 2017
pb_encode.c Handle a single non-packed repeated fixed count field Feb 14, 2018
pb_encode.h Add pb_en/decode_nullterminated() (part of #278) Sep 16, 2017

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. 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.