Download FreeRTOS
 

Quality RTOS & Embedded Software

KERNEL
WHAT'S NEW
FreeRTOS website now available in Simplified Chinese
Search and browse content in your preferred language. See the blog post.
New FreeRTOS Long Term Support version now available.
Receive security patches and critical bug fixes on FreeRTOS libraries for two years. See the blog post.
FreeRTOS Extended Maintenance Program (EMP) registration now open.
Providing security patches and critical bug fixes on FreeRTOS Long Term Support (LTS) versions for up to 10 additional years. See the blog post.
FreeRTOS-Plus-TCP v3.0.0 released:
We've added comprehensive unit tests and penetration and protocol testing. See the blog post.
Featured FreeRTOS IoT Integrations:
Introducing three featured integrations for more secure IoT applications. See the blog post.

xTimerGetPeriod
[Timer API]

timers.h 
 TickType_t xTimerGetPeriod( TimerHandle_t xTimer );

Returns the period of a software timer. The period is specified in ticks.

The period of a timer is initially set using the xTimerPeriod parameter of the call to xTimerCreate() used to create the timer. It can then be changed using the xTimerChangePeriod() and xTimerChangePeriodFromISR() API functions.

Parameters:
xTimer   The timer being queried.
Returns:
The period of the timer, in ticks.
Example usage: 

/* A callback function assigned to a software timer. */
static void prvExampleTimerCallback( TimerHandle_t xTimer )
{
TickType_t xTimerPeriod;

    /* Query the period of the timer that expires. */
    xTimerPeriod = xTimerGetPeriod( xTimer );
}





Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.