added doxygen documentation

This commit is contained in:
2023-03-25 13:15:31 +01:00
parent 745d2a79a7
commit 054b9bfb8b
2 changed files with 79 additions and 22 deletions

View File

@ -1,19 +1,29 @@
/*
* HTPA_32x32d.h
*
* Created on: Mar 24, 2023
* Author: Getac
/**
* @file HTPA_32x32d.h
* @brief Header for HTPA 32x32d infrared array sensor library
* @author Tim-Erik Düntzsch t.duentzsch@fasttube.de
*
* @date 25.03.2023 - first implementation (untested)
*
* @todo finish HTPA_ReadBlock function
* @todo add calibration function
* @todo add temperature conversion function
*
* @test communication and readout
*
* @version 0.1
*/
#ifndef INC_HTPA_32X32D_H_
#define INC_HTPA_32X32D_H_
/// @brief HTPA status register struct
typedef struct {
uint8_t block;
uint8_t vdd_meas;
uint8_t blind;
uint8_t eoc;
}HTPA_Status;
uint8_t block; // currently selected block
bool vdd_meas; // selection whether first two bytes are VDD or PTA
bool blind;
bool eoc; // end of conversion flag
} HTPA_Status;
void HTPA_Init(I2C_HandleTypeDef *);