Introduction

Here is the list of APIs used for Digital Control Library

Data Structures
struct	DATALOG_Obj
	Defines the data logging (DATALOG) object. More...

Functions
DATALOG_Handle	DATALOG_init (void *pMemory, const size_t numBytes, Trigger_type trigger, float32_t trig_value, int32_t scale)
	Initializes the data logger. More...

static void	DATALOG_update (DATALOG_Handle handle)
	Updates the data logger. More...

Typedefs
typedef struct _DATALOG_Obj_ *	DATALOG_Handle
	Defines the DATALOG handle. More...

Enumerations
enum	Trigger_type { manual, auto_trigger }

Macros
#define	DATALOG_DEFAULTS
	Defines the default initialization for the DLOG object. More...

Macro Definition Documentation

◆ DATALOG_DEFAULTS

#define DATALOG_DEFAULTS

Value:

                            {                          \
                            {NULL,                 \
                             NULL,                 \
                             NULL,                 \
                             NULL},               \
                            true,                  \
                            false,                 \
                            0,                     \
                            DATA_LOG_BUFF_SIZE     \
                         }

Defines the default initialization for the DLOG object.

Typedef Documentation

◆ DATALOG_Handle

typedef struct _DATALOG_Obj_* DATALOG_Handle

Defines the DATALOG handle.

Enumeration Type Documentation

◆ Trigger_type

enum Trigger_type

Enumerator
manual
auto_trigger

Function Documentation

◆ DATALOG_init()

DATALOG_Handle DATALOG_init	(	void *	pMemory,
		const size_t	numBytes,
		Trigger_type	trigger,
		float32_t	trig_value,
		int32_t	scale
	)

Initializes the data logger.

Parameters

[in]	pMemory	The pointer to memory
[in]	numBytes	size of datalog_obj
[in]	trigger	manual or auto_triiger
[in]	trig_value	Trigger value used for Auto triger type to initiate datalog
[in]	scale	How many datalog update to be skipped

◆ DATALOG_update()

static void DATALOG_update ( DATALOG_Handle handle )

inlinestatic

Updates the data logger.

Parameters

[in] handle Datalog handle need to be provided

Variable Documentation

◆ datalog

DATALOG_Obj datalog

extern

Defines the DATALOG object.

◆ datalogHandle

DATALOG_Handle datalogHandle