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.

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

Building nanopb - Using vcpkg

You can download and install nanopb using the vcpkg dependency manager:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install nanopb

The nanopb port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

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.5.dev1217.tar.gz (41.3 kB view details)

Uploaded Source

Built Distribution

nanopb-0.4.5.dev1217-py2.py3-none-any.whl (43.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file nanopb-0.4.5.dev1217.tar.gz.

File metadata

  • Download URL: nanopb-0.4.5.dev1217.tar.gz
  • Upload date:
  • Size: 41.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.5.3 Linux/5.7.0-050700rc7-generic

File hashes

Hashes for nanopb-0.4.5.dev1217.tar.gz
Algorithm Hash digest
SHA256 3fc06342ddc81654e327943093610084e5bcbbb2f04a7d8bf35f87687ad438a2
MD5 5b13687da69a74cb92db5df743204583
BLAKE2b-256 0720d45c6f8b55f5ec058879811e758ec51bf4a9bfc366038659e04d1e204867

See more details on using hashes here.

File details

Details for the file nanopb-0.4.5.dev1217-py2.py3-none-any.whl.

File metadata

  • Download URL: nanopb-0.4.5.dev1217-py2.py3-none-any.whl
  • Upload date:
  • Size: 43.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.5.3 Linux/5.7.0-050700rc7-generic

File hashes

Hashes for nanopb-0.4.5.dev1217-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fdc5b4e69241b00b8f5dc943a67c6b19f4005c3a76291de6b8de9edb61249c26
MD5 53c6512d8aac02292feaf02e51303e92
BLAKE2b-256 f55bcf6983f536caa6919cd693f1095afe374cdc98d03a765cfeb769bc05ff60

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