nuttx/Documentation/applications/examples/alarm/index.rst

22 lines
781 B
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

===================
``alarm`` RTC Alarm
===================
A simple example that tests the alarm IOCTLs of the RTC driver.
Dependencies:
- ``CONFIG_RTC_DRIVER`` RTC driver must be initialized to allow user space
access to the RTC.
- ``CONFIG_RTC_ALARM`` Support for RTC alarms must be enabled.
Configuration:
- ``CONFIG_EXAMPLES_ALARM`` Enable the RTC driver alarm test.
- ``CONFIG_EXAMPLES_ALARM_PROGNAME`` This is the name of the program that will
be used when the NSH ELF program is installed.
- ``CONFIG_EXAMPLES_ALARM_PRIORITY`` Alarm daemon priority.
- ``CONFIG_EXAMPLES_ALARM_STACKSIZE`` Alarm daemon stack size.
- ``CONFIG_EXAMPLES_ALARM_DEVPATH`` RTC device path (``/dev/rtc0``).
- ``CONFIG_EXAMPLES_ALARM_SIGNO`` Alarm signal.