esp_timer.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "esp_err.h"

Go to the source code of this file.

Data Structures
struct	esp_timer_create_args_t

Typedefs
typedef struct esp_timer *	esp_timer_handle_t
typedef void(*	esp_timer_cb_t) (void *arg)

Enumerations
enum	esp_timer_dispatch_t {   ESP_TIMER_TASK = 0 ,   ESP_TIMER_ISR = 1 }

Functions
esp_err_t	esp_timer_init (void)
esp_err_t	esp_timer_deinit (void)
int64_t	esp_timer_get_time (void)
int64_t	esp_timer_get_next_alarm (void)
esp_err_t	esp_timer_create (const esp_timer_create_args_t *create_args, esp_timer_handle_t *out_handle)
esp_err_t	esp_timer_start_once (esp_timer_handle_t timer, uint64_t timeout_us)
esp_err_t	esp_timer_start_periodic (esp_timer_handle_t timer, uint64_t period_us)
esp_err_t	esp_timer_stop (esp_timer_handle_t timer)
esp_err_t	esp_timer_delete (esp_timer_handle_t timer)
bool	esp_timer_is_active (esp_timer_handle_t timer)

Typedef Documentation

esp_timer_handle_t

typedef struct esp_timer* esp_timer_handle_t

esp_timer_cb_t

typedef void(* esp_timer_cb_t) (void *arg)

Enumeration Type Documentation

esp_timer_dispatch_t

enum esp_timer_dispatch_t

Enumerator
ESP_TIMER_TASK	Callback runs on the dedicated timer task.
ESP_TIMER_ISR

Function Documentation

esp_timer_init()

esp_err_t esp_timer_init

(

void

)

esp_timer_deinit()

esp_err_t esp_timer_deinit

(

void

)

esp_timer_get_time()

int64_t esp_timer_get_time

(

void

)

esp_timer_get_next_alarm()

int64_t esp_timer_get_next_alarm

(

void

)

esp_timer_create()

esp_err_t esp_timer_create	(	const esp_timer_create_args_t *	create_args,
		esp_timer_handle_t *	out_handle
	)

esp_timer_start_once()

esp_err_t esp_timer_start_once	(	esp_timer_handle_t	timer,
		uint64_t	timeout_us
	)

esp_timer_start_periodic()

esp_err_t esp_timer_start_periodic	(	esp_timer_handle_t	timer,
		uint64_t	period_us
	)

esp_timer_stop()

esp_err_t esp_timer_stop

(

esp_timer_handle_t

timer

)

esp_timer_delete()

esp_err_t esp_timer_delete

(

esp_timer_handle_t

timer

)

esp_timer_is_active()

bool esp_timer_is_active

(

esp_timer_handle_t

timer

)