NanoPB: Como lidar com tipos escalares básicos em C

Veja também: Versão C++: Como lidar com tipos escalares básicos em C++

O NanoPB é uma implementação de Protocol Buffers otimizada para tamanho de código, destinada a sistemas embarcados. Este post mostra como lidar com tipos escalares básicos (inteiros, floats, booleanos) em C com NanoPB.

Definição Proto

Primeiro, crie um arquivo .proto simples com tipos escalares básicos:

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;
}

Gerar código NanoPB

Gere o código C do NanoPB usando o gerador nanopb:

generate_nanopb_scalars.sh

protoc --nanopb_out=. scalars.proto

protoc --nanopb_out=. scalars.proto

Isso gerará scalars.pb.h e scalars.pb.c.

Exemplo em C

Aqui está um exemplo completo em C que codifica e decodifica a mensagem:

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() {
    // Buffer para a mensagem codificada
    uint8_t buffer[128];
    size_t message_length;
    
    // --- CODIFICAÇÃO ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Definir valores dos campos
    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;
    
    // Criar stream para codificação
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Codificar a mensagem
    if (!pb_encode(&ostream, example_ScalarMessage_fields, &message)) {
        printf("Codificação falhou: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Codificados %zu bytes\n", message_length);
    
    // Imprimir hex dump dos dados codificados
    printf("Dados codificados: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DECODIFICAÇÃO ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Criar stream para decodificação
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Decodificar a mensagem
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Decodificação falhou: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Imprimir valores decodificados
    printf("Valores decodificados:\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() {
    // Buffer para a mensagem codificada
    uint8_t buffer[128];
    size_t message_length;
    
    // --- CODIFICAÇÃO ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Definir valores dos campos
    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;
    
    // Criar stream para codificação
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Codificar a mensagem
    if (!pb_encode(&ostream, example_ScalarMessage_fields, &message)) {
        printf("Codificação falhou: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Codificados %zu bytes\n", message_length);
    
    // Imprimir hex dump dos dados codificados
    printf("Dados codificados: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DECODIFICAÇÃO ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Criar stream para decodificação
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Decodificar a mensagem
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Decodificação falhou: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Imprimir valores decodificados
    printf("Valores decodificados:\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;
}

Comando de compilação

Compile o exemplo com o nanopb. O NanoPB é tipicamente utilizado incluindo os arquivos fonte diretamente em seu projeto:

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.

Nota: Os arquivos fonte do NanoPB (pb_common.c, pb_encode.c, pb_decode.c) precisam ser compilados diretamente com seu projeto. Você pode obtê-los no repositório GitHub do NanoPB.

Script de teste em Python

Para verificar a codificação, você pode usar a biblioteca protobuf do Python:

test_scalars.py

import scalars_pb2

# Ler os dados binários
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Decodificar
msg = scalars_pb2.ScalarMessage()
msg.ParseFromString(data)

print("Valores decodificados pelo 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

# Ler os dados binários
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Decodificar
msg = scalars_pb2.ScalarMessage()
msg.ParseFromString(data)

print("Valores decodificados pelo 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}")

Primeiro, compile as definições protobuf do Python:

compile_python_scalars.sh

protoc --python_out=. scalars.proto

protoc --python_out=. scalars.proto

Em seguida, modifique o exemplo em C para salvar os dados codificados em um arquivo:

save_encoded_scalars.c

// Após a codificação, adicione isto:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

// Após a codificação, adicione isto:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Pontos principais

Use *_init_zero para inicializar mensagens com valores padrão
pb_ostream_from_buffer cria um stream de saída para codificação
pb_istream_from_buffer cria um stream de entrada para decodificação
pb_encode e pb_decode lidam com a codificação/decodificação real
Verifique os valores de retorno e use PB_GET_ERROR para tratamento de erros
Em C, use casts explícitos para os especificadores de formato do printf com inteiros de 64 bits

Saída esperada

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

Diferenças do C++

A versão em C é quase idêntica à versão em C++, com apenas pequenas diferenças:

Use #include <stdint.h> para tipos de inteiros de largura fixa
Use casts explícitos para os especificadores de formato do printf
Não são necessários recursos específicos do C++ (o código gerado é o mesmo)

Mais posts sobre 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