cpp/latest/timer_8h_source.html

 #pragma once


 #include <stdint.h>


 #include "metawearboard_fwd.h"

 #include "timer_fwd.h"


 #include "metawear/platform/dllmarker.h"


 #ifdef  __cplusplus

 extern "C" {

 #endif


 METAWEAR_API void mbl_mw_timer_create(MblMwMetaWearBoard *board, uint32_t period, uint16_t repetitions, uint8_t delay, void *context, MblMwFnTimerPtr received_timer);

 METAWEAR_API void mbl_mw_timer_create_indefinite(MblMwMetaWearBoard *board, uint32_t period, uint8_t delay, void *context, MblMwFnTimerPtr received_timer);

 METAWEAR_API uint8_t mbl_mw_timer_get_id(const MblMwTimer* timer);

 METAWEAR_API MblMwTimer* mbl_mw_timer_lookup_id(const MblMwMetaWearBoard* board, uint8_t id);

 METAWEAR_API void mbl_mw_timer_start(const MblMwTimer* timer);

 METAWEAR_API void mbl_mw_timer_stop(const MblMwTimer* timer);

 METAWEAR_API void mbl_mw_timer_remove(MblMwTimer* timer);


 #ifdef  __cplusplus

 }

 #endif

dllmarker.h
Macros for identifying exported functions.

METAWEAR_API
#define METAWEAR_API
Indicates the function should be exported to the symbol table
Definition: dllmarker.h:27

metawearboard_fwd.h
Forward declarations for the MblMwMetaWearBoard type.

MblMwMetaWearBoard
struct MblMwMetaWearBoard MblMwMetaWearBoard
Software representation of a physical MetaWear board.
Definition: metawearboard_fwd.h:17

mbl_mw_timer_create_indefinite
METAWEAR_API void mbl_mw_timer_create_indefinite(MblMwMetaWearBoard *board, uint32_t period, uint8_t delay, void *context, MblMwFnTimerPtr received_timer)
Creates a timer that will run indefinitely.

mbl_mw_timer_get_id
METAWEAR_API uint8_t mbl_mw_timer_get_id(const MblMwTimer *timer)
Retrieves the id value identifying the timer.

mbl_mw_timer_stop
METAWEAR_API void mbl_mw_timer_stop(const MblMwTimer *timer)
Stops a timer.

mbl_mw_timer_lookup_id
METAWEAR_API MblMwTimer * mbl_mw_timer_lookup_id(const MblMwMetaWearBoard *board, uint8_t id)
Looks up the MblMwTimer object corresponding to the id.

mbl_mw_timer_start
METAWEAR_API void mbl_mw_timer_start(const MblMwTimer *timer)
Starts a timer.

mbl_mw_timer_remove
METAWEAR_API void mbl_mw_timer_remove(MblMwTimer *timer)
Removes the timer from the board.

mbl_mw_timer_create
METAWEAR_API void mbl_mw_timer_create(MblMwMetaWearBoard *board, uint32_t period, uint16_t repetitions, uint8_t delay, void *context, MblMwFnTimerPtr received_timer)
Creates a timer that will run for a set number of repetitions.

timer_fwd.h
Forward declaration of the MblMwTimer type.

MblMwFnTimerPtr
void(* MblMwFnTimerPtr)(void *context, MblMwTimer *timer)
Definition for callback functions that accept an MblMwTimer pointer.
Definition: timer_fwd.h:23

MblMwTimer
struct MblMwTimer MblMwTimer
On board timer that periodically fires events.
Definition: timer_fwd.h:15