mirror of
https://github.com/STMicroelectronics/STM32CubeF4.git
synced 2025-05-08 19:29:40 +08:00
102 lines
4.5 KiB
Plaintext
102 lines
4.5 KiB
Plaintext
/**
|
|
@page RTC_Alarm RTC example
|
|
|
|
@verbatim
|
|
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
|
|
* @file Examples_LL/RTC/RTC_Alarm/readme.txt
|
|
* @author MCD Application Team
|
|
* @brief Description of the RTC example.
|
|
******************************************************************************
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* 3. Neither the name of STMicroelectronics nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
******************************************************************************
|
|
@endverbatim
|
|
|
|
@par Example Description
|
|
|
|
This example guides you through the different configuration steps by mean of LL API
|
|
to ensure Alarm configuration and generation using the RTC peripheral. Peripheral initialization
|
|
done using LL unitary services functions for optimization purpose (performance and size).
|
|
|
|
In this example, after start-up, SYSCLK is configured to the max frequency using the PLL with
|
|
HSI as clock source.
|
|
|
|
The RTC peripheral configuration is ensured by the Configure_RTC() function
|
|
(configure of the needed RTC resources according to the used hardware CLOCK,
|
|
PWR, RTC clock source and BackUp). You may update this function to change RTC configuration.
|
|
|
|
@note LSI oscillator clock is used as RTC clock source by default.
|
|
The user can use also LSE as RTC clock source. The user uncomment the adequate
|
|
line on the main.c file.
|
|
@code
|
|
#define RTC_CLOCK_SOURCE_LSI
|
|
/* #define RTC_CLOCK_SOURCE_LSE */
|
|
@endcode
|
|
LSI oscillator clock is delivered by a 32 kHz RC.
|
|
LSE (when available on board) is delivered by a 32.768 kHz crystal.
|
|
|
|
Configure_RTC_Alarm function is then called to initialize the
|
|
time, date and alarm.
|
|
|
|
In this example, the Time is set to 11:59:55 PM and the Alarm must be generated after
|
|
30 seconds on 12:00:25 AM.
|
|
|
|
The current time and date are updated and displayed on the debugger in aShowTime
|
|
and aShowDate variables (watch or live watch).
|
|
|
|
- LED2 is turned ON when the RTC Alarm is generated correctly.
|
|
- LED2 is toggling : This indicates that the system generates an error.
|
|
|
|
@par Keywords
|
|
|
|
System, RTC, Alarm, wakeup timer, Backup domain, Counter, LSE, LSI
|
|
|
|
@par Directory contents
|
|
|
|
- RTC/RTC_Alarm/Inc/stm32f4xx_it.h Interrupt handlers header file
|
|
- RTC/RTC_Alarm/Inc/main.h Header for main.c module
|
|
- RTC/RTC_Alarm/Inc/stm32_assert.h Template file to include assert_failed function
|
|
- RTC/RTC_Alarm/Src/stm32f4xx_it.c Interrupt handlers
|
|
- RTC/RTC_Alarm/Src/main.c Main program
|
|
- RTC/RTC_Alarm/Src/system_stm32f4xx.c STM32F4xx system source file
|
|
|
|
|
|
@par Hardware and Software environment
|
|
|
|
- This example runs on STM32F411xx devices.
|
|
|
|
- This example has been tested with NUCLEO-F411RE board and can be
|
|
easily tailored to any other supported device and development board.
|
|
|
|
|
|
@par How to use it ?
|
|
|
|
In order to make the program work, you must do the following :
|
|
- Open your preferred toolchain
|
|
- Rebuild all files and load your image into target memory
|
|
- Run the example
|
|
|
|
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
|
|
*/
|