Kenji Arai / 6180XA1_simple

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Check_VL6180XA1_ToF

Fork of X_NUCLEO_6180XA1 by ST

Component.h@59:81afbb75311d, 2018-01-28 (annotated)

Committer:
kenjiArai
Date:
Sun Jan 28 02:07:05 2018 +0000
Revision:
59:81afbb75311d
use VL6180XA1 chip wothout  X-NUCLEO-6180XA1 Board. Simple way to use the chip.

Who changed what in which revision?

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