STM32CubeWL/Projects/NUCLEO-WL55JC/Examples/RTC/RTC_Binary
Ali Labbene 378e461e46 Release v1.3.0 2022-12-08 15:37:52 +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.3.0 2022-12-08 15:37:52 +01:00
.extSettings Release v1.0.0 2020-12-18 15:30:45 +01:00
RTC_Binary.ioc Release v1.2.0 2022-12-07 18:38:46 +01:00
readme.txt Release v1.0.0 2020-12-18 15:30:45 +01:00

readme.txt

/**
  @page RTC_Binary RTC Binary Example

  @verbatim
  ******************************************************************************
  * @file    RTC/RTC_Binary/readme.txt
  * @author  MCD Application Team
  * @brief   This example describes how to use the RTC Binary mode.
  ******************************************************************************
  *
  * 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

Configuration of the binary mode with binary alarm A and reading of the time.

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

The RTC peripheral configuration is ensured by the MX_RTC_Init() function.
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...). 
You may update this function to change RTC configuration.

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

This example performs the following:
1. Please, run the software.
2. It waits 5 seconds for a binary alarm.
3. LED2 turns ON, Test is OK.
   LED2 blinks or do not turn ON, 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, Binary, Alarm, LSE

@par Directory contents
  - RTC/RTC_Binary/Inc/stm32wlxx_nucleo_conf.h     BSP configuration file
  - RTC/RTC_Binary/Inc/stm32wlxx_hal_conf.h    HAL configuration file
  - RTC/RTC_Binary/Inc/stm32wlxx_it.h          Interrupt handlers header file
  - RTC/RTC_Binary/Inc/main.h                        Header for main.c module
  - RTC/RTC_Binary/Src/stm32wlxx_it.c          Interrupt handlers
  - RTC/RTC_Binary/Src/main.c                        Main program
  - RTC/RTC_Binary/Src/stm32wlxx_hal_msp.c     HAL MSP module
  - RTC/RTC_Binary/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 STMicroelectronics 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>
 */