FaSTTUBe/TTS
51
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added doxygen documentation

Browse Source
This commit is contained in:
Tim-Erik Düntzsch
2023-03-25 13:15:31 +01:00
parent 745d2a79a7
commit 054b9bfb8b
2 changed files with 79 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
Core/Src/HTPA_32x32d.c
View File

@ -1,14 +1,24 @@
/*
* HTPA_32x32d.c
*
* Created on: Mar 24, 2023
* Author: Getac
/**
* @file HTPA_32x32d.c
* @brief Library for HTPA 32x32d infrared array sensor
* @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
*/
#include <stdbool.h>
#include "main.h"
#include "HTPA_32x32d.h"
// I2C adress
// I2C address
#define HTPA_SENSOR_ADDRESS 0x1A
#define HTPA_EEPROM_ADDRESS 0x50
@ -21,7 +31,7 @@
#define HTPA_SENSOR_TRIM_5 0x07 // Common mode voltage preamplifier top
#define HTPA_SENSOR_TRIM_6 0x08 // Common mode voltage preamplifier bot
#define HTPA_SENSOR_TRIM_7 0x09 // Interal pull-ups SDA, SCL
// Sensor read only
// Sensor read only registers
#define HTPA_SENSOR_STATUS 0x02 // Status register
#define HTPA_SENSOR_READTOP 0x0A // Read top half
#define HTPA_SENSOR_READBOT 0x0B // Read bot half
@ -33,7 +43,15 @@ HAL_StatusTypeDef i2c_return; // error handling maybe?
uint16_t blockData[128];
/**
* @brief Initialization of HTPA Sensor
*
* Sets the wakeup bit in the status register and writes the desired sensor
* configuration to the respective registers.
* Afterwards the sensor is in idle and ready for conversion.
*
* @param *hi2c: Pointer to I2C Handle
*/
void HTPA_Init(I2C_HandleTypeDef *hi2c){
i2c_handle = *hi2c;
// Berechnung für clk / sample aus I2C parametern?
@ -47,29 +65,58 @@ void HTPA_Init(I2C_HandleTypeDef *hi2c){
HTPA_WriteRegister(HTPA_SENSOR_TRIM_7, 0x88);
}
/**
* @brief Read data of one block in one array half
*
* Block selection gets written to the config register and conversion is started.
* After selected block of upper and lower half are converted, the selected half
* is read and the data stored in the passed array.
*
* @param array_half: select top or bottom half of array
* @param block: select block of array half (0-3)
* @param *pData[128]: pointer to 128 word array for read data
*/
void HTPA_ReadBlock(uint8_t array_half, uint8_t block, uint16_t *pData[128]){
uint8_t config = (block << 4); // bit 5,4 block
uint8_t config = 0;
config = (block << 4); // bit 5,4 block
config |= 0x09; // bit 3 start | bit 1 wakeup
HTPA_WriteRegister(HTPA_SENSOR_CONFIG, config);
// tbc
}
/**
* @brief Write to selected sensor register
*
* description
*
* @param register_address: address of register
* @param byte: byte to be written to register
*/
void HTPA_WriteRegister(uint8_t register_address, uint8_t byte){
uint8_t i2c_data = register_address;
uint8_t i2c_address = (HTPA_SENSOR_ADDRESS << 1);
i2c_address |= 0x00; // set read/write bit to write (0)
i2c_address &= 0xFE; // set read/write bit to write (0)
HAL_I2C_Master_Transmit(&i2c_handle, i2c_address, &i2c_data, 1, I2C_MAX_DELAY);
i2c_data = byte;
HAL_I2C_Master_Transmit(&i2c_handle, i2c_address, &i2c_data, 1, I2C_MAX_DELAY);
}
/**
* @brief Get status of sensor
*
* Reads the sensors status register and stores the information in
* the HTPA_Statsu structure.
*
* @return HTPA_Status: status register struct
*/
HTPA_Status HTPA_GetStatus(void){
HTPA_Status status_return;
uint8_t i2c_data = HTPA_SENSOR_STATUS;
uint8_t i2c_address = (HTPA_SENSOR_ADDRESS << 1);
uint8_t i2c_readData = 0;
i2c_address |= 0x00; // set read/write bit to write (0)
i2c_address &= 0xFE; // set read/write bit 0 to write (0)
HAL_I2C_Master_Transmit(&i2c_handle, i2c_address, &i2c_data, 1, I2C_MAX_DELAY);
i2c_address |= 0x01; // set read/write bit to read (1)
i2c_address |= 0x01; // set read/write bit 0 to read (1)
HAL_I2C_Master_Receive(&i2c_handle, i2c_address, &i2c_readData, 1, I2C_MAX_DELAY);
status_return.block = (i2c_readData >> 4) && 0xFC;
status_return.vdd_meas = (i2c_readData >> 2) && 0xFE;