rtc.h

Go to the documentation of this file.

/* USER CODE BEGIN Header */
/**
  ******************************************************************************
  * @file    rtc.h
  * @brief   This file contains all the function prototypes for
  *          the rtc.c file
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2026 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.
  *
  ******************************************************************************
  */
/* USER CODE END Header */
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __RTC_H__
#define __RTC_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Includes ------------------------------------------------------------------*/
#include "main.h"
 
/* USER CODE BEGIN Includes */
 
/* USER CODE END Includes */
 
extern RTC_HandleTypeDef hrtc;
 
/* USER CODE BEGIN Private defines */
 
/* USER CODE END Private defines */
 
/**
 * @brief Initialise the RTC peripheral with settings generated by STM32CubeMX.
 *        Configures the prescalers, calendar format, and wakeup clock source.
 *        Called once from main(); subsequent wakeup timers are set with
 *        RTC_SetWakeupTimer_10Minutes().
 */
void MX_RTC_Init(void);
 
/* USER CODE BEGIN Prototypes */
 
/**
 * @brief Configure the RTC periodic wakeup timer.
 *
 * Uses RTC_WAKEUPCLOCK_CK_SPRE_16BITS (1 Hz ck_spre derived from the RTC
 * prescalers) so that the counter value directly represents seconds minus 1.
 * The wakeup interrupt wakes the CPU from STOP / standby mode and triggers
 * the next sensor measurement cycle.
 *
 * @note The actual wakeup period is determined by the counter value set in the
 *       implementation (currently ~60 s; original design was 600 s = 10 min).
 *       The function name is kept for backward compatibility.
 *
 * @return HAL_OK on success, HAL_ERROR if the timer could not be configured.
 */
HAL_StatusTypeDef RTC_SetWakeupTimer_10Minutes(void);
 
/* USER CODE END Prototypes */
 
#ifdef __cplusplus
}
#endif
 
#endif /* __RTC_H__ */