113 lines
4.8 KiB
Plaintext
113 lines
4.8 KiB
Plaintext
/**
|
|
@page RTC_Calendar RTC Calendar Example
|
|
|
|
@verbatim
|
|
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
|
|
* @file RTC/RTC_Calendar/readme.txt
|
|
* @author MCD Application Team
|
|
* @brief Description of the RTC Calendar example.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© Copyright (c) 2016 STMicroelectronics.
|
|
* All rights reserved.</center></h2>
|
|
*
|
|
* This software component is licensed by ST under BSD 3-Clause license,
|
|
* the "License"; You may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at:
|
|
* opensource.org/licenses/BSD-3-Clause
|
|
*
|
|
******************************************************************************
|
|
@endverbatim
|
|
|
|
@par Example Description
|
|
|
|
Configuration of the calendar using the RTC HAL API.
|
|
|
|
At the beginning of the main program the HAL_Init() function is called to reset
|
|
all the peripherals, initialize the Flash interface and the systick.
|
|
Then the SystemClock_Config() function is used to configure the system
|
|
clock (SYSCLK) to run at 72 MHz.
|
|
|
|
The RTC peripheral configuration is ensured by the HAL_RTC_Init() function.
|
|
This later is calling the HAL_RTC_MspInit()function which core is implementing
|
|
the configuration 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.
|
|
|
|
LSE oscillator clock is used as RTC clock source.
|
|
|
|
HAL_RTC_SetTime()and HAL_RTC_SetDate() functions are then called to initialize the
|
|
time and the date.
|
|
|
|
A key value is written in backup data register 1 to indicate if the RTC is already configured.
|
|
The RTC is in the backup (BKP) domain, still powered by VBAT when VDD is switched off,
|
|
so the RTC configuration is not lost if a battery is connected to the VBAT pin.
|
|
|
|
The program behaves as follows:
|
|
|
|
1. After startup the program checks the backup data register 1 value:
|
|
- BKP_DR1 value not correct: (RTC_BKP_DR1 value is not correct or has not yet
|
|
been programmed when the program is executed for the first time) the RTC is
|
|
configured.
|
|
|
|
- BKP_DR1 value correct: this means that the RTC is configured and the time
|
|
and date are displayed on Debugger.
|
|
|
|
2. When a reset (exept power on reset) occurs the BKP domain is not reset and the RTC
|
|
configuration is not lost. LED4 is ON.
|
|
|
|
3. When power on reset occurs:
|
|
- If a battery is connected to the VBAT pin: the BKP domain is not reset and
|
|
the RTC configuration is not lost. LED2 is ON.
|
|
|
|
- If no battery is connected to the VBAT pin: the BKP domain is reset and the
|
|
RTC configuration is lost.
|
|
|
|
@note On STM32F1 families, as there are restrictions on the RTC version V1, date
|
|
will be lost in all the cases.
|
|
|
|
LED1 is turned ON when the RTC configuration is done correctly.
|
|
|
|
|
|
The current time and date are updated and displayed on the debugger in aShowTime
|
|
and aShowDate variables.
|
|
|
|
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
|
|
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
|
|
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
|
|
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
|
|
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
|
|
|
|
@note The application need to ensure that the SysTick time base is always set to 1 millisecond
|
|
to have correct HAL operation.
|
|
|
|
@par Directory contents
|
|
|
|
- RTC/RTC_Calendar/Inc/stm32f1xx_hal_conf.h HAL configuration file
|
|
- RTC/RTC_Calendar/Inc/stm32f1xx_it.h Interrupt handlers header file
|
|
- RTC/RTC_Calendar/Inc/main.h Header for main.c module
|
|
- RTC/RTC_Calendar/Src/stm32f1xx_it.c Interrupt handlers
|
|
- RTC/RTC_Calendar/Src/main.c Main program
|
|
- RTC/RTC_Calendar/Src/stm32f1xx_hal_msp.c HAL MSP module
|
|
- RTC/RTC_Calendar/Src/system_stm32f1xx.c STM32F1xx system source file
|
|
|
|
|
|
@par Hardware and Software environment
|
|
|
|
- This example runs on STM32F103xG Devices.
|
|
- This example has been tested with STMicroelectronics STM3210E-EVAL RevD
|
|
board and can be easily tailored to any other supported device and
|
|
development board.
|
|
- STM3210E-EVAL RevD Set-up
|
|
- Make sure that JP1 is in position 1-2 to connect 3V battery to VBAT pin.
|
|
|
|
@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>
|
|
*/
|