STM32CubeWL/Projects/NUCLEO-WL55JC/Examples_LL/RTC/RTC_ExitStandbyWithWakeUpTi...
Ali Labbene 6d27fec2e5 Release v1.2.0 2022-12-07 18:38:46 +01:00
..
EWARM Release v1.2.0 2022-12-07 18:38:46 +01:00
Inc Release v1.2.0 2022-12-07 18:38:46 +01:00
MDK-ARM Release v1.2.0 2022-12-07 18:38:46 +01:00
STM32CubeIDE Release v1.2.0 2022-12-07 18:38:46 +01:00
Src Release v1.2.0 2022-12-07 18:38:46 +01:00
.extSettings Release v1.0.0 2020-12-18 15:30:45 +01:00
RTC_ExitStandbyWithWakeUpTimer_Init.ioc Release v1.1.0 2021-07-23 11:28:25 +01:00
readme.txt Release v1.0.0 2020-12-18 15:30:45 +01:00

readme.txt

/**
  @page RTC_ExitStandbyWithWakeUpTimer_Init RTC example

  @verbatim
  ******************************************************************************
  * @file    Examples_LL/RTC/RTC_ExitStandbyWithWakeUpTimer_Init/readme.txt
  * @author  MCD Application Team
  * @brief   Description of the RTC example.
  ******************************************************************************
  *
  * Copyright (c) 2020 STMicroelectronics. All rights reserved.
  *
  * 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

How to periodically enter and wake up from STANDBY mode thanks to the RTC Wakeup Timer (WUT).
The peripheral initialization uses LL unitary service functions for optimization purposes (performance and size).

In this example, after start-up, SYSCLK is configured to the max frequency using
the PLL with MSI as clock source.

   @note LSE oscillator clock is used as RTC clock source by default.
      The user can use also LSI as RTC clock source. The user uncomment the adequate
      line on the main.c file.
      @code
        #define RTC_CLOCK_SOURCE_LSE
        /* #define RTC_CLOCK_SOURCE_LSI */
      @endcode
      LSI oscillator clock is delivered by a 32 kHz RC.
      LSE (when available on board) is delivered by a 32.768 kHz crystal.

   @note The EXTI Line 20 is connected internally to the RTC Wakeup Timer (WUT) event.

Example execution:
  The RTC Wakeup Timer (WUT) is configured to periodically generate an event every 3 seconds
  and the system enters STANDBY mode. After the WUT event is generated, the system wakes up. The system enters again in STANDBY mode after each wakeup.
  After 5 times the system wakes up (5 * 3 seconds = 15 seconds), the program checks that the RTC seconds value is also 15 seconds.
  It means that the test is OK.

One of the below scenario can occur :
   - LED2 (pin PB.09) toggles 2 times : The system woke up from standby.
   - LED2 (pin PB.09) is ON after 15 seconds : Test is over, result is OK.
   - LED2 (pin PB.09) is toggling in infinite loop at a frequency of 5Hz: An error occurred.

@note This example can not be used in DEBUG mode, this is due to the fact
      that the core is no longer clocked during low power mode
      so debugging features are disabled.
      To use the DEBUG mode uncomment __DBGMCU_EnableDBGStandbyMode in main() but
      current consumption in STANDBY mode will increase a lot.



@par Keywords

System, RTC, RTC Wakeup timer, Standby mode, LSI, LSE, Interrupt,

@par Directory contents

  - RTC/RTC_ExitStandbyWithWakeUpTimer_Init/Inc/stm32wlxx_it.h          Interrupt handlers header file
  - RTC/RTC_ExitStandbyWithWakeUpTimer_Init/Inc/main.h                       Header for main.c module
  - RTC/RTC_ExitStandbyWithWakeUpTimer_Init/Inc/stm32_assert.h               Template file to include assert_failed function
  - RTC/RTC_ExitStandbyWithWakeUpTimer_Init/Src/stm32wlxx_it.c          Interrupt handlers
  - RTC/RTC_ExitStandbyWithWakeUpTimer_Init/Src/main.c                        Main program
  - RTC/RTC_ExitStandbyWithWakeUpTimer_Init/Src/system_stm32wlxx.c      STM32WLxx system source file


@par Hardware and Software environment

  - This example runs on STM32WL55JCIx devices.

  - This example has been tested with NUCLEO-WL55JC RevC 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>
 */