Timer

-For monoZ timer operations refer MZ_timer.h file. More...

Functions
size_t	mz_tm_create (char *_name, TickType_t _tick, UBaseType_t _auto, mz_tm_cb _cb)
	Function to Create a Monoz Timer. More...
size_t	mz_tm_create_one (char *_name, TickType_t _tick, mz_tm_cb _cb)
	Function to Create a One Shot Timer. More...
size_t	mz_tm_create_recursive (char *_name, TickType_t _tick, mz_tm_cb _cb)
	Function to Create a Recursive Timer. More...
mz_error_t	mz_tm_start (size_t _id)
	Function to Start the Timer. More...
mz_error_t	mz_tm_create_start (char *_name, TickType_t _tick, UBaseType_t _auto, mz_tm_cb _cb)
	Function to Create and Start Timers. More...
mz_error_t	mz_tm_create_start_one (char *_name, TickType_t _tick, mz_tm_cb _cb)
	Function to Create and Start Recursive timers. More...
mz_error_t	mz_tm_create_start_recursive (char *_name, TickType_t _tick, mz_tm_cb _cb)
	Function to Create and Start One Shot Timers. More...
mz_error_t	mz_tm_stop (size_t _id)
	Function to STOP the Timer. More...
mz_error_t	mz_tm_delete (size_t _id)
	Function to Delete the Timer. More...

Detailed Description

-For monoZ timer operations refer MZ_timer.h file.

Function Documentation

mz_tm_create()

size_t mz_tm_create	(	char *	_name,
		TickType_t	_tick,
		UBaseType_t	_auto,
		mz_tm_cb	_cb
	)

Function to Create a Monoz Timer.

Parameters

_name	char
_tick	TickType_t
_auto	UBaseType_t
_cb	mz_tm_cb

Returns

function returns _id

mz_tm_create_one()

size_t mz_tm_create_one	(	char *	_name,
		TickType_t	_tick,
		mz_tm_cb	_cb
	)

Function to Create a One Shot Timer.

Parameters

_name	char
_tick	TickType_t
_cb	mz_tm_cb

Returns

function returns mz_tm_create(_name, _tick, pdFALSE, _cb)

mz_tm_create_recursive()

size_t mz_tm_create_recursive	(	char *	_name,
		TickType_t	_tick,
		mz_tm_cb	_cb
	)

Function to Create a Recursive Timer.

Parameters

_name	char
_tick	TickType_t
_cb	mz_tm_cb

Returns

function returns mz_tm_create(_name, _tick, pdTRUE, _cb)

mz_tm_start()

mz_error_t mz_tm_start

(

size_t

_id

)

Function to Start the Timer.

Parameters

_id

size_t

Returns

function returns _ret

mz_tm_create_start()

mz_error_t mz_tm_create_start	(	char *	_name,
		TickType_t	_tick,
		UBaseType_t	_auto,
		mz_tm_cb	_cb
	)

Function to Create and Start Timers.

Parameters

_name	char
_tick	TickType_t
_auto	UBaseType_t
_cb	mz_tm_cb

Returns

function returns MZ_FAIL

mz_tm_create_start_one()

mz_error_t mz_tm_create_start_one	(	char *	_name,
		TickType_t	_tick,
		mz_tm_cb	_cb
	)

Function to Create and Start Recursive timers.

Parameters

_name	char
_tick	TickType_t
_cb	mz_tm_cb

Returns

function returns mz_tm_create_start(_name, _tick, pdFALSE, _cb) value

mz_tm_create_start_recursive()

mz_error_t mz_tm_create_start_recursive	(	char *	_name,
		TickType_t	_tick,
		mz_tm_cb	_cb
	)

Function to Create and Start One Shot Timers.

Parameters

_name	char
_tick	TickType_t
_cb	mz_tm_cb

Returns

function returns the value mz_tm_create_start(_name, _tick, pdTRUE, _cb)

mz_tm_stop()

mz_error_t mz_tm_stop

(

size_t

_id

)

Function to STOP the Timer.

Parameters

_id

Size_t

Returns

function returns the result of pdPASS != xTimerStop(_tmr[_id].timer,0) ? MZ_FAIL : MZ_OK

mz_tm_delete()

mz_error_t mz_tm_delete

(

size_t

_id

)

Function to Delete the Timer.

Parameters

_id

Size_t

Returns

function returns the result of pdPASS != xTimerDelete(_tmr[_id].timer,0) ? MZ_FAIL : MZ_OK