Added missing units in BMP280 pressure sensor function documentation

This commit is contained in:
anschrammh 2024-07-31 16:00:55 +02:00
parent aba91095e9
commit 58955ee365

View File

@ -98,11 +98,11 @@ float BMP280_get_temperature(void);
float BMP280_get_pressure(float * const temperature);
/**
* @brief Returns an approximation of the altitude using the measured atmospheric pressure.
* @brief Returns an approximation of the altitude in meters using the measured atmospheric pressure.
*
* @param pressureAtSeeLevel the current atmospheric pressure at see level in hPa. Can be 0 if unknown and a default value of 1013.25 hPa will be used.
* @param pressure the address of a float which will contain the measured pressure. If not needed, can be NULL.
* @param temperature the address of a float which will contain the measured temperature. If not needed, can be NULL.
* @param pressure the address of a float which will contain the measured pressure in Pa. 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 altitude in meters
*/
float BMP280_get_altitude(float pressureAtSeeLevel, float * const pressure, float * const temperature);