bar_ils22qs.h

Go to the documentation of this file.

/*
 * bar_ils22qs.h
 *
 *  Created on: 27. 12. 2025
 *      Author: Milan
 *
 * Barometer 8 Click,  ILPS22QS.pdf datasheet https://www.st.com/resource/en/datasheet/ilps22qs.pdf
 *       ILPS22QS
 *
 * code generated via Gemini: https://gemini.google.com/share/76db6b22d296
 *
 * The sensor needs to be explicitly turned on and then off to save power consumption
 *
 * For
 *
 */
 
#ifndef INC_BAR_ILS22QS_H_
#define INC_BAR_ILS22QS_H_
 
#include "mysensors_def.h"
 
#ifdef SENSOR_BAR_ILS22QS
 
#include "stm32wlxx_hal.h" // Change to your specific family (e.g., l4xx, g0xx)
 
#pragma pack(1)
/**
 * @brief Measurement data produced by the ILPS22QS barometric pressure sensor.
 *        Populated by bar_ils22qs_Read(); check IsDataValid before use.
 */
typedef struct
{
    float PressureABS; /**< Absolute atmospheric pressure in hPa */
    float PressureSEA; /**< Pressure corrected to sea level in hPa (requires SHT45 temperature) */
    float Temperature; /**< Temperature from the sensor in degrees Celsius (accuracy may vary) */
    int8_t IsDataValid; /**< 1 – values are valid; 0 – last read failed or sensor not ready */
} bar_ils22qs_t;
#pragma pack()
/**
 * @brief Live measurement data from the ILPS22QS sensor; updated by bar_ils22qs_Read().
 */
extern bar_ils22qs_t _bar_ils22qsData;
/**
 * @brief Snapshot copy of the last completed ILPS22QS measurement; used for LoRaWAN transmission.
 */
extern bar_ils22qs_t _bck_bar_ils22qsData;
 
/**
 * @brief Check if the ILPS22QS barometric pressure sensor is present on the I2C bus.
 * @param hi2c    Pointer to the I2C handle.
 * @param tryInit 1 – attempt to (re-)initialise if not yet done; 0 – no retry.
 * @retval 1 – sensor is present and initialised.
 * @retval 0 – sensor not detected.
 */
int8_t bar_ils22qs_Is(I2C_HandleTypeDef *hi2c, int8_t tryInit);
 
/**
 * @brief Initialise the ILPS22QS sensor and verify it is present on the I2C bus.
 *        The sensor is put into low-power standby mode after verification.
 * @param hi2c Pointer to the I2C handle.
 * @retval HAL_OK   – sensor found and initialised successfully.
 * @retval HAL_ERROR – sensor not detected on the bus or initialisation failed.
 */
HAL_StatusTypeDef bar_ils22qs_Init(I2C_HandleTypeDef *hi2c);
 
 
/**
 * @brief turn on sensor
 * @retval HAL_OK, HAL_ERROR
 */
HAL_StatusTypeDef bar_ils22qs_On(I2C_HandleTypeDef *hi2c);
 
/**
 * @brief turn off sensor
 * @retval HAL_OK, HAL_ERROR
 */
HAL_StatusTypeDef bar_ils22qs_Off(I2C_HandleTypeDef *hi2c);
 
 
/**
 * @brief read value from sensor, pressure and temperature.
 * Sensor must be turned on before
 * @retval
 *  HAL_OK - have data,
 *  HAL_BUSY - next reading in progress,
 *  HAL_TIMEOUT - sensor is not turned on
 *  HAL_ERROR - error
 */
HAL_StatusTypeDef bar_ils22qs_Read(I2C_HandleTypeDef *hi2c);
 
/**
 * @brief log data to buffer
 */
void bar_ils22qs_LogData(char* buf);
 
#endif
 
#endif /* INC_BAR_ILS22QS_H_ */