aboutsummaryrefslogtreecommitdiffstats
path: root/libs/nanopb/examples/simple/README.txt
blob: ee77bfc70c5537af441fb706452d8159697f4646 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Nanopb example "simple"
=======================

This example demonstrates the very basic use of nanopb. It encodes and
decodes a simple message.

The code uses four different API functions:

  * pb_ostream_from_buffer() to declare the output buffer that is to be used
  * pb_encode() to encode a message
  * pb_istream_from_buffer() to declare the input buffer that is to be used
  * pb_decode() to decode a message

Example usage
-------------

On Linux, simply type "make" to build the example. After that, you can
run it with the command: ./simple

On other platforms, you first have to compile the protocol definition using
the following command::

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

After that, add the following four files to your project and compile:

  simple.c  simple.pb.c  pb_encode.c  pb_decode.c