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.
Sensors/LightSensor.h
- Committer:
- davide.aliprandi@st.com
- Date:
- 2017-03-10
- Revision:
- 3:b1bb477e115e
- Parent:
- 2:e2bf4d06a8fc
- Child:
- 4:8f70f7159316
File content as of revision 3:b1bb477e115e:
/** ****************************************************************************** * @file LightSensor.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 an ambient light sensor (ALS) ****************************************************************************** * @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 __LIGHT_SENSOR_CLASS_H #define __LIGHT_SENSOR_CLASS_H /* Includes ------------------------------------------------------------------*/ #include <Component.h> /* Classes ------------------------------------------------------------------*/ /** * An abstract class for ambient light sensors */ class LightSensor : public Component { public: /** * @brief Get current light [lux] * @param[out] piData Pointer to where to store light to * @return 0 in case of success, an error code otherwise */ virtual int get_lux(uint32_t *piData) = 0; /** * @brief Destructor. */ virtual ~LightSensor() {}; }; #endif /* __LIGHT_SENSOR_CLASS_H */