zephyr

History

Alexandre Bourdiol 507ebecffc sample: drivers: counter: alarm: adapt test to driver change Due to counter driver implementation change "driver/counter/counter_ll_stm32_rtc.c: Add 1 tick to alarm" It is necessary to adapt sample test (sanitycheck) to take into consideration 1 tick precision/tolerance. Signed-off-by: Alexandre Bourdiol <alexandre.bourdiol@st.com>		2020-05-19 14:48:49 +02:00
..
src	…
CMakeLists.txt	…
Kconfig	…
README.rst	sample: drivers: counter: alarm: adapt test to driver change	2020-05-19 14:48:49 +02:00
prj.conf	…
sample.yaml	sample: drivers: counter: alarm: adapt test to driver change	2020-05-19 14:48:49 +02:00

README.rst

.. _alarm_sample:

Counter Alarm Sample
#####################

Overview
********
This sample provides an example of alarm application using 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>