Official interfaces for ST components.
Dependents: X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more
Fork of ST_INTERFACES by
This library contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.
Diff: Sensors/TempSensor.h
- Revision:
- 0:f6dd8f22f875
- Child:
- 1:a7810e7acf8d
diff -r 000000000000 -r f6dd8f22f875 Sensors/TempSensor.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Sensors/TempSensor.h Mon Aug 01 15:06:25 2016 +0000 @@ -0,0 +1,76 @@ +/** + ****************************************************************************** + * @file TempSensor.h + * @author AST / EST + * @version V0.0.1 + * @date 13-April-2015 + * @brief This file contains the abstract class describing in general + * the interfaces of a temperature sensor + ****************************************************************************** + * @attention + * + * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of STMicroelectronics nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************** + */ + +/* Define to prevent from recursive inclusion --------------------------------*/ +#ifndef __TEMP_SENSOR_CLASS_H +#define __TEMP_SENSOR_CLASS_H + +/* Includes ------------------------------------------------------------------*/ +#include <Component_class.h> + +/* Classes ------------------------------------------------------------------*/ +/** An abstract class for Temperature sensors + */ +class TempSensor : public Component +{ + public: + /** + * @brief Get current temperature in degrees Celsius [°C] + * @param[out] pfData Pointer to where to store temperature to + * @return 0 in case of success, an error code otherwise + */ + virtual int GetTemperature(float *pfData) = 0; + + /** + * @brief Get current temperature in degrees Fahrenheit [°F] + * @param[out] pfData Pointer to where to store temperature to + * @return 0 in case of success, an error code otherwise + */ + virtual int GetFahrenheit(float *pfData) { + float celsius; + int ret; + + ret = GetTemperature(&celsius); + if(ret) return ret; + + *pfData = ((celsius * 1.8f) + 32.0f); + return 0; + } +}; + +#endif /* __TEMP_SENSOR_CLASS_H */