TechOverflow Logo
TechOverflow

NanoPB: Як обробляти типи bytes в C

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

Див. також: C++ version: How to handle bytes types in C++

NanoPB — це оптимізована за розміром коду реалізація Protocol Buffers для вбудованих систем. Ця публікація показує, як обробляти типи bytes у C за допомогою NanoPB.

Визначення Proto

Спочатку створіть файл .proto з полями типу bytes:

bytes.proto
syntax = "proto3";

package example;

message BytesMessage {
  bytes data = 1;
  bytes signature = 2;
}

Генерація коду NanoPB

Згенеруйте код NanoPB за допомогою файлу .options, щоб указати розміри буферів bytes:

Створіть bytes.options:

bytes.options
example.BytesMessage.data max_size:32
example.BytesMessage.signature max_size:16

Потім згенеруйте:

generate_nanopb_bytes.sh
protoc --nanopb_out=. bytes.proto

Це згенерує bytes.pb.h та bytes.pb.c.

Приклад на C з буферами фіксованого розміру

Ось повний приклад на C з використанням буферів фіксованого розміру:

bytes_example.c
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "bytes.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Буфер для закодованого повідомлення
    uint8_t buffer[256];
    size_t message_length;
    
    // --- КОДУВАННЯ ---
    example_BytesMessage message = example_BytesMessage_init_zero;
    
    // Встановити дані bytes
    const uint8_t data[] = {0x01, 0x02, 0x03, 0x04, 0x05};
    const uint8_t signature[] = {0xAA, 0xBB, 0xCC, 0xDD};
    
    message.data.size = sizeof(data);
    memcpy(message.data.bytes, data, sizeof(data));
    
    message.signature.size = sizeof(signature);
    memcpy(message.signature.bytes, signature, sizeof(signature));
    
    // Створити потік для кодування
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Закодувати повідомлення
    if (!pb_encode(&ostream, example_BytesMessage_fields, &message)) {
        printf("Помилка кодування: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Закодовано %zu байтів\n", message_length);
    
    // Вивести шістнадцятковий дамп закодованих даних
    printf("Закодовані дані: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- ДЕКОДУВАННЯ ---
    example_BytesMessage decoded = example_BytesMessage_init_zero;
    
    // Створити потік для декодування
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Декодувати повідомлення
    if (!pb_decode(&istream, example_BytesMessage_fields, &decoded)) {
        printf("Помилка декодування: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Вивести декодовані значення
    printf("Декодовані значення:\n");
    printf("  data: ");
    for (size_t i = 0; i < decoded.data.size; i++) {
        printf("%02x ", decoded.data.bytes[i]);
    }
    printf("\n");
    printf("  signature: ");
    for (size_t i = 0; i < decoded.signature.size; i++) {
        printf("%02x ", decoded.signature.bytes[i]);
    }
    printf("\n");
    
    return 0;
}

Команда компіляції

Скомпілюйте приклад з nanopb. NanoPB зазвичай використовується шляхом безпосереднього включення вихідних файлів у ваш проєкт:

compile_bytes_example.sh
gcc -o bytes_example bytes_example.c bytes.pb.c pb_common.c pb_encode.c pb_decode.c -I.

Примітка: Вихідні файли NanoPB (pb_common.c, pb_encode.c, pb_decode.c) потрібно компілювати безпосередньо з вашим проєктом. Їх можна отримати з NanoPB GitHub repository.

Скрипт тестування на Python

Щоб перевірити кодування, ви можете використати бібліотеку protobuf для Python:

test_bytes.py
import bytes_pb2

# Прочитати двійкові дані
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Декодувати
msg = bytes_pb2.BytesMessage()
msg.ParseFromString(data)

print("Декодовані значення Python:")
print(f"  data: {msg.data.hex()}")
print(f"  signature: {msg.signature.hex()}")

Спочатку скомпілюйте визначення protobuf для Python:

compile_python_bytes.sh
protoc --python_out=. bytes.proto

Потім змініть приклад на C, щоб зберегти закодовані дані у файл:

save_encoded_bytes.c
// Після кодування додайте це:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Альтернатива: bytes на основі зворотних викликів

Для динамічної обробки bytes ви можете використовувати зворотні виклики. Створіть bytes_callback.options:

bytes_callback.options
# Use callback for dynamic bytes
msg.BytesMessage.data callback
msg.BytesMessage.signature callback

Потім регенеруйте та використовуйте цей підхід:

bytes_callback_example.c
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include "bytes.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

typedef struct {
    uint8_t* data;
    size_t size;
} dynamic_bytes_t;

// Зворотний виклик кодувальника для bytes
bool bytes_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_bytes_t* bytes = (const dynamic_bytes_t*)*arg;
    
    if (!pb_encode_tag_for_field(stream, field))
        return false;
    
    return pb_encode_string(stream, bytes->data, bytes->size);
}

// Зворотний виклик декодера для bytes
bool bytes_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_bytes_t* bytes = (dynamic_bytes_t*)*arg;
    
    // Виділити буфер
    size_t size = stream->bytes_left;
    bytes->data = (uint8_t*)malloc(size);
    
    if (!bytes->data) {
        return false;
    }
    
    bytes->size = size;
    
    // Прочитати дані в буфер
    if (!pb_read(stream, bytes->data, size)) {
        free(bytes->data);
        bytes->data = NULL;
        bytes->size = 0;
        return false;
    }
    
    return true;
}

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    uint8_t data_array[] = {0x01, 0x02, 0x03, 0x04, 0x05};
    uint8_t signature_array[] = {0xAA, 0xBB, 0xCC, 0xDD};
    
    dynamic_bytes_t data = {data_array, sizeof(data_array)};
    dynamic_bytes_t signature = {signature_array, sizeof(signature_array)};
    
    // --- КОДУВАННЯ ---
    example_BytesMessage message = example_BytesMessage_init_zero;
    
    message.data.funcs.encode = bytes_encode_callback;
    message.data.arg = &data;
    message.signature.funcs.encode = bytes_encode_callback;
    message.signature.arg = &signature;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_BytesMessage_fields, &message)) {
        printf("Помилка кодування: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Закодовано %zu байтів\n", message_length);
    
    // --- ДЕКОДУВАННЯ ---
    example_BytesMessage decoded = example_BytesMessage_init_zero;
    dynamic_bytes_t decoded_data = {NULL, 0};
    dynamic_bytes_t decoded_signature = {NULL, 0};
    
    decoded.data.funcs.decode = bytes_decode_callback;
    decoded.data.arg = &decoded_data;
    decoded.signature.funcs.decode = bytes_decode_callback;
    decoded.signature.arg = &decoded_signature;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_BytesMessage_fields, &decoded)) {
        printf("Помилка декодування: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Декодовані значення:\n");
    printf("  data: ");
    for (size_t i = 0; i < decoded_data.size; i++) {
        printf("%02x ", decoded_data.data[i]);
    }
    printf("\n");
    printf("  signature: ");
    for (size_t i = 0; i < decoded_signature.size; i++) {
        printf("%02x ", decoded_signature.data[i]);
    }
    printf("\n");
    
    // Звільнити виділену пам'ять
    free(decoded_data.data);
    free(decoded_signature.data);
    
    return 0;
}

Ключові моменти

Коли використовувати який підхід

Очікуваний вивід

bytes_expected_output.txt
Encoded 14 bytes
Encoded data: 0a 05 01 02 03 04 05 12 04 aa bb cc dd 
Decoded values:
  data: 01 02 03 04 05 
  signature: aa bb cc dd

Відмінності від C++

Версія на C майже ідентична версії на C++, з ключовими відмінностями:

Випадки використання bytes

More NanoPB posts

Дивіться схожі статті за категоріями: Embedded, C/C++, Protocol Buffers