NanoPB: Cómo manejar tipos escalares básicos en C

Ver también: C++ version: How to handle basic scalar types in C++

NanoPB es una implementación de Protocol Buffers optimizada para el tamaño de código en sistemas embebidos. Esta entrada muestra cómo manejar tipos escalares básicos (enteros, flotantes, booleanos) en C con NanoPB.

Definición Proto

Primero, crea un archivo .proto simple con 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;
}

Generar código NanoPB

Genera el código C de NanoPB usando el generador nanopb:

generate_nanopb_scalars.sh

protoc --nanopb_out=. scalars.proto

protoc --nanopb_out=. scalars.proto

Esto generará scalars.pb.h y scalars.pb.c.

Ejemplo en C

Aquí hay un ejemplo completo en C que codifica y decodifica el mensaje:

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() {
    // Búfer para el mensaje codificado
    uint8_t buffer[128];
    size_t message_length;
    
    // --- CODIFICACIÓN ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Establecer los valores de los 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;
    
    // Crear flujo para codificación
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Codificar el mensaje
    if (!pb_encode(&ostream, example_ScalarMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // Imprimir volcado hexadecimal de los datos codificados
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DECODIFICACIÓN ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Crear flujo para decodificación
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Decodificar el mensaje
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Imprimir valores decodificados
    printf("Decoded values:\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() {
    // Búfer para el mensaje codificado
    uint8_t buffer[128];
    size_t message_length;
    
    // --- CODIFICACIÓN ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Establecer los valores de los 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;
    
    // Crear flujo para codificación
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Codificar el mensaje
    if (!pb_encode(&ostream, example_ScalarMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // Imprimir volcado hexadecimal de los datos codificados
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DECODIFICACIÓN ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Crear flujo para decodificación
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Decodificar el mensaje
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Imprimir valores decodificados
    printf("Decoded values:\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 compilación

Compila el ejemplo con nanopb. NanoPB se usa típicamente incluyendo los archivos fuente directamente en tu proyecto:

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: Los archivos fuente de NanoPB (pb_common.c, pb_encode.c, pb_decode.c) deben compilarse directamente con tu proyecto. Puedes obtenerlos del repositorio de GitHub de NanoPB.

Script de prueba en Python

Para verificar la codificación, puedes usar la biblioteca protobuf de Python:

test_scalars.py

import scalars_pb2

# Leer los datos binarios
with open('encoded.bin', 'rb') as f:
    data = f.read()

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

print("Python decoded values:")
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

# Leer los datos binarios
with open('encoded.bin', 'rb') as f:
    data = f.read()

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

print("Python decoded values:")
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}")

Primero, compila las definiciones protobuf de Python:

compile_python_scalars.sh

protoc --python_out=. scalars.proto

protoc --python_out=. scalars.proto

Luego modifica el ejemplo en C para guardar los datos codificados en un archivo:

save_encoded_scalars.c

// Después de codificar, añade esto:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

// Después de codificar, añade esto:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Puntos clave

Usa *_init_zero para inicializar mensajes con valores por defecto
pb_ostream_from_buffer crea un flujo de salida para codificación
pb_istream_from_buffer crea un flujo de entrada para decodificación
pb_encode y pb_decode manejan la codificación/decodificación real
Verifica los valores de retorno y usa PB_GET_ERROR para el manejo de errores
En C, usa conversiones explícitas para los especificadores de formato printf con enteros de 64 bits

Salida 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

Diferencias con C++

La versión en C es casi idéntica a la versión en C++, con solo diferencias menores:

Usa #include <stdint.h> para tipos de enteros de ancho fijo
Usa conversiones explícitas para los especificadores de formato printf
No se necesitan características específicas de C++ (el código generado es el mismo)

Más entradas de NanoPB

Echa un vistazo a artículos similares por categoría: Embedded, C/C++, Protocol Buffers

Si este artículo te ha ayudado, considera invitarme a un café o hacer una donación vía PayPal para apoyar la investigación y publicación de nuevos artículos en TechOverflow

Buy me a coffee