zephyr

History

Jordan Yates 243eb36b18 everywhere: reindent `.overlay` files with tabs `checkpatch.pl` requires that dts sources are indented with tabs, fix all the spaces that slipped in while checkpatch wasn't watching. Signed-off-by: Jordan Yates <jordan@embeint.com>		2024-06-26 15:59:44 +02:00
..
boards	everywhere: reindent `.overlay` files with tabs	2024-06-26 15:59:44 +02:00
src	samples: drivers: counter: alarm: add stm32-rtc test case	2024-06-26 06:01:18 -04:00
CMakeLists.txt
Kconfig
prj.conf
README.rst
sample.yaml	samples: drivers: counter: alarm: add stm32-rtc test case	2024-06-26 06:01:18 -04:00

README.rst

.. zephyr:code-sample:: alarm
   :name: Counter Alarm
   :relevant-api: counter_interface

   Implement an alarm application using the counter API.

Overview
********
This sample provides an example of alarm application using :ref:`counter API <counter_api>`.
It sets an alarm with an initial delay of 2 seconds. At each alarm
expiry, a new alarm is configured with a delay multiplied by 2.

.. note::
   In case of 1Hz frequency (RTC for example), precision is 1 second.
   Therefore, the sample output may differ in 1 second

Requirements
************

This sample requires the support of a timer IP compatible with alarm setting.

References
**********

- :ref:`disco_l475_iot1_board`

Building and Running
********************

 .. zephyr-app-commands::
    :zephyr-app: samples/drivers/counter/alarm
    :host-os: unix
    :board: disco_l475_iot1
    :goals: run
    :compact:

Sample Output
=============

 .. code-block:: console

    Counter alarm sample

    Set alarm in 2 sec
    !!! Alarm !!!
    Now: 2
    Set alarm in 4 sec
    !!! Alarm !!!
    Now: 6
    Set alarm in 8 sec
    !!! Alarm !!!
    Now: 14
    Set alarm in 16 sec
    !!! Alarm !!!
    Now: 30

    <repeats endlessly>