Skip to main content

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.

Project description

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 (see section below) 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 the nanopb generator to the protoc-gen-nanopb plugin, as follows:

protoc --plugin=protoc-gen-nanopb=nanopb/generator/protoc-gen-nanopb --nanopb_out=. myprotocol.proto

Note that the above protoc-based commands are the 1-command versions of a 2-command process, as described in the "Nanopb: Basic concepts" document under the section "Compiling .proto files for nanopb". Here is the 2-command process:

protoc -omyprotocol.pb myprotocol.proto
python nanopb/generator/nanopb_generator.py myprotocol.pb

Building Google's protobuf library from source

When building Google's protobuf library from source, be sure to follow both the C++ installation instructions and the Python installation instructions, as both are required:

  1. Protobuf's C++ build & installation instructions
  2. Protobuf's Python build & installation instructions

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.

For embedded platforms, there is currently support for running the tests on STM32 discovery board and simavr AVR simulator. Use scons PLATFORM=STM32 and scons PLATFORM=AVR to run these tests.

Build systems and integration

Nanopb C code itself is designed to be portable and easy to build on any platform. Often the bigger hurdle is running the generator which takes in the .proto files and outputs .pb.c definitions.

There exist build rules for several systems:

And also integration to platform interfaces:

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nanopb-0.4.1.dev1013.tar.gz (40.4 kB view details)

Uploaded Source

Built Distribution

nanopb-0.4.1.dev1013-py2.py3-none-any.whl (41.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file nanopb-0.4.1.dev1013.tar.gz.

File metadata

  • Download URL: nanopb-0.4.1.dev1013.tar.gz
  • Upload date:
  • Size: 40.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/2.7.13 Linux/3.16.0-4-686-pae

File hashes

Hashes for nanopb-0.4.1.dev1013.tar.gz
Algorithm Hash digest
SHA256 491400d669bfbda90009a3fa316985e45fb7c7bc8fe5dea8ed3a6daaa6ad7bb7
MD5 6d0102f722a3d04940056b2f12393e46
BLAKE2b-256 60395875a34cbc34e0f3aeef50abea3c1a459dde1319001d0ddb893460683946

See more details on using hashes here.

File details

Details for the file nanopb-0.4.1.dev1013-py2.py3-none-any.whl.

File metadata

  • Download URL: nanopb-0.4.1.dev1013-py2.py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/2.7.13 Linux/3.16.0-4-686-pae

File hashes

Hashes for nanopb-0.4.1.dev1013-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 294afa0da9b87c868711763577ffa0e2675f871cce9df056c30c5418ac829afb
MD5 d7a69b78c5a0a8833a8519c9409f0639
BLAKE2b-256 adaccfbabf7d8f18c1c1f09fb374193316941fb2ec66d53270c6c2f82dc34415

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page