X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fdrv%2Fmpxx6115a.h;h=aa5a682d2575f79a81a20963415bcd06922bd301;hb=e8b0472be10fba4ca6baa62d8d483db90e28c06e;hp=9e3178a2190e680afd50ce05fcc16c5359a8916b;hpb=417b8fedf88928360b27cae2d72c036b5bdec9f1;p=bertos.git diff --git a/bertos/drv/mpxx6115a.h b/bertos/drv/mpxx6115a.h index 9e3178a2..aa5a682d 100644 --- a/bertos/drv/mpxx6115a.h +++ b/bertos/drv/mpxx6115a.h @@ -30,32 +30,41 @@ * * --> * - * \brief Covert read voltage from MPXX6115A Pressure Sensor in hPascal value. + * \brief MPXX6115A Pressure Sensor convert formula. + * + * This module convert read voltage value from MPXX6115A + * pressure sensor into hPascal value unit. * * \author Daniele Basile * + * $WIZ$ module_name = "mpxx6115a" + * $WIZ$ module_depends = "adc" + * $WIZ$ module_configuration = "" + * $WIZ$ module_hw = "" */ #ifndef DRV_MPXX6115A_H #define DRV_MPXX6115A_H +#include + #define MPXX6115A_DIV_CONST 0.009f #define MPXX6115A_ADD_CONST 0.095f /** - * Covert read voltage from MPXX6115A Pressure Sensor in hPascal value. + * Convert read voltage from MPXX6115A Pressure Sensor in hPascal value. * - * The convertion formula may be consulted on costructor datasheet + * The conversion formula may be consulted on constructor datasheet * (see Freescale Semiconductor MP3H6115A, MPXAZ6115A). * * \param vout output voltage read from pin sensor. * \param vref reference voltage that supplies the MPXX6115A sensor. * - * \return interger value that represent measured pressure in hPascal. + * \return integer value that represent measured pressure in hPascal. * * \note: To compute the pressure we use the Vout/Vref ratio, so - * these two values can be expressed in any unit, even adc levels. + * these two values can be expressed in any unit, even ADC levels. * */ INLINE int16_t mpxx6115a_press(adcread_t vout, adcread_t vref)