Welcome to mirror list, hosted at ThFree Co, Russian Federation.

readme.txt « RTC_Tamper « RTC « Examples « NUCLEO-WB15CC « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 457e41a18ca8fb51b252e6146c01a239b2cfd749 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/**
  @page RTC_Tamper RTC Tamper Example

  @verbatim
  ******************************************************************************
  * @file    RTC/RTC_Tamper/readme.txt
  * @author  MCD Application Team
  * @brief   Description of the RTC Tamper example.
  ******************************************************************************
  *
  * Copyright (c) 2019-2021 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  @endverbatim

@par Example Description

Configuration of the tamper detection with backup registers erase.

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 64 MHz.

The RTC peripheral configuration is ensured by the MX_RTC_Init() and MX_TAMP_RTC_Init functions.
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.

@note LSE oscillator clock is used as RTC clock source (32.768 kHz) by default.

This example performs the following:
1. Please, run the software.
2. It configures the Tamper 2 pin  and enables the Tamper 2 interrupt.
3. It writes a data to a RTC Backup register, then check if the data is correctly written.
4. USER Button is linked To Tamper 2 pin (PA0). Please press it to generate a tamper detection.
5. The RTC backup register is reset and the Tamper interrupt is generated.
   The firmware then checks if the RTC Backup register is cleared.
6. LED2 turns ON, Test is OK.
   LED2 blinks, Test is KO.

@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 Keywords
System, RTC, Tamper, Reset, LSE, Backup

@par Directory contents
  - RTC/RTC_Tamper/Inc/nucleo_wb15cc_conf.h     BSP configuration file
  - RTC/RTC_Tamper/Inc/stm32wbxx_hal_conf.h    HAL configuration file
  - RTC/RTC_Tamper/Inc/stm32wbxx_it.h          Interrupt handlers header file
  - RTC/RTC_Tamper/Inc/main.h                        Header for main.c module
  - RTC/RTC_Tamper/Src/stm32wbxx_it.c          Interrupt handlers
  - RTC/RTC_Tamper/Src/main.c                        Main program
  - RTC/RTC_Tamper/Src/stm32wbxx_hal_msp.c     HAL MSP module
  - RTC/RTC_Tamper/Src/system_stm32wbxx.c      STM32WBxx system source file


@par Hardware and Software environment
  - This example runs on STM32WB15CCUx devices.
  - This example has been tested with STMicroelectronics NUCLEO-WB15CC
    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>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */