Added header comments in both files as well as clarified the temperature unit

This commit is contained in:
anschrammh 2025-04-29 07:07:45 +02:00
parent 4fd86d28ff
commit fe40710b7e
2 changed files with 21 additions and 1 deletions

View File

@ -1,3 +1,13 @@
/**
* @file BMP280.c
* @author Anatole SCHRAMM-HENRY
* @brief BMP280 pressure and temperature bosch sensor functions implementation source file.
* @version 0.1
* @date 2025-04-29
*
* @copyright MIT
*/
#include <math.h> #include <math.h>
#include "i2c.h" #include "i2c.h"
#include "BMP280.h" #include "BMP280.h"

View File

@ -1,3 +1,13 @@
/**
* @file BMP280.h
* @author Anatole SCHRAMM-HENRY
* @brief BMP280 pressure and temperature bosch sensor functions API header file.
* @version 0.1
* @date 2025-04-29
*
* @copyright MIT
*/
#ifndef BMP280_H #ifndef BMP280_H
#define BMP280_H #define BMP280_H
@ -92,7 +102,7 @@ float BMP280_get_temperature(void);
/** /**
* @brief Returns the previously sampled pressure in Pa. * @brief Returns the previously sampled pressure in Pa.
* *
* @param temperature the address of a float which will contain the measured temperature. If not needed, can be NULL. * @param temperature the address of a float which will contain the measured temperature in °C. If not needed, can be NULL.
* @return float the value of the pressure in Pa * @return float the value of the pressure in Pa
*/ */
float BMP280_get_pressure(float * const temperature); float BMP280_get_pressure(float * const temperature);