meshx_rtos_timer.h File Reference

Header file for MeshX RTOS Timer interface. Provides APIs for creating, starting, stopping, deleting, and managing RTOS timers in the MeshX framework. More...

#include <stdint.h>
#include <stdbool.h>
#include "meshx_err.h"

Include dependency graph for meshx_rtos_timer.h:

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

Go to the source code of this file.

Data Structures
struct	meshx_rtos_timer

Typedefs
typedef void(*	meshx_rtos_timer_callback_t) (void *)
typedef struct meshx_rtos_timer	meshx_rtos_timer_t

Functions
meshx_err_t	meshx_rtos_timer_create (meshx_rtos_timer_t *timer, const char *name, meshx_rtos_timer_callback_t cb, void *arg, uint32_t period_ms, bool reload)
	Creates a new RTOS timer.
meshx_err_t	meshx_rtos_timer_start (meshx_rtos_timer_t *timer)
	Starts the RTOS timer.
meshx_err_t	meshx_rtos_timer_stop (meshx_rtos_timer_t *timer)
	Stops the RTOS timer.
meshx_err_t	meshx_rtos_timer_delete (meshx_rtos_timer_t *timer)
	Deletes the RTOS timer.
meshx_err_t	meshx_rtos_timer_change_period (meshx_rtos_timer_t *timer, uint32_t new_period_ms)
	Changes the period of the RTOS timer.
meshx_err_t	meshx_rtos_timer_reset (meshx_rtos_timer_t *timer)
	Resets the RTOS timer.
void	meshx_os_timer_fire_cb (const void *timer_handle)

Detailed Description

Header file for MeshX RTOS Timer interface. Provides APIs for creating, starting, stopping, deleting, and managing RTOS timers in the MeshX framework.

Copyright (c) 2024 - 2025 MeshX

This module abstracts the RTOS timer functionalities and provides a unified interface for timer management, including support for auto-reload timers, callback functions, and dynamic period changes.

Author

Pranjal Chanda

Definition in file meshx_rtos_timer.h.

Typedef Documentation

meshx_rtos_timer_callback_t

typedef void(* meshx_rtos_timer_callback_t) (void *)

Definition at line 24 of file meshx_rtos_timer.h.

meshx_rtos_timer_t

typedef struct meshx_rtos_timer meshx_rtos_timer_t

Function Documentation

meshx_os_timer_fire_cb()

void meshx_os_timer_fire_cb

(

const void *

timer_handle

)

Definition at line 148 of file meshx_os_timer.c.

{
    meshx_os_timer_t *msg_params;
    SLIST_FOREACH(msg_params, &meshx_os_timer_reg_table_head, next)
    {
        if (msg_params->timer_handle.__timer_handle == timer_handle)
        {
            control_task_msg_publish(
                CONTROL_TASK_MSG_CODE_SYSTEM,
                CONTROL_TASK_MSG_EVT_SYSTEM_TIMER_FIRE,
                msg_params,
                OS_TIMER_SIZE);
            break;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_rtos_timer_change_period()

meshx_err_t meshx_rtos_timer_change_period	(	meshx_rtos_timer_t *	timer,
		uint32_t	new_period_ms )

Changes the period of the RTOS timer.

This function changes the period of an active or dormant RTOS timer.

Parameters

[in]	timer	Pointer to the meshx_rtos_timer_t structure.
[in]	new_period_ms	New timer period in milliseconds.

Returns

meshx_err_t Returns MESHX_SUCCESS if the timer period was changed successfully, or an error code if the change operation failed.

Definition at line 154 of file meshx_timer.c.

{
    if (timer == NULL || timer->__timer_handle == NULL) {
        return MESHX_INVALID_ARG;
    }
 
    if (xTimerChangePeriod(timer->__timer_handle, pdMS_TO_TICKS(new_period_ms), 0) != pdPASS) {
        return MESHX_FAIL;
    }
 
    timer->timer_period = new_period_ms;
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_rtos_timer_create()

meshx_err_t meshx_rtos_timer_create	(	meshx_rtos_timer_t *	timer,
		const char *	name,
		meshx_rtos_timer_callback_t	cb,
		void *	arg,
		uint32_t	period_ms,
		bool	reload )

Creates a new RTOS timer.

This function initializes and creates a new RTOS timer with the specified parameters.

Parameters

[out]	timer	Pointer to the meshx_rtos_timer_t structure to be initialized.
[in]	name	Timer Name String
[in]	cb	Callback function to be invoked when the timer expires.
[in]	arg	Argument to be passed to the callback function.
[in]	period_ms	Timer period in milliseconds.
[in]	reload	Flag set if timer is a auto reload type.

Returns

meshx_err_t Returns MESHX_SUCCESS if the timer was created successfully, or an error code if the creation failed.

Definition at line 46 of file meshx_timer.c.

{
    if (timer == NULL || cb == NULL) {
        return MESHX_INVALID_ARG;
    }
 
    timer->timer_name = name;
    timer->timer_cb = cb;
    timer->timer_arg = arg;
    timer->timer_period = pdMS_TO_TICKS(period_ms);
    timer->auto_reload = reload;
 
    timer->__timer_handle = xTimerCreate(
        timer->timer_name,
        timer->timer_period,
        timer->auto_reload,
        NULL,
        timer_callback
    );
 
    if (timer->__timer_handle == NULL) {
        return MESHX_NO_MEM;
    }
 
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_rtos_timer_delete()

meshx_err_t meshx_rtos_timer_delete

(

meshx_rtos_timer_t *

timer

)

Deletes the RTOS timer.

This function deletes the RTOS timer and frees associated resources.

Parameters

[in]

timer

Pointer to the meshx_rtos_timer_t structure.

Returns

meshx_err_t Returns MESHX_SUCCESS if the timer was deleted successfully, or an error code if the delete operation failed.

Definition at line 129 of file meshx_timer.c.

{
    if (timer == NULL || timer->__timer_handle == NULL) {
        return MESHX_INVALID_ARG;
    }
 
    if (xTimerDelete(timer->__timer_handle, 0) != pdPASS) {
        return MESHX_FAIL;
    }
 
    timer->__timer_handle = NULL;
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_rtos_timer_reset()

meshx_err_t meshx_rtos_timer_reset

(

meshx_rtos_timer_t *

timer

)

Resets the RTOS timer.

This function resets the RTOS timer, causing it to restart from its beginning.

Parameters

[in]

timer

Pointer to the meshx_rtos_timer_t structure.

Returns

meshx_err_t Returns MESHX_SUCCESS if the timer was reset successfully, or an error code if the reset operation failed.

Definition at line 178 of file meshx_timer.c.

{
    if (timer == NULL || timer->__timer_handle == NULL) {
        return MESHX_INVALID_ARG;
    }
 
    if (xTimerReset(timer->__timer_handle, 0) != pdPASS) {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_rtos_timer_start()

meshx_err_t meshx_rtos_timer_start

(

meshx_rtos_timer_t *

timer

)

Starts the RTOS timer.

This function starts the RTOS timer.

Parameters

[in]

timer

Pointer to the meshx_rtos_timer_t structure.

Returns

meshx_err_t Returns MESHX_SUCCESS if the timer was started successfully, or an error code if the start operation failed.

Definition at line 83 of file meshx_timer.c.

{
    if (timer == NULL || timer->__timer_handle == NULL) {
        return MESHX_INVALID_ARG;
    }
 
    if (xTimerStart(timer->__timer_handle, 0) != pdPASS) {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_rtos_timer_stop()

meshx_err_t meshx_rtos_timer_stop

(

meshx_rtos_timer_t *

timer

)

Stops the RTOS timer.

This function stops the RTOS timer.

Parameters

[in]

timer

Pointer to the meshx_rtos_timer_t structure.

Returns

meshx_err_t Returns MESHX_SUCCESS if the timer was stopped successfully, or an error code if the stop operation failed.

Definition at line 106 of file meshx_timer.c.

{
    if (timer == NULL || timer->__timer_handle == NULL) {
        return MESHX_INVALID_ARG;
    }
 
    if (xTimerStop(timer->__timer_handle, 0) != pdPASS) {
        return MESHX_FAIL;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function: