timer.h File Reference

defininitions for wrapper component which assists in setting up timers More...

#include <stdbool.h>
#include "esp_timer.h"

Include dependency graph for timer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	general_timer_init (esp_timer_handle_t timer, void(timer_callback)(void *arg), bool periodic, int period_in_seconds, char *timer_name)
void	general_timer_deinit (esp_timer_handle_t timer)

Detailed Description

defininitions for wrapper component which assists in setting up timers

Definition in file timer.h.

Function Documentation

general_timer_deinit()

void general_timer_deinit

(

esp_timer_handle_t

timer

)

deinit a timer

Parameters

timer

a locally defined timer passed through to this function

Definition at line 71 of file timer.c.

Here is the caller graph for this function:

general_timer_init()

void general_timer_init	(	esp_timer_handle_t	timer,
		void(timer_callback)(void *arg)	,
		bool	periodic,
		int	period_in_millis,
		char *	timer_name
	)

set up a periodic or oneshot timer

Parameters

timer	a locally defined timer passed through to this function
timer_callback	a callback function with the params (void *arg) which is called when the alarm triggers
periodic	a boolean checking whether the timer should be set up to be reset when it is triggered
period_in_millis	the period between start and trigger
timer_name	a name for the timer for the sake of debugging

Definition at line 51 of file timer.c.

Here is the caller graph for this function: