TechOverflow Logo
TechOverflow

NanoPB: Jak pracovat s volitelnými poli v C++

English Deutsch Français 简体中文 Español Українська Português Русский Čeština

Viz také: Verze pro C: Jak pracovat s volitelnými poli v C

NanoPB je implementace Protocol Buffers optimalizovaná na velikost kódu pro vestavěné systémy. Tento příspěvek ukazuje, jak pracovat s volitelnými poli (proto3 optional) v C++ s NanoPB.

Definice Proto

Nejprve vytvořte soubor .proto s volitelnými poli:

optional.proto
syntax = "proto3";

package example;

message OptionalMessage {
  optional uint32 id = 1;
  optional string name = 2;
  optional float temperature = 3;
  bool active = 4;  // Běžné (nevolitelné) pole
}

Generování NanoPB kódu

Vygenerujte kód NanoPB se souborem .options pro určení velikostí bufferu pro řetězce:

Vytvořte optional.options:

optional.options
example.OptionalMessage.name max_size:64

Poté vygenerujte:

generate_nanopb_optional.sh
protoc --nanopb_out=. optional.proto

Tím se vygenerují soubory optional.pb.h a optional.pb.c.

Příklad v C++

Zde je kompletní příklad v C++ zpracovávající volitelná pole:

optional_example.cpp
#include <stdio.h>
#include <string.h>
#include "optional.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Buffer pro kódovanou zprávu
    uint8_t buffer[256];
    size_t message_length;
    
    // --- KÓDOVÁNÍ ---
    example_OptionalMessage message = example_OptionalMessage_init_zero;
    
    // Nastavení volitelných polí
    message.id = 42;
    message.has_id = true;  // Důležité: nastavit příznak has_*
    
    strncpy(message.name, "Sensor1", sizeof(message.name) - 1);
    message.has_name = true;  // Důležité: nastavit příznak has_*
    
    message.temperature = 23.5f;
    message.has_temperature = true;  // Důležité: nastavit příznak has_*
    
    // Běžné pole (není potřeba příznak has_*)
    message.active = 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_OptionalMessage_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_OptionalMessage decoded = example_OptionalMessage_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_OptionalMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Výpis dekódovaných hodnot
    printf("Decoded values:\n");
    if (decoded.has_id) {
        printf("  id: %u\n", decoded.id);
    } else {
        printf("  id: (not set)\n");
    }
    
    if (decoded.has_name) {
        printf("  name: %s\n", decoded.name);
    } else {
        printf("  name: (not set)\n");
    }
    
    if (decoded.has_temperature) {
        printf("  temperature: %f\n", decoded.temperature);
    } else {
        printf("  temperature: (not set)\n");
    }
    
    printf("  active: %s\n", decoded.active ? "true" : "false");
    
    return 0;
}

Příkaz pro kompilaci

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

compile_optional_example.sh
g++ -o optional_example optional_example.cpp optional.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_optional.py
import optional_pb2

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

# Dekódování
msg = optional_pb2.OptionalMessage()
msg.ParseFromString(data)

print("Python decoded values:")
print(f"  id: {msg.id if msg.HasField('id') else '(not set)'}")
print(f"  name: {msg.name if msg.HasField('name') else '(not set)'}")
print(f"  temperature: {msg.temperature if msg.HasField('temperature') else '(not set)'}")
print(f"  active: {msg.active}")

Nejprve zkompilujte definice protobuf pro Python:

compile_python_optional.sh
protoc --python_out=. optional.proto

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

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

Příklad s chybějícími volitelnými poli

Zde je příklad, kde některá volitelná pole nejsou nastavena:

optional_partial_example.cpp
#include <stdio.h>
#include <string.h>
#include "optional.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    // --- KÓDOVÁNÍ ---
    example_OptionalMessage message = example_OptionalMessage_init_zero;
    
    // Nastavení pouze některých volitelných polí
    message.id = 42;
    message.has_id = true;
    
    // name a temperature nejsou nastaveny (příznaky has_* zůstávají false)
    
    // Běžné pole je vždy nastaveno
    message.active = true;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_OptionalMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes (partial)\n", message_length);
    
    // --- DEKÓDOVÁNÍ ---
    example_OptionalMessage decoded = example_OptionalMessage_init_zero;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_OptionalMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  id: %s\n", decoded.has_id ? "set" : "not set");
    printf("  name: %s\n", decoded.has_name ? "set" : "not set");
    printf("  temperature: %s\n", decoded.has_temperature ? "set" : "not set");
    printf("  active: %s\n", decoded.active ? "true" : "false");
    
    return 0;
}

Klíčové body

Kdy použít volitelná pole

Očekávaný výstup (kompletní příklad)

optional_full_expected_output.txt
Encoded 19 bytes
Encoded data: 08 2a 12 07 53 65 6e 73 6f 72 31 1d 00 00 bc 41 30 01 
Decoded values:
  id: 42
  name: Sensor1
  temperature: 23.500000
  active: true

Očekávaný výstup (částečný příklad)

optional_partial_expected_output.txt
Encoded 4 bytes (partial)
Encoded data: 08 2a 30 01 
Decoded values:
  id: set
  name: not set
  temperature: not set
  active: true

Všimněte si, že částečné kódování je mnohem menší (4 bajty vs 19 bajtů), protože volitelná pole jsou vynechána.

Další příspěvky o NanoPB

Podívejte se na podobné články podle kategorie: Embedded, C/C++, Protocol Buffers