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

Latest change Weekly build

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.

Generating the headers

Protocol Buffers messages are defined in a .proto file, which follows a standard format that is compatible with all Protocol Buffers libraries. To use it with nanopb, you need to generate .pb.c and .pb.h files from it:

python generator/nanopb_generator.py myprotocol.proto  # For source checkout
generator-bin/nanopb_generator myprotocol.proto        # For binary package

(Note: For instructions for nanopb-0.3.9.x and older, see the documentation of that particular version here)

The binary packages for Windows, Linux and Mac OS X should contain all necessary dependencies, including Python, python-protobuf library and protoc. If you are using a git checkout or a plain source distribution, you will need to install Python separately. Once you have Python, you can install the other dependencies with pip install --upgrade protobuf grpcio-tools.

You can further customize the header generation by creating an .options file. See documentation for details.

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 or pip install scons). 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.7.dev1340.tar.gz (81.7 kB view details)

Uploaded Source

Built Distribution

nanopb-0.4.7.dev1340-py2.py3-none-any.whl (50.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file nanopb-0.4.7.dev1340.tar.gz.

File metadata

  • Download URL: nanopb-0.4.7.dev1340.tar.gz
  • Upload date:
  • Size: 81.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.10 Linux/5.15.0-1014-azure

File hashes

Hashes for nanopb-0.4.7.dev1340.tar.gz
Algorithm Hash digest
SHA256 382463a147095fae7195badc86348ad744319ca87329bae157996adac94dc81a
MD5 01d91b6d457158170a5baf4cf2fc7d56
BLAKE2b-256 d22ae0d9e27b1d97956b94a9287ff58989f03e94bc142c4198b68ef45f929532

See more details on using hashes here.

File details

Details for the file nanopb-0.4.7.dev1340-py2.py3-none-any.whl.

File metadata

  • Download URL: nanopb-0.4.7.dev1340-py2.py3-none-any.whl
  • Upload date:
  • Size: 50.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.8.10 Linux/5.15.0-1014-azure

File hashes

Hashes for nanopb-0.4.7.dev1340-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 99bd408b4ca347aa06edf5fdb8abe2b957b608317e196223f3e826a1949d49cc
MD5 23bf7d1b042e1ca2485b7777eb31fe13
BLAKE2b-256 2bb48e4d3cd840b002ae3a7e7b4c7fb3388ee0a3130c7947406a376359a27d24

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