1.23.26.4 TMR1_FrequencyGet Function

C

uint32_t TMR1_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

TMR1_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;

TMR1_Initialize();
frequency = TMR1_FrequencyGet();

Remarks

None.