Home
5 Real Time Counter
This file explains the basic use cases and implementation of the Real Time Counter.
5.1 Real Time Counter Driver Source Code Reference
This file contains the RTCounter APIs.
5.1.2 Functions
5.1.2.7 rtcount_create
This function adds a new timer to the list of serviced timers. The user supplies the memory for the timer and initializes it. This method simply updates absoluteTime and adds the timer to the list of serviced timers.

Foundation Services

1 Introduction and Objectives of Foundation Services
Foundation Services is a collection of software components such as peripheral drivers, middleware, and software applications (examples) provided by Microchip. The framework supports the Microchip's 8- and 16- bit PIC, as well as AVR families of microcontrollers.
2 Getting Started: Foundation Services in MCC
3 Delay Drivers
4 I2C Drivers
5 Real Time Counter
This file explains the basic use cases and implementation of the Real Time Counter.
- 5.1 Real Time Counter Driver Source Code Reference
  This file contains the RTCounter APIs.
  - 5.1.1 Structs
  - 5.1.2 Functions
    - 5.1.2.1 rtcount_isr
      This function is the handler that is called whenever the Timer peripheral overflows. The handler increments the RTCounter overflow counter.
    - 5.1.2.2 rtcount_initialize
      This function sets the RTCounter ISR handler as the the interrupt handler for the timer. Must be called while GIE = 0
    - 5.1.2.3 rtcount_getTickCount
      This function returns the 32-bit total tick count of the timer. This means concatenating the hardware timer value to the overflow counter
    - 5.1.2.4 rtcount_makeAbsolute
      This function returns a number of ticks and returns the total number of timer ticks since the last overflow occurred or the timer module was started.
    - 5.1.2.5 rtcount_sortedInsert
      This function figures out where the specific timer will be placed on the queue.
    - 5.1.2.6 rebase
      This function adjusts the time base so that the timer can be in the lower half of the range
    - 5.1.2.7 rtcount_create
      This function adds a new timer to the list of serviced timers. The user supplies the memory for the timer and initializes it. This method simply updates absoluteTime and adds the timer to the list of serviced timers.
    - 5.1.2.8 rtcount_reschedule
      This function adds time to previous ticks. We add it to the previous target and not to current time to ensure the cadence of the timer will be exact and no skidding is possible.
    - 5.1.2.9 rtcount_delete
      This function cancels and removes a running timer
    - 5.1.2.10 rtcount_callNextCallback
      This function checks the list of expired timers and calls the first one in the list if the list is not empty. It also reschedules the timer if the callback returned a value greater than 0.It is recommended that this is called from the main superloop (while(1)) in your code but by design this can also be called from the timer ISR. If you wish callbacks to happen from the ISR context you can call this as the last action in timeout_isr instead.
    - 5.1.2.11 stopTimeouts
      This function stops all timers
    - 5.1.2.12 rtcount_startTimer
      This function is specifically used in Stopwatch mode for calculating the elapsed time in stopwatch mode. It will start a timer with maximum timeout length.
    - 5.1.2.13 rtcount_stopTimer
      This function will stop the running timer and return the number of ticks it counted.
    - 5.1.2.14 rtcount_flushAll
      This function cancels and removes all timers in the queue
    - 5.1.2.15 rtcount_printList
      This function prints the times for each of the timer for each timer on the queue.
- 5.2 Real Time Counter Driver Example Source Code Reference
  This file contains the APIs to demonstrate the common use cases of the RTCounter.
6 SPI Drivers
The driver provides basic SPI functionality supporting both Master and Slave, each with or without interrupts.
7 Timeout Driver
This file recounts the basic use cases and implementation of the Timeout Driver.
8 UART Drivers
9 File List
Here is a list of all documented files with brief descriptions
10 Class List
Here is a list of all documented files with brief descriptions
The Microchip Website
Product Change Notification Service
Customer Support
Product Identification System
Microchip Devices Code Protection Feature
Legal Notice
Trademarks
Quality Management System
Worldwide Sales and Service

5.1.2.7 rtcount_create

This function adds a new timer to the list of serviced timers. The user supplies the memory for the timer and initializes it. This method simply updates absoluteTime and adds the timer to the list of serviced timers.

void rtcount_create(
    rtcountStruct_t * timer,    int32_t timeout
)

Parameters

*timer

Type: rtcountStruct_t *

- timer instance to be created and added to the list

timeout

Type: int32_t

- number of timer ticks before this timer expires.

Returns

Type: void