NanoPB: Umgang mit optionalen Feldern in C++

Siehe auch: C-Version: Umgang mit optionalen Feldern in C

NanoPB ist eine auf Codegröße optimierte Protocol-Buffers-Implementierung für Embedded-Systeme. Dieser Beitrag zeigt, wie man optionale Felder (proto3 optional) in C++ mit NanoPB behandelt.

Proto-Definition

Erstelle zunächst eine .proto-Datei mit optionalen Feldern:

optional.proto

syntax = "proto3";

package example;

message OptionalMessage {
  optional uint32 id = 1;
  optional string name = 2;
  optional float temperature = 3;
  bool active = 4;  // Reguläres (nicht-optionales) Feld
}

syntax = "proto3";

package example;

message OptionalMessage {
  optional uint32 id = 1;
  optional string name = 2;
  optional float temperature = 3;
  bool active = 4;  // Reguläres (nicht-optionales) Feld
}

NanoPB-Code generieren

Generiere den NanoPB-Code mit einer .options-Datei, um die String-Puffergrößen festzulegen:

Erstelle optional.options:

optional.options

example.OptionalMessage.name max_size:64

example.OptionalMessage.name max_size:64

Dann generieren:

generate_nanopb_optional.sh

protoc --nanopb_out=. optional.proto

protoc --nanopb_out=. optional.proto

Dadurch werden optional.pb.h und optional.pb.c generiert.

C++-Beispiel

Hier ist ein vollständiges C++-Beispiel zur Behandlung optionaler Felder:

optional_example.cpp

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

int main() {
    // Puffer für kodierte Nachricht
    uint8_t buffer[256];
    size_t message_length;
    
    // --- KODIERUNG ---
    example_OptionalMessage message = example_OptionalMessage_init_zero;
    
    // Optionale Felder setzen
    message.id = 42;
    message.has_id = true;  // Wichtig: has_*-Flag setzen
    
    strncpy(message.name, "Sensor1", sizeof(message.name) - 1);
    message.has_name = true;  // Wichtig: has_*-Flag setzen
    
    message.temperature = 23.5f;
    message.has_temperature = true;  // Wichtig: has_*-Flag setzen
    
    // Reguläres Feld (kein has_*-Flag erforderlich)
    message.active = true;
    
    // Strom für Kodierung erstellen
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Nachricht kodieren
    if (!pb_encode(&ostream, example_OptionalMessage_fields, &message)) {
        printf("Kodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("%zu Bytes kodiert\n", message_length);
    
    // Hex-Dump der kodierten Daten ausgeben
    printf("Kodierte Daten: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DEKODIERUNG ---
    example_OptionalMessage decoded = example_OptionalMessage_init_zero;
    
    // Strom für Dekodierung erstellen
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Nachricht dekodieren
    if (!pb_decode(&istream, example_OptionalMessage_fields, &decoded)) {
        printf("Dekodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Dekodierte Werte ausgeben
    printf("Dekodierte Werte:\n");
    if (decoded.has_id) {
        printf("  id: %u\n", decoded.id);
    } else {
        printf("  id: (nicht gesetzt)\n");
    }
    
    if (decoded.has_name) {
        printf("  name: %s\n", decoded.name);
    } else {
        printf("  name: (nicht gesetzt)\n");
    }
    
    if (decoded.has_temperature) {
        printf("  temperature: %f\n", decoded.temperature);
    } else {
        printf("  temperature: (nicht gesetzt)\n");
    }
    
    printf("  active: %s\n", decoded.active ? "true" : "false");
    
    return 0;
}

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

int main() {
    // Puffer für kodierte Nachricht
    uint8_t buffer[256];
    size_t message_length;
    
    // --- KODIERUNG ---
    example_OptionalMessage message = example_OptionalMessage_init_zero;
    
    // Optionale Felder setzen
    message.id = 42;
    message.has_id = true;  // Wichtig: has_*-Flag setzen
    
    strncpy(message.name, "Sensor1", sizeof(message.name) - 1);
    message.has_name = true;  // Wichtig: has_*-Flag setzen
    
    message.temperature = 23.5f;
    message.has_temperature = true;  // Wichtig: has_*-Flag setzen
    
    // Reguläres Feld (kein has_*-Flag erforderlich)
    message.active = true;
    
    // Strom für Kodierung erstellen
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Nachricht kodieren
    if (!pb_encode(&ostream, example_OptionalMessage_fields, &message)) {
        printf("Kodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("%zu Bytes kodiert\n", message_length);
    
    // Hex-Dump der kodierten Daten ausgeben
    printf("Kodierte Daten: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DEKODIERUNG ---
    example_OptionalMessage decoded = example_OptionalMessage_init_zero;
    
    // Strom für Dekodierung erstellen
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Nachricht dekodieren
    if (!pb_decode(&istream, example_OptionalMessage_fields, &decoded)) {
        printf("Dekodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Dekodierte Werte ausgeben
    printf("Dekodierte Werte:\n");
    if (decoded.has_id) {
        printf("  id: %u\n", decoded.id);
    } else {
        printf("  id: (nicht gesetzt)\n");
    }
    
    if (decoded.has_name) {
        printf("  name: %s\n", decoded.name);
    } else {
        printf("  name: (nicht gesetzt)\n");
    }
    
    if (decoded.has_temperature) {
        printf("  temperature: %f\n", decoded.temperature);
    } else {
        printf("  temperature: (nicht gesetzt)\n");
    }
    
    printf("  active: %s\n", decoded.active ? "true" : "false");
    
    return 0;
}

Kompilierbefehl

Kompiliere das Beispiel mit NanoPB. NanoPB wird normalerweise verwendet, indem die Quelldateien direkt in dein Projekt eingebunden werden:

compile_optional_example.sh

g++ -o optional_example optional_example.cpp optional.pb.c pb_common.c pb_encode.c pb_decode.c -I.

g++ -o optional_example optional_example.cpp optional.pb.c pb_common.c pb_encode.c pb_decode.c -I.

Hinweis: NanoPB-Quelldateien (pb_common.c, pb_encode.c, pb_decode.c) müssen direkt mit deinem Projekt kompiliert werden. Du kannst diese aus dem NanoPB-GitHub-Repository beziehen.

Python-Testskript

Um die Kodierung zu überprüfen, kannst du die Python-Protobuf-Bibliothek verwenden:

test_optional.py

import optional_pb2

# Binärdaten lesen
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Dekodieren
msg = optional_pb2.OptionalMessage()
msg.ParseFromString(data)

print("Python dekodierte Werte:")
print(f"  id: {msg.id if msg.HasField('id') else '(nicht gesetzt)'}")
print(f"  name: {msg.name if msg.HasField('name') else '(nicht gesetzt)'}")
print(f"  temperature: {msg.temperature if msg.HasField('temperature') else '(nicht gesetzt)'}")
print(f"  active: {msg.active}")

import optional_pb2

# Binärdaten lesen
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Dekodieren
msg = optional_pb2.OptionalMessage()
msg.ParseFromString(data)

print("Python dekodierte Werte:")
print(f"  id: {msg.id if msg.HasField('id') else '(nicht gesetzt)'}")
print(f"  name: {msg.name if msg.HasField('name') else '(nicht gesetzt)'}")
print(f"  temperature: {msg.temperature if msg.HasField('temperature') else '(nicht gesetzt)'}")
print(f"  active: {msg.active}")

Kompiliere zunächst die Python-Protobuf-Definitionen:

compile_python_optional.sh

protoc --python_out=. optional.proto

protoc --python_out=. optional.proto

Ändere dann das C++-Beispiel, um die kodierten Daten in einer Datei zu speichern:

save_encoded_optional.cpp

// Nach der Kodierung, dies hinzufügen:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

// Nach der Kodierung, dies hinzufügen:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Beispiel mit fehlenden optionalen Feldern

Hier ist ein Beispiel, bei dem einige optionale Felder nicht gesetzt sind:

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;
    
    // --- KODIERUNG ---
    example_OptionalMessage message = example_OptionalMessage_init_zero;
    
    // Nur einige optionale Felder setzen
    message.id = 42;
    message.has_id = true;
    
    // name und temperature nicht gesetzt (has_*-Flags bleiben false)
    
    // Reguläres Feld immer gesetzt
    message.active = true;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_OptionalMessage_fields, &message)) {
        printf("Kodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("%zu Bytes kodiert (teilweise)\n", message_length);
    
    // --- DEKODIERUNG ---
    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("Dekodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Dekodierte Werte:\n");
    printf("  id: %s\n", decoded.has_id ? "gesetzt" : "nicht gesetzt");
    printf("  name: %s\n", decoded.has_name ? "gesetzt" : "nicht gesetzt");
    printf("  temperature: %s\n", decoded.has_temperature ? "gesetzt" : "nicht gesetzt");
    printf("  active: %s\n", decoded.active ? "true" : "false");
    
    return 0;
}

#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;
    
    // --- KODIERUNG ---
    example_OptionalMessage message = example_OptionalMessage_init_zero;
    
    // Nur einige optionale Felder setzen
    message.id = 42;
    message.has_id = true;
    
    // name und temperature nicht gesetzt (has_*-Flags bleiben false)
    
    // Reguläres Feld immer gesetzt
    message.active = true;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_OptionalMessage_fields, &message)) {
        printf("Kodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("%zu Bytes kodiert (teilweise)\n", message_length);
    
    // --- DEKODIERUNG ---
    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("Dekodierung fehlgeschlagen: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Dekodierte Werte:\n");
    printf("  id: %s\n", decoded.has_id ? "gesetzt" : "nicht gesetzt");
    printf("  name: %s\n", decoded.has_name ? "gesetzt" : "nicht gesetzt");
    printf("  temperature: %s\n", decoded.has_temperature ? "gesetzt" : "nicht gesetzt");
    printf("  active: %s\n", decoded.active ? "true" : "false");
    
    return 0;
}

Wichtige Punkte

Optionale Felder: Verwende das Schlüsselwort optional in proto3
has_*-Flags: NanoPB generiert has_fieldname-Boolesche Flags für jedes optionale Feld
Kodierung: Setze sowohl den Feldwert ALS AUCH das has_*-Flag auf true
Dekodierung: Prüfe das has_*-Flag, bevor du optionale Feldwerte verwendest
Reguläre Felder: Nicht-optionale Felder haben keine has_*-Flags
Standardwerte: Optionale Felder, die nicht gesetzt sind, haben Standardwerte (0, leerer String usw.)
Platzersparnis: Optionale Felder, die nicht gesetzt sind, werden nicht in die kodierte Nachricht aufgenommen

Wann optionale Felder verwendet werden

Wenn ein Feld in verschiedenen Nachrichteninstanzen vorhanden sein kann oder nicht
Wenn du zwischen “nicht gesetzt” und “auf Standardwert gesetzt” unterscheiden möchtest
Wenn du Bandbreite sparen möchtest, indem du ungenutzte Felder weglässt
Wenn ein Feld nur in bestimmten Kontexten relevant ist

Erwartete Ausgabe (vollständiges Beispiel)

optional_full_expected_output.txt

19 Bytes kodiert
Kodierte Daten: 08 2a 12 07 53 65 6e 73 6f 72 31 1d 00 00 bc 41 30 01 
Dekodierte Werte:
  id: 42
  name: Sensor1
  temperature: 23.500000
  active: true

19 Bytes kodiert
Kodierte Daten: 08 2a 12 07 53 65 6e 73 6f 72 31 1d 00 00 bc 41 30 01 
Dekodierte Werte:
  id: 42
  name: Sensor1
  temperature: 23.500000
  active: true

Erwartete Ausgabe (Teilbeispiel)

optional_partial_expected_output.txt

4 Bytes kodiert (teilweise)
Kodierte Daten: 08 2a 30 01 
Dekodierte Werte:
  id: gesetzt
  name: nicht gesetzt
  temperature: nicht gesetzt
  active: true

4 Bytes kodiert (teilweise)
Kodierte Daten: 08 2a 30 01 
Dekodierte Werte:
  id: gesetzt
  name: nicht gesetzt
  temperature: nicht gesetzt
  active: true

Beachte, wie die teilweise Kodierung viel kleiner ist (4 Byte statt 19 Byte), da optionale Felder weggelassen werden.

Weitere NanoPB-Beiträge

Ähnliche Beiträge nach Kategorie: Embedded, C/C++, Protocol Buffers

Wenn dieser Beitrag dir geholfen hat, erwäge, mir einen Kaffee zu spendieren oder per PayPal zu spenden, um die Recherche und Veröffentlichung neuer Beiträge auf TechOverflow zu unterstützen

Buy me a coffee