ruuvi_interface_timer.h

Go to the documentation of this file.

#ifndef RUUVI_INTERFACE_TIMER_H
#define RUUVI_INTERFACE_TIMER_H
#include "ruuvi_driver_enabled_modules.h"
#include "ruuvi_driver_error.h"
#include "ruuvi_driver_enabled_modules.h"
#include <stdbool.h>
 
#if RI_TIMER_ENABLED
#define RUUVI_NRF5_SDK15_TIMER_ENABLED RUUVI_NRF5_SDK15_ENABLED
#endif
 
typedef enum
{
    RI_TIMER_MODE_SINGLE_SHOT,
    RI_TIMER_MODE_REPEATED
} ri_timer_mode_t;
 
typedef void * ri_timer_id_t; 
 
typedef void (*ruuvi_timer_timeout_handler_t) (void * const p_context);
 
/* @brief Calls initialization as required by application timers.
 *
 * After initialization, timers can be created, started and stopped.
 *
 * @retval RD_SUCCESS on success.
 * @retval RD_ERROR_INVALID_STATE if timers are already initialized.
 */
rd_status_t ri_timer_init (void);
 
/* @brief Calls uninitialization as required by application timers
 *
 * Deletes state of timers and stops hardware timers if possible.
 *
 **/
rd_status_t ri_timer_uninit (void);
 
bool ri_timer_is_init (void);
 
/* @brief Function for creating a timer instance.
 *
 * Timers may be statically or dynamically allocated, if statically allocated this will
 * only return a handle to instance. If dynamically, this will allocate memory for new
 * instance.
 *
 * @param[out] p_timer_id pointer to timer id, outputs ID which can be used to control the timer
 * @param[in] mode mode of the timer, single shot or repeated
 * @param[in] timeout_handler function which gets called
 * @return RD_SUCCESS if timer was created
 * @return RD_ERROR_RESOURCES if no more timers can be allocated
 * @return RD_ERROR_INVALID_STATE if timers have not been initialized
 * @return error code from stack on other error
 */
rd_status_t ri_timer_create (ri_timer_id_t * p_timer_id,
                             ri_timer_mode_t mode,
                             ruuvi_timer_timeout_handler_t timeout_handler);
 
rd_status_t ri_timer_start (ri_timer_id_t timer_id,
                            uint32_t ms,
                            void * const context);
 
rd_status_t ri_timer_stop (ri_timer_id_t timer_id);
#endif