NanoPB: Как работать с базовыми скалярными типами в C

NanoPB — это оптимизированная по размеру кода реализация Protocol Buffers для встраиваемых систем. В этом посте показано, как работать с базовыми скалярными типами (целые числа, числа с плавающей точкой, логические значения) в C с помощью NanoPB.

Определение Proto

Сначала создайте простой файл .proto с базовыми скалярными типами:

scalars.proto

syntax = "proto3";

package example;

message ScalarMessage {
  uint32 uint32_value = 1;
  uint64 uint64_value = 2;
  int32 int32_value = 3;
  int64 int64_value = 4;
  float float_value = 5;
  bool bool_value = 6;
}

syntax = "proto3";

package example;

message ScalarMessage {
  uint32 uint32_value = 1;
  uint64 uint64_value = 2;
  int32 int32_value = 3;
  int64 int64_value = 4;
  float float_value = 5;
  bool bool_value = 6;
}

Генерация кода NanoPB

Сгенерируйте C-код NanoPB с помощью генератора nanopb:

generate_nanopb_scalars.sh

protoc --nanopb_out=. scalars.proto

protoc --nanopb_out=. scalars.proto

Это создаст файлы scalars.pb.h и scalars.pb.c.

Пример на C

Вот полный пример на C, который кодирует и декодирует сообщение:

scalars_example.c

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "scalars.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Буфер для закодированного сообщения
    uint8_t buffer[128];
    size_t message_length;
    
    // --- КОДИРОВАНИЕ ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Установка значений полей
    message.uint32_value = 42;
    message.uint64_value = 1234567890ULL;
    message.int32_value = -100;
    message.int64_value = -9876543210LL;
    message.float_value = 3.14159f;
    message.bool_value = true;
    
    // Создание потока для кодирования
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Кодирование сообщения
    if (!pb_encode(&ostream, example_ScalarMessage_fields, &message)) {
        printf("Кодирование не удалось: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Закодировано %zu байт\n", message_length);
    
    // Вывод шестнадцатеричного дампа закодированных данных
    printf("Закодированные данные: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Создание потока для декодирования
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Декодирование сообщения
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Декодирование не удалось: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Вывод декодированных значений
    printf("Декодированные значения:\n");
    printf("  uint32_value: %u\n", (unsigned int)decoded.uint32_value);
    printf("  uint64_value: %llu\n", (unsigned long long)decoded.uint64_value);
    printf("  int32_value: %d\n", decoded.int32_value);
    printf("  int64_value: %lld\n", (long long)decoded.int64_value);
    printf("  float_value: %f\n", decoded.float_value);
    printf("  bool_value: %s\n", decoded.bool_value ? "true" : "false");
    
    return 0;
}

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "scalars.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Буфер для закодированного сообщения
    uint8_t buffer[128];
    size_t message_length;
    
    // --- КОДИРОВАНИЕ ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Установка значений полей
    message.uint32_value = 42;
    message.uint64_value = 1234567890ULL;
    message.int32_value = -100;
    message.int64_value = -9876543210LL;
    message.float_value = 3.14159f;
    message.bool_value = true;
    
    // Создание потока для кодирования
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Кодирование сообщения
    if (!pb_encode(&ostream, example_ScalarMessage_fields, &message)) {
        printf("Кодирование не удалось: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Закодировано %zu байт\n", message_length);
    
    // Вывод шестнадцатеричного дампа закодированных данных
    printf("Закодированные данные: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Создание потока для декодирования
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Декодирование сообщения
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Декодирование не удалось: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Вывод декодированных значений
    printf("Декодированные значения:\n");
    printf("  uint32_value: %u\n", (unsigned int)decoded.uint32_value);
    printf("  uint64_value: %llu\n", (unsigned long long)decoded.uint64_value);
    printf("  int32_value: %d\n", decoded.int32_value);
    printf("  int64_value: %lld\n", (long long)decoded.int64_value);
    printf("  float_value: %f\n", decoded.float_value);
    printf("  bool_value: %s\n", decoded.bool_value ? "true" : "false");
    
    return 0;
}

Команда компиляции

Скомпилируйте пример с помощью nanopb. NanoPB обычно используется путём прямого включения исходных файлов в ваш проект:

compile_scalars_example.sh

gcc -o scalars_example scalars_example.c scalars.pb.c pb_common.c pb_encode.c pb_decode.c -I.

gcc -o scalars_example scalars_example.c scalars.pb.c pb_common.c pb_encode.c pb_decode.c -I.

Примечание: Исходные файлы NanoPB (pb_common.c, pb_encode.c, pb_decode.c) необходимо компилировать напрямую вместе с вашим проектом. Вы можете получить их из репозитория NanoPB на GitHub.

Скрипт тестирования на Python

Чтобы проверить кодирование, вы можете использовать библиотеку protobuf для Python:

test_scalars.py

import scalars_pb2

# Чтение бинарных данных
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Декодирование
msg = scalars_pb2.ScalarMessage()
msg.ParseFromString(data)

print("Декодированные Python значения:")
print(f"  uint32_value: {msg.uint32_value}")
print(f"  uint64_value: {msg.uint64_value}")
print(f"  int32_value: {msg.int32_value}")
print(f"  int64_value: {msg.int64_value}")
print(f"  float_value: {msg.float_value}")
print(f"  bool_value: {msg.bool_value}")

import scalars_pb2

# Чтение бинарных данных
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Декодирование
msg = scalars_pb2.ScalarMessage()
msg.ParseFromString(data)

print("Декодированные Python значения:")
print(f"  uint32_value: {msg.uint32_value}")
print(f"  uint64_value: {msg.uint64_value}")
print(f"  int32_value: {msg.int32_value}")
print(f"  int64_value: {msg.int64_value}")
print(f"  float_value: {msg.float_value}")
print(f"  bool_value: {msg.bool_value}")

Сначала скомпилируйте определения protobuf для Python:

compile_python_scalars.sh

protoc --python_out=. scalars.proto

protoc --python_out=. scalars.proto

Затем измените пример на C, чтобы сохранить закодированные данные в файл:

save_encoded_scalars.c

// После кодирования добавьте это:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

// После кодирования добавьте это:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Ключевые моменты

Используйте *_init_zero для инициализации сообщений значениями по умолчанию
pb_ostream_from_buffer создаёт выходной поток для кодирования
pb_istream_from_buffer создаёт входной поток для декодирования
pb_encode и pb_decode выполняют фактическое кодирование/декодирование
Проверяйте возвращаемые значения и используйте PB_GET_ERROR для обработки ошибок
В C используйте явные приведения типов для спецификаторов формата printf с 64-битными целыми числами

Ожидаемый вывод

scalars_expected_output.txt

Encoded 28 bytes
Encoded data: 08 2a 10 d2 95 89 04 18 9c ff ff ff ff ff ff ff 01 20 c6 ef be ad de 05 2d 15 49 0e 40 30 01 
Decoded values:
  uint32_value: 42
  uint64_value: 1234567890
  int32_value: -100
  int64_value: -9876543210
  float_value: 3.141590
  bool_value: true

Encoded 28 bytes
Encoded data: 08 2a 10 d2 95 89 04 18 9c ff ff ff ff ff ff ff 01 20 c6 ef be ad de 05 2d 15 49 0e 40 30 01 
Decoded values:
  uint32_value: 42
  uint64_value: 1234567890
  int32_value: -100
  int64_value: -9876543210
  float_value: 3.141590
  bool_value: true

Отличия от C++

Версия на C практически идентична версии на C++, с лишь незначительными отличиями:

Используйте #include <stdint.h> для типов целых чисел фиксированной ширины
Используйте явные приведения типов для спецификаторов формата printf
Не требуются специфичные для C++ функции (сгенерированный код такой же)

Другие посты о NanoPB

Check out similar posts by category: Embedded, C/C++, Protocol Buffers

If this post helped you, please consider buying me a coffee or donating via PayPal to support research & publishing of new posts on TechOverflow

Buy me a coffee