3.24.2.1 TMR1

This file contains API prototypes and other data types for the TMR1 driver.

This file contains the deprecated macros or APIs for the TMR1 driver.

This use case configures the TMR1 PLIB to generate the timer period. The period of a timer is changed at run time during each overflow event. The callback function is used to change the timer period.

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

#include "mcc_generated_files/system/system.h"
/*
 * Development Board: PIC18F57Q43 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     TMR1 module: Timer Enable - False, Prescaler - 1:8,  TMR Interrupt Enable - False
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
 
#define  USE_TASKS_API 0

#define MS_TO_TICKS(ms) (((TMR1_CLOCK_FREQ * (ms)) / 1000UL) - 1UL)
#define LED_4_MS  (TMR1_MAX_COUNT - MS_TO_TICKS(4UL))
#define LED_8_MS (TMR1_MAX_COUNT - MS_TO_TICKS(8UL))

static void Timer_PeriodChange(void)
{ 
    static volatile bool changePeriod = false;
    LED_Toggle();
    TMR1_Stop();
    
    uint16_t maxCount = TMR1_MaxCountGet();
    uint16_t newPeriod = changePeriod ? LED_4_MS:LED_8_MS;
    
    if(maxCount > newPeriod)
    {   
        TMR1_PeriodSet(newPeriod);
        TMR1_CounterSet(newPeriod);
    }
    else
    {
        // Invalid period
    }
    changePeriod = !changePeriod;
    TMR1_Start();
}

int main(void)
{
    SYSTEM_Initialize();

    TMR1_PeriodSet(LED_4_MS);
    TMR1_CounterSet(LED_4_MS);
    TMR1_OverflowStatusClear();
    
#if USE_TASKS_API    
    TMR1_OverflowCallbackRegister(Timer_PeriodChange);
#endif
    TMR1_Start();
    
    while(1)
    {
#if   USE_TASKS_API
        TMR1_Tasks();
#else
        if(1U == TMR1_OverflowStatusGet())
        {
            Timer_PeriodChange();
            TMR1_OverflowStatusClear();
        }
#endif
    }    
}

This use case configures the TMR1 PLIB to generate the overflow interrupt at a period of 4 ms, while toggling an LED. This use case uses the generated APIs to set the timer period.

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

#include "mcc_generated_files/system/system.h"
/*
 * Development Board: PIC18F57Q43 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     TMR1 module: Timer Enable - False, Prescaler - 1:8, TMR Interrupt Enable - True
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
 
#define MS_TO_TICKS(ms) (((TMR1_CLOCK_FREQ * (ms)) / 1000UL) - 1UL)
#define LED_4_MS  (TMR1_MAX_COUNT - (MS_TO_TICKS(4UL)))

void Custom_Callback(void)
{
    LED_Toggle();
}

int main(void)
{
    SYSTEM_Initialize();

    if(TMR1_MaxCountGet() > LED_4_MS)
    {
        TMR1_CounterSet(LED_4_MS);
        TMR1_PeriodSet(LED_4_MS);
    }
    else 
    {
        // Invalid period 
        // Generate default timer period
        
    }
    
    TMR1_OverflowCallbackRegister(Custom_Callback);
    TMR1_Start();
    
    INTERRUPT_GlobalInterruptEnable();
    
    while(1)
    {
    }    
}

This use case configures the TMR1 PLIB to wake the microcontroller from Sleep mode every five seconds. The wake up event toggles an LED, then puts the MCU back to Sleep.

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

#include "mcc_generated_files/system/system.h"

/*
 * Development Board: PIC18F57Q43 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     TMR1 module: Timer Enable - True, Clock Source - LFINTOSC, Prescaler - 1:4, Requested Period - 5s, TMR Interrupt Enable - True
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
int main(void)
{
    SYSTEM_Initialize();

    // Enable the Global Interrupts 
    INTERRUPT_GlobalInterruptEnable(); 

    while(1)
    {
        LED_Toggle();
        SLEEP(); 
        // Add your code here to execute after exiting Sleep mode 
    }    
}

• static void TMR1_DefaultOverflowCallback (void)

• static void TMR1_DefaultGateCallback (void)

• void TMR1_Initialize (void)

  Initializes the Timer1 (TMR1) module. This routine must be called before any other TMR1 routines.

• void TMR1_Deinitialize (void)

  Deinitializes the TMR1 to POR values.

• void TMR1_Start (void)

  Starts the TMR1 timer.

• void TMR1_Stop (void)

  Stops the TMR1 timer.

• uint16_t TMR1_CounterGet (void)

  Returns the current counter value.

• void TMR1_CounterSet (uint16_t timerVal)

  Sets the counter value.

• void TMR1_PeriodSet (uint16_t periodVal)

  Sets the period count value for the TMR1 timer. The period count is calculated by subtracting the number of ticks required for the period from the maximum count.

• uint16_t TMR1_PeriodGet (void)

  Returns the period count value.

• void TMR1_Reload (void)

  Loads the period count value to the TMR1 register.

• uint16_t TMR1_MaxCountGet (void)

  Returns the TMR1 maximum count value.

• void TMR1_SinglePulseAcquisitionStart (void)

  Starts the single pulse acquisition in TMR1 gate operation.

• uint8_t TMR1_GateStateGet (void)

  Returns the TMR1 gate state value.

• bool TMR1_OverflowStatusGet (void)

  Returns the TMR1 overflow flag status in Non-Interrupt mode.

• void TMR1_OverflowStatusClear (void)

  Clears the TMR1 overflow flag in Non-Interrupt mode.

• void TMR1_Tasks (void)

  Performs the tasks to be executed during the TMR1 overflow or gate event.

• void TMR1_OverflowCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TMR1 overflow event.

• void TMR1_GateCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TMR1 gate event.

• static volatile uint16_t timer1ReloadVal

• static void(* TMR1_OverflowCallback )(void)

• static void(* TMR1_GateCallback )(void)

Driver implementation for the TMR1 driver.

Driver implementation for the TMR1 Timer driver.

TMR1 Generated Driver File

TMR1 Generated Timer Driver File

• void TMR1_Initialize (void)

  Initializes the Timer1 (TMR1) module. This routine must be called before any other TMR1 routines.

• void TMR1_Deinitialize (void)

  Deinitializes the TMR1 to POR values.

• void TMR1_Start (void)

  Starts the TMR1 timer.

• void TMR1_Stop (void)

  Stops the TMR1 timer.

• uint16_t TMR1_CounterGet (void)

  Returns the current counter value.

• void TMR1_CounterSet (uint16_t timerVal)

  Sets the counter value.

• void TMR1_PeriodSet (uint16_t periodVal)

  Sets the period count value for the TMR1 timer. The period count is calculated by subtracting the number of ticks required for the period from the maximum count.

• uint16_t TMR1_PeriodGet (void)

  Returns the period count value.

• void TMR1_Reload (void)

  Loads the period count value to the TMR1 register.

• uint16_t TMR1_MaxCountGet (void)

  Returns the TMR1 maximum count value.

• void TMR1_SinglePulseAcquisitionStart (void)

  Starts the single pulse acquisition in TMR1 gate operation.

• uint8_t TMR1_GateStateGet (void)

  Returns the TMR1 gate state value.

• bool TMR1_OverflowStatusGet (void)

  Returns the TMR1 overflow flag status in Non-Interrupt mode.

• void TMR1_OverflowStatusClear (void)

  Clears the TMR1 overflow flag in Non-Interrupt mode.

• void TMR1_TMRInterruptEnable (void)

  Enables the TMR1 overflow interrupt.

• void TMR1_TMRInterruptDisable (void)

  Disables the TMR1 overflow interrupt.

• void TMR1_OverflowISR (void)

  Interrupt Service Routine (ISR) for the TMR1 overflow interrupt.

• void TMR1_TMRGInterruptEnable (void)

  Enables the TMR1 gate interrupt.

• void TMR1_TMRGInterruptDisable (void)

  Disables the TMR1 gate interrupt.

• void TMR1_GateISR (void)

  Interrupt Service Routine (ISR) for the TMR1 gate event.

• void TMR1_Tasks (void)

  Performs the tasks to be executed during the TMR1 overflow or gate event.

• void TMR1_OverflowCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TMR1 overflow event.

• void TMR1_GateCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TMR1 gate event.

• #define TMR1_MAX_COUNT (65535U)

  Defines the maximum count value of the timer.

• #define TMR1_CLOCK_FREQ (64000000UL)

  Defines the TMR1 prescaled clock frequency in hertz.

• #define TIMER1_MAX_COUNT TMR1_MAX_COUNT

  Defines the Custom Name for the TMR1_MAX_COUNT.

• #define TIMER1_CLOCK_FREQ TMR1_CLOCK_FREQ

  Defines the Custom Name for the TMR1_CLOCK_FREQ.

• #define Timer1_Initialize TMR1_Initialize

  Defines the Custom Name for the TMR1_Initialize API.

• #define Timer1_Deinitialize TMR1_Deinitialize

  Defines the Custom Name for the TMR1_Deinitialize API.

• #define Timer1_Start TMR1_Start

  Defines the Custom Name for the TMR1_Start API.

• #define Timer1_Stop TMR1_Stop

  Defines the Custom Name for the TMR1_Stop API.

• #define Timer1_CounterGet TMR1_CounterGet

  Defines the Custom Name for the TMR1_CounterGet API.

• #define Timer1_CounterSet TMR1_CounterSet

  Defines the Custom Name for the TMR1_CounterSet API.

• #define Timer1_PeriodSet TMR1_PeriodSet

  Defines the Custom Name for the TMR1_PeriodSet API.

• #define Timer1_PeriodGet TMR1_PeriodGet

  Defines the Custom Name for the TMR1_PeriodGet API.

• #define Timer1_MaxCountGet TMR1_MaxCountGet

  Defines the Custom Name for the TMR1_MaxCountGet API.

• #define Timer1_Reload TMR1_Reload

  Defines the Custom Name for the TMR1_Reload API.

• #define Timer1_GateStateGet TMR1_GateStateGet

  Defines the Custom Name for the TMR1_GateStateGet API.

• #define Timer1_SinglePulseAcquisitionStart TMR1_SinglePulseAcquisitionStart

  Defines the Custom Name for the TMR1_SinglePulseAcquisitionStart API.

• #define Timer1_GateCallbackRegister TMR1_GateCallbackRegister

  Defines the Custom Name for the TMR1_GateCallbackRegister API.

• #define Timer1_OverflowCallbackRegister TMR1_OverflowCallbackRegister

  Defines the Custom Name for the TMR1_OverflowCallbackRegister API.

• #define Timer1_OverflowStatusGet TMR1_OverflowStatusGet

  Defines the Custom Name for the TMR1_OverflowStatusGet API.

• #define Timer1_OverflowStatusClear TMR1_OverflowStatusClear

  Defines the Custom Name for the TMR1_OverflowStatusClear API.

• #define Timer1_TMRInterruptEnable TMR1_TMRInterruptEnable

  Defines the Custom Name for the TMR1_TMRInterruptEnable API.

• #define Timer1_TMRInterruptDisable TMR1_TMRInterruptDisable

  Defines the Custom Name for the TMR1_TMRInterruptDisable API.

• #define Timer1_TMRGInterruptEnable TMR1_TMRGInterruptEnable

  Defines the Custom Name for the TMR1_TMRGInterruptEnable API.

• #define Timer1_TMRGInterruptDisable TMR1_TMRGInterruptDisable

  Defines the Custom Name for the TMR1_TMRGInterruptDisable API.

• #define Timer1_Tasks TMR1_Tasks

  Defines the Custom Name for the TMR1_Tasks API.

This file contains API prototypes and other data types for the TMR1 Timer driver.

TMR1 Generated Driver API Header File

TMR1 Generated Timer Driver API Header File

• #define TMR1_Read TMR1_CounterGet

  Defines the Custom Name for the TMR1_CounterGet API. The TMR1_Read will be deprecated in the future release. Use TMR1_CounterGet instead.

• #define TMR1_Write TMR1_CounterSet

  Defines the Custom Name for the TMR1_CounterSet API. The TMR1_Write will be deprecated in the future release. Use TMR1_CounterSet instead.

• #define TMR1_CheckGateValueStatus TMR1_GateStateGet

  Defines the Custom Name for the TMR1_GateStateGet API. The TMR1_CheckGateValueStatus will be deprecated in the future release. Use TMR1_GateStateGet instead.

• #define Timer1_Read TMR1_CounterGet

  Defines the Custom Name for the TMR1_CounterGet API. The Timer1_Read will be deprecated in the future release. Use Timer1_CounterGet instead.

• #define TMR1_Write TMR1_CounterSet

  Defines the Custom Name for the TMR1_CounterSet API. The TMR1_Write will be deprecated in the future release. Use TMR1_CounterSet instead.

• #define Timer1_Write TMR1_CounterSet

  Defines the Custom Name for the TMR1_CounterSet API. The Timer1_Write will be deprecated in the future release. Use Timer1_CounterSet instead.

• #define TMR1_PeriodCountSet TMR1_PeriodSet

  Defines the Custom Name for the TMR1_PeriodSet API. The TMR1_PeriodCountSet will be deprecated in the future release. Use TMR1_PeriodSet instead.

• #define Timer1_PeriodCountSet TMR1_PeriodSet

  Defines the Custom Name for the TMR1_PeriodSet API. The Timer1_PeriodCountSet will be deprecated in the future release. Use Timer1_PeriodSet instead.

• #define TMR1_CheckGateValueStatus TMR1_GateStateGet

  Defines the Custom Name for the TMR1_GateStateGet API. The TMR1_CheckGateValueStatus will be deprecated in the future release. Use TMR1_GateStateGet instead.

• #define Timer1_CheckGateValueStatus TMR1_GateStateGet

  Defines the Custom Name for the TMR1_GateStateGet API. The Timer1_CheckGateValueStatus will be deprecated in the future release. Use Timer1_GateStateGet instead.

• #define TMR1_StartSinglePulseAcquisition TMR1_SinglePulseAcquisitionStart

  Defines the Custom Name for the TMR1_SinglePulseAcquisitionStart API. The TMR1_StartSinglePulseAcquisition will be deprecated in the future release. Use TMR1_SinglePulseAcquisitionStart instead.

• #define Timer1_StartSinglePulseAcquisition TMR1_SinglePulseAcquisitionStart

  Defines the Custom Name for the TMR1_SinglePulseAcquisitionStart API. The Timer1_StartSinglePulseAcquisition will be deprecated in the future release. Use Timer1_SinglePulseAcquisitionStart instead.

• #define TMR1_HasOverflowOccured TMR1_OverflowStatusGet

  Defines the Custom Name for the TMR1_OverflowStatusGet API. The TMR1_HasOverflowOccured will be deprecated in the future release. Use TMR1_OverflowStatusGet instead.

• #define Timer1_HasOverflowOccured TMR1_OverflowStatusGet

  Defines the Custom Name for the TMR1_OverflowStatusGet API. The Timer1_HasOverflowOccured will be deprecated in the future release. Use Timer1_OverflowStatusGet instead.

• static void TMR1_DefaultOverflowCallback (void)

• void TMR1_Initialize (void)

  Initializes the Timer1 (TMR1) module. This routine must be called before any other TMR1 routines.

• void TMR1_Deinitialize (void)

  Deinitializes the TMR1 to POR values.

• void TMR1_Start (void)

  Starts the TMR1 timer.

• void TMR1_Stop (void)

  Stops the TMR1 timer.

• uint16_t TMR1_CounterGet (void)

  Returns the current counter value.

• void TMR1_CounterSet (uint16_t timerVal)

  Sets the counter value.

• void TMR1_PeriodSet (uint16_t periodVal)

  Sets the period count value for the TMR1 timer. The period count is calculated by subtracting the number of ticks required for the period from the maximum count.

• uint16_t TMR1_PeriodGet (void)

  Returns the period count value.

• uint32_t TMR1_MaxCountGet (void)

  Returns the TMR1 maximum count value.

• void TMR1_OverflowISR (void)

  Interrupt Service Routine (ISR) for the TMR1 overflow interrupt.

• void TMR1_OverflowCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TMR1 overflow event.

• const struct TIMER_INTERFACE Timer1

• static volatile uint16_t timer1ReloadVal

• static void(* TMR1_OverflowCallback )(void)

• void TMR1_Initialize (void)

  Initializes the Timer1 (TMR1) module. This routine must be called before any other TMR1 routines.

• void TMR1_Deinitialize (void)

  Deinitializes the TMR1 module.

• void TMR1_Start (void)

  Starts the TMR1 timer.

• void TMR1_Stop (void)

  Stops the TMR1 timer.

• uint32_t TMR1_CounterGet (void)

  Returns the current counter value.

• void TMR1_CounterSet (uint32_t timerVal)

  Sets the counter value.

• void TMR1_PeriodSet (uint32_t periodVal)

  Sets the period count value.

• uint32_t TMR1_PeriodGet (void)

  Returns the current period value.

• uint32_t TMR1_MaxCountGet (void)

  Returns the maximum count value of timer.

• void TMR1_OverflowISR (void)

  Interrupt Service Routine (ISR) for the TMR1 overflow interrupt.

• void TMR1_Tasks (void)

  Performs tasks to be executed during the TMR1 overflow event.

• void TMR1_OverflowCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TMR1 overflow event.

• #define TMR1_MAX_COUNT (65535U)

  Defines the maximum count value of the timer.

• #define TMR1_CLOCK_FREQ (64000000UL)

  Defines the timer prescaled clock frequency in hertz.

• #define TIMER1_MAX_COUNT TMR1_MAX_COUNT

  Defines the Custom Name for the TMR1_MAX_COUNT.

• #define TIMER1_CLOCK_FREQ TMR1_CLOCK_FREQ

  Defines the Custom Name for the TMR1_CLOCK_FREQ.

• #define Timer1_Initialize TMR1_Initialize

  Defines the Custom Name for the TMR1_Initialize API.

• #define Timer1_Deinitialize TMR1_Deinitialize

  Defines the Custom Name for the TMR1_Deinitialize API.

• #define Timer1_Start TMR1_Start

  Defines the Custom Name for the TMR1_Start API.

• #define Timer1_Stop TMR1_Stop

  Defines the Custom Name for the TMR1_Stop API.

• #define Timer1_CounterGet TMR1_CounterGet

  Defines the Custom Name for the TMR1_CounterGet API.

• #define Timer1_CounterSet TMR1_CounterSet

  Defines the Custom Name for the TMR1_CounterSet API.

• #define Timer1_PeriodSet TMR1_PeriodSet

  Defines the Custom Name for the TMR1_PeriodSet API.

• #define Timer1_PeriodGet TMR1_PeriodGet

  Defines the Custom Name for the TMR1_PeriodGet API.

• #define Timer1_MaxCountGet TMR1_MaxCountGet

  Defines the Custom Name for the TMR1_MaxCountGet API.

• #define Timer1_OverflowISR TMR1_OverflowISR

  Defines the Custom Name for the TMR1_OverflowISR API.

• #define Timer1_Tasks TMR1_Tasks

  Defines the Custom Name for the TMR1_Tasks API.

• #define Timer1_OverflowCallbackRegister TMR1_OverflowCallbackRegister

  Defines the Custom Name for the TMR1_OverflowCallbackRegister API.

• const struct TIMER_INTERFACE Timer1