Ted Grosch / Mbed 2 deprecated Nucleo_TOF_I2C_DISCO

Export to MBED Studio for DISCO Board

Dependencies:   mbed

environmentControl.h@3:4e641a32e087, 2020-10-25 (annotated)

Committer:
tgrosch
Date:
Sun Oct 25 10:43:09 2020 +0000
Revision:
3:4e641a32e087
Parent:
0:62b846b3988a 
New Version with OS5

Who changed what in which revision?

UserRevisionLine numberNew contents of line
tgrosch 0:62b846b3988a 1 /*!
tgrosch 0:62b846b3988a 2 * \file environmentControl.h
tgrosch 0:62b846b3988a 3 * \author Karthik Rajagopal <krthik@ti.com>
tgrosch 0:62b846b3988a 4 * \version 0.9.1
tgrosch 0:62b846b3988a 5 *
tgrosch 0:62b846b3988a 6 * \section COPYRIGHT
tgrosch 0:62b846b3988a 7 * TEXAS INSTRUMENTS TEXT FILE LICENSE
tgrosch 0:62b846b3988a 8 * Copyright (c) 2018 Texas Instruments Incorporated
tgrosch 0:62b846b3988a 9 * All rights reserved not granted herein.
tgrosch 0:62b846b3988a 10 * Limited License.
tgrosch 0:62b846b3988a 11 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive license under copyrights and patents it now or hereafter owns or controls to make, have made, use, import, offer to sell and sell ("Utilize") this software subject to the terms herein. With respect to the foregoing patent license, such license is granted solely to the extent that any such patent is necessary to Utilize the software alone. The patent license shall not apply to any combinations which include this software, other than combinations with devices manufactured by or for TI ("TI Devices"). No hardware patent is licensed hereunder.
tgrosch 0:62b846b3988a 12 * Redistributions must preserve existing copyright notices and reproduce this license (including the above copyright notice and the disclaimer and (if applicable) source code license limitations below) in the documentation and/or other materials provided with the distribution
tgrosch 0:62b846b3988a 13 * Redistribution and use in binary form, without modification, are permitted provided that the following conditions are met:
tgrosch 0:62b846b3988a 14 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any software provided in binary form.
tgrosch 0:62b846b3988a 15 * * any redistribution and use are licensed by TI for use only with TI Devices.
tgrosch 0:62b846b3988a 16 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
tgrosch 0:62b846b3988a 17 * If software source code is provided to you, modification and redistribution of the source code are permitted provided that the following conditions are met:
tgrosch 0:62b846b3988a 18 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by TI for use only with TI Devices.
tgrosch 0:62b846b3988a 19 * * any redistribution and use of any object code compiled from the source code and any resulting derivative works, are licensed by TI for use only with TI Devices.
tgrosch 0:62b846b3988a 20 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or promote products derived from this software without specific prior written permission.
tgrosch 0:62b846b3988a 21 * DISCLAIMER.
tgrosch 0:62b846b3988a 22 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "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 TI AND TI'S LICENSORS 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.
tgrosch 0:62b846b3988a 23 *
tgrosch 0:62b846b3988a 24 * \section DESCRIPTION
tgrosch 0:62b846b3988a 25 * The file contains class descriptions and methods for environment control
tgrosch 0:62b846b3988a 26 */
tgrosch 0:62b846b3988a 27
tgrosch 0:62b846b3988a 28 #ifndef ENVIRONMENTCONTROL_H_
tgrosch 0:62b846b3988a 29 #define ENVIRONMENTCONTROL_H_
tgrosch 0:62b846b3988a 30
tgrosch 0:62b846b3988a 31 #include <stdint.h>
tgrosch 0:62b846b3988a 32
tgrosch 0:62b846b3988a 33 /*! \class environmentalController
tgrosch 0:62b846b3988a 34 \brief Generic implementation for environment controller
tgrosch 0:62b846b3988a 35
tgrosch 0:62b846b3988a 36 As part of OPT3101SDK there are several environment specific functions that need to be performed. Examples of such functions are setting up targets at particular distance, setting up chamber temperature.
tgrosch 0:62b846b3988a 37 These are essential functions to perform the calibration of OPT3101 based system. The setting up of these environment conditions have to be done at specific steps during calibration.
tgrosch 0:62b846b3988a 38 The template class environmentalController makes this process simple and scalable. Appropriate methods of this class are called at relevant steps in calibration.
tgrosch 0:62b846b3988a 39 Users using this SDK are expected to implement these functions based on the environment setup. <br><br>
tgrosch 0:62b846b3988a 40 The names of the methods reflect the conditions for the environment. For eg: environmentalController::setTargetToInfinity_OR_coverPhotodiode method as the name suggest is a condition
tgrosch 0:62b846b3988a 41 where the OPT3101 system needs to be pointed to infinity (far away from detectable range of system) or the photo diode needs to be covered so no light leaks directly between the transmitter(s) and photo diode.
tgrosch 0:62b846b3988a 42 These implementations are very specific to the host on which the SDK is ported and run. <br>
tgrosch 0:62b846b3988a 43 This abstract class provides a template with self explanatory method names which the users can override and implement their own functions. <br>
tgrosch 0:62b846b3988a 44 */
tgrosch 0:62b846b3988a 45 class environmentalController {
tgrosch 0:62b846b3988a 46 public:
tgrosch 0:62b846b3988a 47 uint16_t refDistancesInMM[3][2]; ///< Reference distance list to be used for phase offset calibration
tgrosch 0:62b846b3988a 48 /*!
tgrosch 0:62b846b3988a 49 * \brief Constructor to initialize variables to 0
tgrosch 0:62b846b3988a 50 *
tgrosch 0:62b846b3988a 51 * \return Nothing
tgrosch 0:62b846b3988a 52 */
tgrosch 0:62b846b3988a 53 environmentalController();
tgrosch 0:62b846b3988a 54 /*!
tgrosch 0:62b846b3988a 55 * \brief Sets target distance
tgrosch 0:62b846b3988a 56 *
tgrosch 0:62b846b3988a 57 * \param[in] targetDistanceInMM; targetDistanceInMM is the known distance where the target needs to be placed. This is expressed in mm
tgrosch 0:62b846b3988a 58 * \return Nothing
tgrosch 0:62b846b3988a 59 */
tgrosch 0:62b846b3988a 60 void setTargetDistance(uint16_t targetDistanceInMM);
tgrosch 0:62b846b3988a 61 /*!
tgrosch 0:62b846b3988a 62 * \brief Sets chamber temperature
tgrosch 0:62b846b3988a 63 *
tgrosch 0:62b846b3988a 64 * \param[in] chamberTemperatureInC; chamberTemperatureInC is the known temperature the chamber needs to be set to and settled. This is critical for temperature related calibration steps
tgrosch 0:62b846b3988a 65 * \return Nothing
tgrosch 0:62b846b3988a 66 */
tgrosch 0:62b846b3988a 67 void setChamberTemperature(int8_t chamberTemperatureInC);
tgrosch 0:62b846b3988a 68 /*!
tgrosch 0:62b846b3988a 69 * \brief Sets ambient light condition
tgrosch 0:62b846b3988a 70 *
tgrosch 0:62b846b3988a 71 * \param[in] ambientLightInLux; ambientLightInLux is the intensity (in lux) of ambient light to be applied to the system to perform OPT3101::phaseAmbientCoffC measurements
tgrosch 0:62b846b3988a 72 * \return Nothing
tgrosch 0:62b846b3988a 73 */
tgrosch 0:62b846b3988a 74 void setAmbientLight(uint32_t ambientLightInLux);
tgrosch 0:62b846b3988a 75 /*!
tgrosch 0:62b846b3988a 76 * \brief Sets target such that the amplitude of system is very low
tgrosch 0:62b846b3988a 77 * This is a crucial step to determine OPT3101::crosstalkC values for the OPT3101 system. The environmentController is expected to target in such a way that the amplitude of the system reads
tgrosch 0:62b846b3988a 78 * a low enough value that this can be ignored as crosstalk value. Either setting target to far enough position (or low enough reflectivity) or covering the photo diode would help achieve this
tgrosch 0:62b846b3988a 79 * \return Nothing
tgrosch 0:62b846b3988a 80 */
tgrosch 0:62b846b3988a 81 void setTargetToInfinity_OR_coverPhotodiode();
tgrosch 0:62b846b3988a 82 /*!
tgrosch 0:62b846b3988a 83 * \brief A method used to determine the reference distances to be used for phase offset calibration
tgrosch 0:62b846b3988a 84 * \return Nothing
tgrosch 0:62b846b3988a 85 */
tgrosch 0:62b846b3988a 86 void manuallySetReferenceDistances();
tgrosch 0:62b846b3988a 87 };
tgrosch 0:62b846b3988a 88
tgrosch 0:62b846b3988a 89 #endif /* ENVIRONMENTCONTROL_H_ */
tgrosch 0:62b846b3988a 90