ST / ST_INTERFACES

Official interfaces for ST components.

Dependents:   X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more

Fork of ST_INTERFACES by Davide Aliprandi

This library contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.

Common/ComponentObject.h@1:a7810e7acf8d, 2016-09-27 (annotated)

Committer:
Davidroid
Date:
Tue Sep 27 11:28:52 2016 +0000
Revision:
1:a7810e7acf8d
LightSensor, RangeSensor, Nfc interfaces added.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Davidroid 1:a7810e7acf8d 1 /**
Davidroid 1:a7810e7acf8d 2 ******************************************************************************
Davidroid 1:a7810e7acf8d 3 * @file ComponentObject.h
Davidroid 1:a7810e7acf8d 4 * @author AST
Davidroid 1:a7810e7acf8d 5 * @version V1.0.0
Davidroid 1:a7810e7acf8d 6 * @date April 13th, 2015
Davidroid 1:a7810e7acf8d 7 * @brief This file contains the abstract class describing the interface of a
Davidroid 1:a7810e7acf8d 8 * generic component.
Davidroid 1:a7810e7acf8d 9 ******************************************************************************
Davidroid 1:a7810e7acf8d 10 * @attention
Davidroid 1:a7810e7acf8d 11 *
Davidroid 1:a7810e7acf8d 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Davidroid 1:a7810e7acf8d 13 *
Davidroid 1:a7810e7acf8d 14 * Redistribution and use in source and binary forms, with or without modification,
Davidroid 1:a7810e7acf8d 15 * are permitted provided that the following conditions are met:
Davidroid 1:a7810e7acf8d 16 * 1. Redistributions of source code must retain the above copyright notice,
Davidroid 1:a7810e7acf8d 17 * this list of conditions and the following disclaimer.
Davidroid 1:a7810e7acf8d 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Davidroid 1:a7810e7acf8d 19 * this list of conditions and the following disclaimer in the documentation
Davidroid 1:a7810e7acf8d 20 * and/or other materials provided with the distribution.
Davidroid 1:a7810e7acf8d 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Davidroid 1:a7810e7acf8d 22 * may be used to endorse or promote products derived from this software
Davidroid 1:a7810e7acf8d 23 * without specific prior written permission.
Davidroid 1:a7810e7acf8d 24 *
Davidroid 1:a7810e7acf8d 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Davidroid 1:a7810e7acf8d 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Davidroid 1:a7810e7acf8d 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Davidroid 1:a7810e7acf8d 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Davidroid 1:a7810e7acf8d 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Davidroid 1:a7810e7acf8d 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Davidroid 1:a7810e7acf8d 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Davidroid 1:a7810e7acf8d 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Davidroid 1:a7810e7acf8d 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Davidroid 1:a7810e7acf8d 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Davidroid 1:a7810e7acf8d 35 *
Davidroid 1:a7810e7acf8d 36 ******************************************************************************
Davidroid 1:a7810e7acf8d 37 */
Davidroid 1:a7810e7acf8d 38
Davidroid 1:a7810e7acf8d 39
Davidroid 1:a7810e7acf8d 40 /* Define to prevent recursive inclusion -------------------------------------*/
Davidroid 1:a7810e7acf8d 41
Davidroid 1:a7810e7acf8d 42 #ifndef __COMPONENT_OBJECT_CLASS_H
Davidroid 1:a7810e7acf8d 43 #define __COMPONENT_OBJECT_CLASS_H
Davidroid 1:a7810e7acf8d 44
Davidroid 1:a7810e7acf8d 45
Davidroid 1:a7810e7acf8d 46 /* Includes ------------------------------------------------------------------*/
Davidroid 1:a7810e7acf8d 47
Davidroid 1:a7810e7acf8d 48 #include <stdint.h>
Davidroid 1:a7810e7acf8d 49
Davidroid 1:a7810e7acf8d 50
Davidroid 1:a7810e7acf8d 51 /* Classes ------------------------------------------------------------------*/
Davidroid 1:a7810e7acf8d 52
Davidroid 1:a7810e7acf8d 53 /** An abstract class for Generic components.
Davidroid 1:a7810e7acf8d 54 */
Davidroid 1:a7810e7acf8d 55 class ComponentObject
Davidroid 1:a7810e7acf8d 56 {
Davidroid 1:a7810e7acf8d 57 public:
Davidroid 1:a7810e7acf8d 58 /**
Davidroid 1:a7810e7acf8d 59 * @brief Initializing the component.
Davidroid 1:a7810e7acf8d 60 * @param[in] init pointer to device specific initalization structure.
Davidroid 1:a7810e7acf8d 61 * @retval "0" in case of success, an error code otherwise.
Davidroid 1:a7810e7acf8d 62 */
Davidroid 1:a7810e7acf8d 63 virtual int Init(void *init) = 0;
Davidroid 1:a7810e7acf8d 64
Davidroid 1:a7810e7acf8d 65 /**
Davidroid 1:a7810e7acf8d 66 * @brief Getting the ID of the component.
Davidroid 1:a7810e7acf8d 67 * @param[out] id pointer to an allocated variable to store the ID into.
Davidroid 1:a7810e7acf8d 68 * @retval "0" in case of success, an error code otherwise.
Davidroid 1:a7810e7acf8d 69 */
Davidroid 1:a7810e7acf8d 70 virtual int ReadID(uint8_t *id) = 0;
Davidroid 1:a7810e7acf8d 71 };
Davidroid 1:a7810e7acf8d 72
Davidroid 1:a7810e7acf8d 73 #endif /* __COMPONENT_OBJECT_CLASS_H */
Davidroid 1:a7810e7acf8d 74
Davidroid 1:a7810e7acf8d 75 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/