- -

Provides initialization and service functions. -More...

- - - - - - - - -

-Topics
	Initialization and Service Types
	Referred types used by basic functions.

	Tracing/Debugging
	Tracing/Debugging Interface.

- - - - -

-Data Structures
struct	Ucs_InitData_t
	UNICENS initialization structure used by function Ucs_Init(). More...

- - - - - - - -

-Macros
#define	UCS_NUM_INSTANCES 1
	Number of API instances which can be created by function Ucs_CreateInstance().

#define	UCS_FOOTPRINT_TINY
	Define this macro to reduce the RAM and ROM size of the UNICENS software by disabling certain features.

- - - - - - - - - - - - - -

-Callback Functions
typedef void(*	Ucs_RequestServiceCb_t )(void *user_ptr)
	Function signature used for service request callback.

typedef void(*	Ucs_ErrorCb_t )(Ucs_Error_t error_code, void *user_ptr)
	Function signature used for the general error callback function.

typedef uint16_t(*	Ucs_GetTickCountCb_t )(void *user_ptr)
	Function signature used for callback function to get system tick count.

typedef void(*	Ucs_SetAppTimerCb_t )(uint16_t timeout, void *user_ptr)
	Function signature used for timer callback function.

- - - - - - - - - - - - - - - - - - - -

-Functions
Ucs_Inst_t *	Ucs_CreateInstance (void)
	Retrieves a UNICENS API instance.

Ucs_Return_t	Ucs_SetDefaultConfig (Ucs_InitData_t *init_ptr)
	Assigns default values to a provided UNICENS init structure.

Ucs_Return_t	Ucs_Init (Ucs_Inst_t self, const Ucs_InitData_t init_ptr, Ucs_InitResultCb_t init_result_fptr)
	UNICENS initialization function.

Ucs_Return_t	Ucs_Stop (Ucs_Inst_t *self, Ucs_StdResultCb_t stopped_fptr)
	Terminates the execution of UNICENS.

void	Ucs_Service (Ucs_Inst_t *self)
	The application must call this function cyclically to drive UNICENS.

void	Ucs_ReportTimeout (Ucs_Inst_t *self)
	The application must call this function if the application timer expires.

-

Detailed Description

-

Provides initialization and service functions.

-

-Topics