esp-idf/examples/peripherals/timer_group/legacy_driver
Darian Leung 781d06af73 esp_hw_support: Remove compare_set.h API
This function removes the following legacy atomic CAS functions:

From compare_set.h (file removed):
- compare_and_set_native()
- compare_and_set_extram()

From portmacro.h
- uxPortCompareSet()
- uxPortCompareSetExtram()

Users should call esp_cpu_compare_and_set() instead as this function hides the details
of atomic CAS on internal and external RAM addresses.

Due to the removal of compare_set.h, some missing header includes are also fixed in this commit.
2022-07-22 00:06:06 +08:00
..
main esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
CMakeLists.txt
README.md
pytest_timer_group.py
sdkconfig.defaults

README.md

Supported Targets ESP32 ESP32-C2 ESP32-C3 ESP32-S2 ESP32-S3

Example: General Purpose Timer

This example uses the timer group driver to generate timer interrupts at two specified alarm intervals.

How to Use Example

Hardware Required

  • A development board with ESP SoC (e.g., ESP32-DevKitC, ESP-WROVER-KIT, etc.)
  • A USB cable for Power supply and programming

Build and Flash

Run idf.py -p PORT flash monitor to build, flash and monitor the project.

(To exit the serial monitor, type Ctrl-].)

See the ESP-IDF Getting Started Guide for all the steps to configure and use the ESP-IDF to build projects.

Example Output

I (0) cpu_start: Starting scheduler on APP CPU.
I (325) example: Init timer with auto-reload
I (835) example: Timer auto reloaded, count value in ISR: 3
I (1335) example: Timer auto reloaded, count value in ISR: 3
I (1835) example: Timer auto reloaded, count value in ISR: 3
I (2335) example: Timer auto reloaded, count value in ISR: 3
I (2335) example: Init timer without auto-reload
I (2835) example: Timer alarmed at 500003
I (3335) example: Timer alarmed at 1000003
I (3835) example: Timer alarmed at 1500003
I (4335) example: Timer alarmed at 2000003

Functionality Overview

  • Configure one timer with auto-reload enabled, alarm period set to 0.5s
  • On reaching the interval value the timer will generate an alarm
  • The timer will reload with initial count value on alarm, by hardware
  • Reconfigure the timer with auto-reload disabled, initial alarm value set to 0.5s
  • The timer keeps incrementing and in the alarm callback, the software reconfigures its alarm value by increasing 0.5s
  • The main task will print the count value that captured in the alarm callback

Troubleshooting

For any technical queries, please open an issue on GitHub. We will get back to you soon.