NanoPB: Jak pracovat se základními skalárními typy v C++

Viz také: Verze v C: Jak pracovat se základními skalárními typy v C

NanoPB je implementace Protocol Buffers optimalizovaná na velikost kódu pro vestavěné systémy. Tento příspěvek ukazuje, jak pracovat se základními skalárními typy (celá čísla, float, boolean) v C++ s NanoPB.

Definice Proto

Nejprve vytvořte jednoduchý soubor .proto se základními skalárními typy:

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

Generování NanoPB kódu

Vygenerujte C++ NanoPB kód pomocí generátoru nanopb:

generate_nanopb_scalars.sh

protoc --nanopb_out=. scalars.proto

protoc --nanopb_out=. scalars.proto

Tím se vygenerují scalars.pb.h a scalars.pb.c.

Příklad v C++

Zde je kompletní příklad v C++, který kóduje a dekóduje zprávu:

scalars_example.cpp

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

int main() {
    // Buffer pro kódovanou zprávu
    uint8_t buffer[128];
    size_t message_length;
    
    // --- KÓDOVÁNÍ ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Nastavení hodnot polí
    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;
    
    // Vytvoření streamu pro kódování
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Kódování zprávy
    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);
    
    // Výpis hex dumpu kódovaných dat
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DEKÓDOVÁNÍ ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Vytvoření streamu pro dekódování
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Dekódování zprávy
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Výpis dekódovaných hodnot
    printf("Decoded values:\n");
    printf("  uint32_value: %u\n", 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 <string.h>
#include "scalars.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Buffer pro kódovanou zprávu
    uint8_t buffer[128];
    size_t message_length;
    
    // --- KÓDOVÁNÍ ---
    example_ScalarMessage message = example_ScalarMessage_init_zero;
    
    // Nastavení hodnot polí
    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;
    
    // Vytvoření streamu pro kódování
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Kódování zprávy
    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);
    
    // Výpis hex dumpu kódovaných dat
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DEKÓDOVÁNÍ ---
    example_ScalarMessage decoded = example_ScalarMessage_init_zero;
    
    // Vytvoření streamu pro dekódování
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Dekódování zprávy
    if (!pb_decode(&istream, example_ScalarMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Výpis dekódovaných hodnot
    printf("Decoded values:\n");
    printf("  uint32_value: %u\n", 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;
}

Příkaz pro kompilaci

Zkompilujte příklad s nanopb. NanoPB se typicky používá tak, že se zdrojové soubory přímo vloží do vašeho projektu:

compile_scalars_example.sh

g++ -o scalars_example scalars_example.cpp scalars.pb.c pb_common.c pb_encode.c pb_decode.c -I.

g++ -o scalars_example scalars_example.cpp scalars.pb.c pb_common.c pb_encode.c pb_decode.c -I.

Poznámka: Zdrojové soubory NanoPB (pb_common.c, pb_encode.c, pb_decode.c) je třeba kompilovat přímo s vaším projektem. Můžete je získat z NanoPB GitHub repozitáře.

Testovací skript v Pythonu

Pro ověření kódování můžete použít knihovnu protobuf v Pythonu:

test_scalars.py

import scalars_pb2

# Načtení binárních dat
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Dekódování
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

# Načtení binárních dat
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Dekódování
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}")

Nejprve zkompilujte definice protobuf pro Python:

compile_python_scalars.sh

protoc --python_out=. scalars.proto

protoc --python_out=. scalars.proto

Poté upravte příklad v C++ tak, aby ukládal kódovaná data do souboru:

save_encoded_scalars.cpp

// Po kódování přidejte toto:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

// Po kódování přidejte toto:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Klíčové body

Použijte *_init_zero pro inicializaci zpráv s výchozími hodnotami
pb_ostream_from_buffer vytvoří výstupní stream pro kódování
pb_istream_from_buffer vytvoří vstupní stream pro dekódování
pb_encode a pb_decode zpracovávají vlastní kódování/dekódování
Kontrolujte návratové hodnoty a použijte PB_GET_ERROR pro zpracování chyb

Očekávaný výstup

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