Jump to main content

##

# 2.123.9 TMRx_FrequencyGet Function

## C

    /* x = TMR instance number */
    uint32_t TMRx_FrequencyGet(void);

## Summary

Provides the given timer's counter-increment frequency.

## Description

This function provides the frequency at which the given counter increments. It can be used to convert differences between counter values to real time or real-time intervals to timer period values.

## Precondition

TMRx_Initialize() function must have been called first.

## Parameters

None.

## Returns

frequency - The frequency (in Hz) at which the timer's counter increments.

## Example

    uint32_t frequency;

    TMR2_Initialize();
    frequency = TMR2_FrequencyGet();

## Remarks

None.