mysensors.h

Go to the documentation of this file.

/*
 * mysensors.h
 *
 *  Created on: 6. 1. 2026
 *      Author: Milan
 *
 * helpers for standard HAL fncs
 * The sensors reading data.
 */
 
#ifndef INC_MYSENSORS_H_
#define INC_MYSENSORS_H_
 
#include "stm32wlxx_hal.h"
#include "mymems.h"
 
/**
 * @brief State machine states for the sensor reading process.
 *
 * The state machine is driven either by the sequencer (timer-based) or
 * by direct polling via sensors_Start() / sensors_Work().  It progresses
 * sequentially through the states; completion is signalled when SENS_DONE
 * is returned.
 */
typedef enum
{
    SENS_BEGIN = 0, /**< Entry state: I2C is initialised and the sequence is prepared */
    SENS_INIT,      /**< Sensor initialisation: each active sensor is (re-)initialised if not already */
    SENS_START,     /**< Sensors powered on (xxx_On() called for the current group) */
    SENS_READ,      /**< Data read issued (xxx_Read() called for the current group) */
    SENS_STOP,      /**< Sensors powered off (xxx_Off() called for the current group) */
    SENS_DATAREADY, /**< All sensor data collected; ready for post-processing or LoRa uplink */
    SENS_SERVICE,   /**< Service actions executed (e.g. SPS30 fan cleaning); data may be unavailable */
    SENS_END,       /**< Sequence complete: I2C is de-initialised for power saving */
    SENS_DONE       /**< Final state: caller may read sensor data and schedule the next cycle */
} sens_ProcessDef_t;
 
 
/**
 * @brief Initialization of all sensors, must be called before for store of hi2c handler
 * @param hi2c
 */
void sensors_Init(I2C_HandleTypeDef* hi2c);
 
/**
 * @brief the sensors sequencer initialization and set the process in sequencer
 * - create task
 * - create timer
 * - process data
 * - fire event CFG_SEQ_Task_MyLoraSend - data are ready for loraWan processing
 
 * @param sensortAppBit - bit for task
 * @param mylorawanAppBit - bit for event firing
 */
void sensorsSeq_Init(uint32_t sensortAppBit, uint32_t mylorawanAppBit);
 
/**
 * @brief The copying data from current sensors buffer to backUp - _bck_XXXXX
 */
void sensors_CopyToBck();
 
/**
 * @brief collecting sensor data into CayenneLppGetBuffer buffer for sending them via LoRaWan, the methods works with _bck_XXXXX sensor data, not with real. \n
 * The measure time is added only if time distance is bigger than 1min:
 * @par
 * - UNIX - absolute time, if distance between times is bigger than 65353 minutes(45.5days), CayenneLppAddTimeMeasureABS
 * @par
 * - relative, minutes 16 - max 65535 is distance is bigger than 255 minutes (4.25h), CayenneLppAddTimeMeasureMIN16
 * @par
 * - relative, minute 8 - max 255, if distance between measured data is less than 255 minutes, CayenneLppAddTimeMeasureMIN16
 *
 * @param sizeOut - the size(bytes) in buffer, the size is max 254, uint8_t is enough
 * @param prevMeasureTime the previous measure time, 0 or NULL - is not specified, no time is added
 * @return address of buffer or null, if no data
 */
uint8_t * sensors_CayennelFromBckData(uint8_t *sizeOut, SysTime_t* prevMeasureTime);
 
/**
 * @brief filling the data block from sensor data - store to memory
 * the methods works with _bck_XXXXX senzor, not with real
 * at the begin is writte the timeout of sensor measuring in minutes * 100
 */
void sensors_WriteFromBckToDataBlock(mems_DataBlock_t *data);
 
/**
 * @brief reading from memory block and filling specified sensor from memory - ready for  sensors_CayennelData
 * the methods works with _bck_XXXXX senzor, not with real
 * @retval size of total read from data block, 0 - if is other than expected data
 */
uint8_t sensors_ReadToBckFromDataBlock(const mems_DataBlock_t *data);
 
/**
 * @brief getting the SysTime_t from block data of memory
 * @retval the time of measure - UNIX time
 */
SysTime_t sensors_GetTimeFromBlock(const mems_DataBlock_t *data);
 
 
/**
 * @brief stop and start of sensor timer for next measure
 */
void sensors_Retiming();
 
/**
 * @brief possible to I2C turn on/off - cumulative
 */
void i2c_OnOff(uint8_t onOff);
 
 
/*
 * for non sequencer ....
 * sensors_Start();
 * if (sensors_Read() == SENS_DONE)
 *   ; finished
 *
 */
 
/**
 * @brief - non squncer processing
 * start of reading - prepare of internal state machine
 */
void sensors_Start();
 
/**
 * @brief - no sequncer processing
 * reading data from sensor according to group specification
 * @return SENS_DONE - process of reading finished, otherwise current state of status machine
 */
sens_ProcessDef_t sensors_Work();
 
 
#endif /* INC_MYSENSORS_H_ */