main.h

Go to the documentation of this file.

/* USER CODE BEGIN Header */
/**
  ******************************************************************************
  * @file           : main.h
  * @brief          : Header for main.c file.
  *                   This file contains the common defines of the application.
  *  https://senzors.pages.dev/
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2025 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 __MAIN_H
#define __MAIN_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Includes ------------------------------------------------------------------*/
#include "stm32wlxx_hal.h"
 
/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */
#include "LmHandler.h"
#include "mysensors_def.h"
 
/* USER CODE END Includes */
 
/* Exported types ------------------------------------------------------------*/
/* USER CODE BEGIN ET */
 
// HAL_RTC_AlarmIRQHandler, RTC_Alarm_IRQHandler
 
/* USER CODE END ET */
 
/* Exported constants --------------------------------------------------------*/
/* USER CODE BEGIN EC */
/**
 * @brief Device power/sleep mode selector.
 *
 * Passed to setModeDevice() to request a specific power state transition.
 * The sequencer ensures in-flight LoRaWAN transmissions complete before
 * the mode switch is executed.
 */
typedef enum
{
    MODEDEVICE_SLEEP,   /**< CPU sleep only – clocks running, fastest wake-up (rarely used) */
    MODEDEVICE_STOP,    /**< STOP2 mode – most peripherals off, RTC running, ~1 µA; wake via RTC or interrupt */
    MODEDEVICE_OFF, /**< Standby (OFF) mode – deepest sleep, restarts via RTC wakeup timer or wakeupPin */
} modeDevice_t;
/* USER CODE END EC */
 
/* Exported macro ------------------------------------------------------------*/
/* USER CODE BEGIN EM */
 
 
#ifdef WRITELOG
#include <stdarg.h>
/**
 * @brief Send a pre-formatted C string to the UART log followed by a newline.
 * @param buf Null-terminated string to transmit.
 */
void writeLogNL(const char *buf);
 
/**
 * @brief Format and send a log message using a va_list argument list.
 *        Used internally by writeLog(); can also be called from wrapper
 *        functions that accept a variadic argument list.
 * @param format printf-compatible format string.
 * @param argList Initialised va_list of format arguments.
 */
void writeLogVA(const char *format, va_list argList);
 
/**
 * @brief Format and send a log message over UART (printf-style).
 *        Available only when WRITELOG is defined; compiles to nothing otherwise.
 * @param format printf-compatible format string followed by optional arguments.
 */
void writeLog(const char *format, ...);
#else
#define writeLogNL(...)
#define writeLogVA(...)
#define writeLog(...)
#endif
 
 
/* USER CODE END EM */
 
/* Exported functions prototypes ---------------------------------------------*/
void Error_Handler(void);
 
/* USER CODE BEGIN EFP */
 
/**
 * @brief Re-configure all system clocks after waking from STOP or OFF mode.
 *        Called automatically during the startup/reset sequence; may also be
 *        called after exiting low-power modes to restore the full clock tree.
 */
void SystemClock_Config(void);
 
/**
 * @brief start of UART reading
 */
void uart_Start();
 
/**
 * @brief togle led
 * @param off - 0 - led is toggled, 1 - led is OFF
 */
void togle_LedOff(int off);
 
/**
 * @brief set new device mode
 */
void setModeDevice(modeDevice_t mod);
 
 
/**
 * @brief Cumulative turn the all peripheries to ON state - pull-up the _3V3_Enb_Pin pin
 */
void Power3v3_On();
 
/**
 * @brief Cumulative turn the all peripheries to OFF state - pull-down the _3V3_Enb_Pin pin
 */
void Power3v3_Off();
 
 
/* USER CODE END EFP */
 
/* Private defines -----------------------------------------------------------*/
#define RTC_N_PREDIV_S 10
#define RTC_PREDIV_S ((1<<RTC_N_PREDIV_S)-1)
#define RTC_PREDIV_A ((1<<(15-RTC_N_PREDIV_S))-1)
#define NFC_INT_Pin GPIO_PIN_0
#define NFC_INT_GPIO_Port GPIOA
#define NFC_INT_EXTI_IRQn EXTI0_IRQn
#define SPI1_CS_Pin GPIO_PIN_4
#define SPI1_CS_GPIO_Port GPIOA
#define USER_LED_Pin GPIO_PIN_8
#define USER_LED_GPIO_Port GPIOA
#define _3V3_Enb_Pin GPIO_PIN_2
#define _3V3_Enb_GPIO_Port GPIOB
#define Bat_Mon_Enb_Pin GPIO_PIN_12
#define Bat_Mon_Enb_GPIO_Port GPIOB
#define NFC_LPD_Enb_Pin GPIO_PIN_10
#define NFC_LPD_Enb_GPIO_Port GPIOA
 
/* USER CODE BEGIN Private defines */
 
/**
 * @brief Control variable for entering stop mode.
 *
 * Set this variable to 1 to request the device to enter stop mode.
 * The device will:
 * - Check if LoRaWAN stack is ready (not busy)
 * - Turn off sensors
 * - Deinitialize I2C, SPI, and UART peripherals
 * - Enter STOP mode with low power regulator
 * - Wake up after the configured SensorTimeoutMeasure interval via RTC wakeup timer
 * - Reinitialize all peripherals and resume operation
 *
 * Set to 0 for normal operation (default).
 *
 * Example usage:
 * @code
 *   extern volatile int8_t _GoToStop;
 *   _GoToStop = 1;  // Request stop mode entry
 * @endcode
 */
 
/* USER CODE END Private defines */
 
#ifdef __cplusplus
}
#endif
 
#endif /* __MAIN_H */