utility/msgpack/read_write_buffer.c
/*******************************************************************************
* # License
* Copyright 2019 Silicon Laboratories Inc. www.silabs.com
*******************************************************************************
*
* The licensor of this software is Silicon Laboratories Inc. Your use of this
* software is governed by the terms of Silicon Labs Master Software License
* Agreement (MSLA) available at
* www.silabs.com/about-us/legal/master-software-license-agreement. This
* software is distributed to you in Source Code format and is governed by the
* sections of the MSLA applicable to Source Code.
*
******************************************************************************/
#include "common.h"
#define BUFFER_LENGTH (2048)
#define ADC_READINGS (5)
/*************************************************************************************************
* This demonstrates how to serialize/de-serialize a MessagePack buffer located in RAM.
*
* The format of the data this example uses is as follows:
* (Note: While described in JSON format, the data is actually MessagePack formatted)
*
* {
* "time-ms" : <uint64:time in ms>,
* "time-utc" : "<string: time as UTC string>",
* "tick" : <uint32: RTOS tick count>,
* "mac" : "<binary string: MAC address as binary string>",
* "gpio-list": [ <array:bool: gpio values> ],
* "adc-readings" : {
* "adc-X" :
* {
* "format" : "<string:mV/raw>",
* "value" : <uint32:value>
* }
* ...
* }
* }
*/
gos_result_t read_write_buffer(void)
{
gos_result_t result;
uint8_t buffer[BUFFER_LENGTH];
uint32_t serialized_data_length = 0;
{
GOS_LOG("Failed to serialize data. Err code: %d", result);
}
{
GOS_LOG("Failed to deserialize data. Err code: %d", result);
}
return result;
}
/*************************************************************************************************
* Serial data using MessagePack format
*/
static gos_result_t serialize_data(uint8_t *buffer, uint32_t buffer_max_length, uint32_t *buffer_length_ptr)
{
MSGPACK_INIT_WITH_BUFFER(serialize_context, buffer, buffer_max_length);
// The root dictionary has 6 key/value pairs
// Write the current time
{
gos_utc_ms_t current_time_ms;
// Note: 'long' = 64bit
}
// Write UTC time
{
gos_iso8601_str_t current_time_utc;
GOS_VERIFY(gos_msgpack_write_dict_str(&serialize_context, "time-utc", (const char*)¤t_time_utc));
}
// Write current RTOS tick
{
// Note: 'int' = 32bit
}
// Write MAC address as binary string
{
char mac_str[24];
gos_mac_t mac_address;
str_to_mac(mac_str, &mac_address);
GOS_VERIFY(gos_msgpack_write_dict_bin(&serialize_context, "mac", mac_address.octet, sizeof(mac_address.octet)));
}
// Write the current value of all GPIOs as an array
{
// Write the array marker
// Write the array entries
{
}
}
// Write the ADCs object entries
{
// The sub-dictionary will have ADC_READINGS key/value pairs
for (int adc_reading_num = 0; adc_reading_num < ADC_READINGS; ++adc_reading_num)
{
uint16_t reading_value = 0;
char key_str[16];
//gos_adc_sample_type_t sample_type = ((adc_reading_num & 0x1) == 0) ? GOS_ADC_SAMPLE_TYPE_RAW : GOS_ADC_SAMPLE_TYPE_VOLTAGE;
const char *sample_type_str = ((adc_reading_num & 0x1) == 0) ? "raw" : "mV";
// Get the current value of the ADC
//gos_adc_sample(PLATFORM_STD_ADC, &reading_value, sample_type);
// Generate the entry key string
sprintf(key_str, "adc-%d", adc_reading_num);
// Write the adc sub-sub-dictionary which contains 2 entries
GOS_VERIFY(gos_msgpack_write_dict_dict(&serialize_context, key_str, 2));
// Write the 'format' entry
// Write the value entry
}
}
// Return the total length of the serialized buffer
*buffer_length_ptr = MSGPACK_BUFFER_USED(&serialize_context);
}
/*************************************************************************************************
* Deserialize the msgpack formatted buffer and print the contents
*/
static gos_result_t deserialize_and_print_data(uint8_t *buffer, uint32_t length)
{
gos_result_t result;
gos_msgpack_object_t *root_ptr;
// Dump the 'packed' binary data
gos_dump_buffer(buffer, length, "'Packed' binary dump:", GOS_DUMP_FLAGS(16, 1, LITTLE, ADD_SPACE, PRINT_ADDRESSES, PRINT_ASCII));
{
GOS_LOG("Failed to deserialize msgpack buffer. Err code: %d", result);
return result;
}
// Retrieve and print the 'time-ms' entry
{
if (obj == NULL)
{
GOS_LOG("WARN: 'time-ms' entry not found");
}
else
{
char str_buffer[32];
uint64_t time_ms;
MSGPACK_ULONG(obj, &time_ms);
}
}
// Retrieve and print the 'time-utc' entry
{
if (obj == NULL)
{
GOS_LOG("WARN: 'time-utc' entry not found");
}
{
GOS_LOG("WARN: 'time-utc' entry is NOT a string object");
}
else
{
char str_buffer[32];
}
}
// Retrieve and print the 'tick' entry
{
if (obj == NULL)
{
GOS_LOG("WARN: 'tick' entry not found");
}
else
{
}
}
// Retrieve and print the 'mac' entry
{
if (obj == NULL)
{
GOS_LOG("WARN: 'mac' entry not found");
}
{
GOS_LOG("WARN: 'mac' entry is NOT a binary string object");
}
else
{
gos_mac_t mac_address;
char mac_str[20];
}
}
// Retrieve and print the 'gpio-list' entry
{
if (obj == NULL)
{
GOS_LOG("WARN: 'gpio-list' entry not found");
}
{
GOS_LOG("WARN: 'gpio-list' entry is NOT an array object");
}
else
{
{
if (entry == NULL)
{
GOS_LOG("WARN: 'gpio-list' entry not found");
}
{
GOS_LOG("WARN: 'gpio-list' entry is NOT a boolean object");
}
else
{
}
}
}
}
// Retrieve and print the 'adc-readings' entry
{
if (obj == NULL)
{
GOS_LOG("WARN: 'adc-readings' entry not found");
}
{
GOS_LOG("WARN: 'adc-readings' entry is NOT a dict object");
}
else
{
{
char key_str[16];
sprintf(key_str, "adc-%d", reading_num);
if (entry == NULL)
{
GOS_LOG("WARN: 'adc-readings' entry not found");
}
{
GOS_LOG("WARN: 'adc-readings' entry is NOT a dict object");
}
else
{
char format_str[8];
GOS_LOG("%s : %u (%s)", key_str, MSGPACK_UINT(value_entry), MSGPACK_STR(format_entry, format_str, sizeof(format_str)));
}
}
}
}
MSGPACK_FREE_OBJECTS(root_ptr);
return GOS_SUCCESS;
}