Sternum Embedded SDK
sternum_settings.h
Go to the documentation of this file.
1 
7 #ifndef __STERNUM_SETTINGS_H__
8 #define __STERNUM_SETTINGS_H__
9 
10 #ifdef __cplusplus
11 extern "C" {
12 #endif
13 
14 #include <stdbool.h>
15 #include <stddef.h>
16 #include <stdint.h>
17 
19 
26 typedef struct sternum_sdk_settings_t {
42 
46  const char* firmware_version;
47 
57 
68  unsigned char* trace_buffer;
69 
74 
88  unsigned char* communication_buffer;
89 
94 
98  uint64_t access_token;
99 
103  uint64_t device_id;
104 
106 
120 
121 #ifdef __cplusplus
122 }
123 #endif
124 
125 #endif /* __STERNUM_SETTINGS_H__ */
Sternum SDK error codes.
void init_sternum_sdk_settings(sternum_sdk_settings_t *settings)
Default-initialize settings structure for the SDK.
struct sternum_sdk_settings_t sternum_sdk_settings_t
Configuration structure for initializing the SDK.
Definition: sternum_settings.h:26
size_t trace_buffer_size
Size of trace_buffer in bytes.
Definition: sternum_settings.h:73
const char * firmware_version
String identifying client's application firmware version.
Definition: sternum_settings.h:46
uint64_t access_token
Access token is device type ID.
Definition: sternum_settings.h:98
size_t communication_buffer_size
Size of communication_buffer in bytes.
Definition: sternum_settings.h:93
unsigned char * communication_buffer
Pointer to communication_buffer - array serving as RAM cache for all pending traces.
Definition: sternum_settings.h:88
unsigned char * trace_buffer
Pointer to trace_buffer - array serving as buffer for constructing single trace.
Definition: sternum_settings.h:68
bool flush_automatically
Option for transmitting traces immediately if possible.
Definition: sternum_settings.h:56
uint32_t inter_transmission_delay_ms
Time to wait between each transmission [ms].
Definition: sternum_settings.h:41
uint64_t device_id
Device ID unique for each device (eg.
Definition: sternum_settings.h:103