Astarte device API for Zephyr 0.8.0
Astarte device SDK for Zephyr RTOS
Loading...
Searching...
No Matches
data.h
Go to the documentation of this file.
1/*
2 * (C) Copyright 2024, SECO Mind Srl
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ASTARTE_DEVICE_SDK_DATA_H
8#define ASTARTE_DEVICE_SDK_DATA_H
9
26
28ASTARTE_UTIL_DEFINE_ARRAY(astarte_data_binaryblob_t, void);
29
31typedef struct
32{
34 const void **blobs;
36 size_t *sizes;
38 size_t count;
39} astarte_data_binaryblobarray_t;
40
42ASTARTE_UTIL_DEFINE_ARRAY(astarte_data_booleanarray_t, bool);
44ASTARTE_UTIL_DEFINE_ARRAY(astarte_data_doublearray_t, double);
46ASTARTE_UTIL_DEFINE_ARRAY(astarte_data_integerarray_t, int32_t);
48ASTARTE_UTIL_DEFINE_ARRAY(astarte_data_longintegerarray_t, int64_t);
50ASTARTE_UTIL_DEFINE_ARRAY(astarte_data_stringarray_t, const char *);
51
53typedef union
54{
56 astarte_data_binaryblob_t binaryblob;
58 bool boolean;
60 int64_t datetime;
62 double dbl;
64 int32_t integer;
66 int64_t longinteger;
68 const char *string;
69
71 astarte_data_binaryblobarray_t binaryblob_array;
73 astarte_data_booleanarray_t boolean_array;
75 astarte_data_longintegerarray_t datetime_array;
77 astarte_data_doublearray_t double_array;
79 astarte_data_integerarray_t integer_array;
81 astarte_data_longintegerarray_t longinteger_array;
83 astarte_data_stringarray_t string_array;
84} astarte_data_param_t;
85
126typedef struct
127{
129 astarte_data_param_t data;
133
134#ifdef __cplusplus
135extern "C" {
136#endif
137
145astarte_data_t astarte_data_from_binaryblob(void *binaryblob, size_t len);
188
199astarte_data_t astarte_data_from_binaryblob_array(const void **blobs, size_t *sizes, size_t count);
207astarte_data_t astarte_data_from_boolean_array(bool *boolean_array, size_t len);
215astarte_data_t astarte_data_from_datetime_array(int64_t *datetime_array, size_t len);
223astarte_data_t astarte_data_from_double_array(double *double_array, size_t len);
231astarte_data_t astarte_data_from_integer_array(int32_t *integer_array, size_t len);
239astarte_data_t astarte_data_from_longinteger_array(int64_t *longinteger_array, size_t len);
247astarte_data_t astarte_data_from_string_array(const char **string_array, size_t len);
248
256
265astarte_result_t astarte_data_to_binaryblob(astarte_data_t data, void **binaryblob, size_t *len);
314
325 astarte_data_t data, const void ***blobs, size_t **sizes, size_t *count);
335 astarte_data_t data, bool **boolean_array, size_t *len);
345 astarte_data_t data, int64_t **datetime_array, size_t *len);
355 astarte_data_t data, double **double_array, size_t *len);
365 astarte_data_t data, int32_t **integer_array, size_t *len);
375 astarte_data_t data, int64_t **longinteger_array, size_t *len);
385 astarte_data_t data, const char ***string_array, size_t *len);
386
387#ifdef __cplusplus
388}
389#endif
390
395#endif /* ASTARTE_DEVICE_SDK_DATA_H */
Global Astarte includes and defines.
astarte_data_t astarte_data_from_string(const char *string)
Initialize an astarte data from the input string.
astarte_result_t astarte_data_to_double(astarte_data_t data, double *dbl)
Convert Astarte data (of double type) to a double.
astarte_result_t astarte_data_to_longinteger(astarte_data_t data, int64_t *longinteger)
Convert Astarte data (of the long integer type) to an int64_t.
astarte_result_t astarte_data_to_string(astarte_data_t data, const char **string)
Convert Astarte data (of the string type) to a const char *.
astarte_result_t astarte_data_to_boolean(astarte_data_t data, bool *boolean)
Convert Astarte data (of the boolean type) to a bool.
astarte_data_t astarte_data_from_binaryblob_array(const void **blobs, size_t *sizes, size_t count)
Initialize an astarte data from the input binaryblob array.
astarte_result_t astarte_data_to_binaryblob_array(astarte_data_t data, const void ***blobs, size_t **sizes, size_t *count)
Convert Astarte data (of binaryblob array type) to an array of binaryblob arrays.
astarte_data_t astarte_data_from_longinteger(int64_t longinteger)
Initialize an astarte data from the input longinteger.
astarte_data_t astarte_data_from_longinteger_array(int64_t *longinteger_array, size_t len)
Initialize an astarte data from the input longinteger array.
astarte_data_t astarte_data_from_integer(int32_t integer)
Initialize an astarte data from the input integer.
astarte_result_t astarte_data_to_integer(astarte_data_t data, int32_t *integer)
Convert Astarte data (of the integer type) to an int32_t.
astarte_data_t astarte_data_from_datetime(int64_t datetime)
Initialize an astarte data from the input datetime.
astarte_result_t astarte_data_to_datetime(astarte_data_t data, int64_t *datetime)
Convert Astarte data (of the datetime type) to an int64_t.
astarte_data_t astarte_data_from_datetime_array(int64_t *datetime_array, size_t len)
Initialize an astarte data from the input datetime array.
astarte_data_t astarte_data_from_boolean(bool boolean)
Initialize an astarte data from the input boolean.
astarte_result_t astarte_data_to_longinteger_array(astarte_data_t data, int64_t **longinteger_array, size_t *len)
Convert Astarte data (of longinteger array type) to an int64_t array.
astarte_result_t astarte_data_to_datetime_array(astarte_data_t data, int64_t **datetime_array, size_t *len)
Convert Astarte data (of datetime array type) to an int64_t array.
astarte_data_t astarte_data_from_string_array(const char **string_array, size_t len)
Initialize an astarte data from the input string array.
astarte_data_t astarte_data_from_double(double dbl)
Initialize an astarte data from the input double.
astarte_mapping_type_t astarte_data_get_type(astarte_data_t data)
Get the type of Astarte data.
astarte_result_t astarte_data_to_integer_array(astarte_data_t data, int32_t **integer_array, size_t *len)
Convert Astarte data (of integer array type) to an int32_t array.
astarte_result_t astarte_data_to_string_array(astarte_data_t data, const char ***string_array, size_t *len)
Convert Astarte data (of string type) to a const char* array.
astarte_result_t astarte_data_to_binaryblob(astarte_data_t data, void **binaryblob, size_t *len)
Convert Astarte data (of the binary blob type) to an array of binary blobs.
astarte_data_t astarte_data_from_integer_array(int32_t *integer_array, size_t len)
Initialize an astarte data from the input integer array.
astarte_result_t astarte_data_to_boolean_array(astarte_data_t data, bool **boolean_array, size_t *len)
Convert Astarte data (of boolean array type) to a bool array.
astarte_data_t astarte_data_from_double_array(double *double_array, size_t len)
Initialize an astarte data from the input double array.
astarte_data_t astarte_data_from_binaryblob(void *binaryblob, size_t len)
Initialize an astarte data from the input binaryblob.
astarte_result_t astarte_data_to_double_array(astarte_data_t data, double **double_array, size_t *len)
Convert Astarte data (of double array type) to a double array.
astarte_data_t astarte_data_from_boolean_array(bool *boolean_array, size_t len)
Initialize an astarte data from the input boolean array.
astarte_mapping_type_t
Allowed types in a mapping on an Astarte interface.
Definition mapping.h:34
astarte_result_t
Astarte Device SDK return codes.
Definition result.h:31
#define ASTARTE_UTIL_DEFINE_ARRAY(NAME, TYPE)
Define a struct that contains a pointer of type TYPE and a length.
Definition util.h:28
Astarte interface mapping representation.
Astarte result types.
Base Astarte data type.
Definition data.h:127
astarte_mapping_type_t tag
Tag of the tagged enum.
Definition data.h:131
astarte_data_param_t data
Data portion of the tagged enum.
Definition data.h:129
Utility macros and functions.