Ted Grosch / Mbed 2 deprecated Nucleo_TOF_I2C

Export to MBED Studio

Dependencies:   mbed

OPT3101Calibration.h@1:8567a29d4699, 2020-10-25 (annotated)

Committer:
tgrosch
Date:
Sun Oct 25 01:51:13 2020 +0000
Revision:
1:8567a29d4699
Parent:
0:62b846b3988a 
Transfer to MBED Studio

Who changed what in which revision?

UserRevisionLine numberNew contents of line
tgrosch 0:62b846b3988a 1 /*!
tgrosch 0:62b846b3988a 2 * \file OPT3101Calibration.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 * This file contains the OPT3101::calibrationC class declaration
tgrosch 0:62b846b3988a 26 */
tgrosch 0:62b846b3988a 27
tgrosch 0:62b846b3988a 28 #ifndef OPT3101CALIBRATION_H_
tgrosch 0:62b846b3988a 29 #define OPT3101CALIBRATION_H_
tgrosch 0:62b846b3988a 30
tgrosch 0:62b846b3988a 31 #include <cmath>
tgrosch 0:62b846b3988a 32 #include "OPT3101DesignCoefficients.h"
tgrosch 0:62b846b3988a 33 #include "OPT3101frameData.h"
tgrosch 0:62b846b3988a 34 #include "OPT3101PhaseOffset.h"
tgrosch 0:62b846b3988a 35 #include "environmentControl.h"
tgrosch 0:62b846b3988a 36
tgrosch 0:62b846b3988a 37 #ifdef OPT3101_USE_STREAMLIB
tgrosch 0:62b846b3988a 38 #include <fstream>
tgrosch 0:62b846b3988a 39 #include <iostream>
tgrosch 0:62b846b3988a 40 #include <istream>
tgrosch 0:62b846b3988a 41 #include <string>
tgrosch 0:62b846b3988a 42 #endif
tgrosch 0:62b846b3988a 43
tgrosch 0:62b846b3988a 44 /** \brief environmentalController class instance declaration
tgrosch 0:62b846b3988a 45 This global variable declaration to be available across files which controls the environmental parameters. The instance is of class environmentalController
tgrosch 0:62b846b3988a 46 */
tgrosch 0:62b846b3988a 47 extern environmentalController envController;
tgrosch 0:62b846b3988a 48
tgrosch 0:62b846b3988a 49 namespace OPT3101 {
tgrosch 0:62b846b3988a 50 /**
tgrosch 0:62b846b3988a 51 OPT3101 systems require various calibrations for accurate measurement. During the calibration process there are several coefficients which needs to be measured and analyzed.
tgrosch 0:62b846b3988a 52 Although the calibration settings can be stored as register settings, they would not be very meaning full to understand and analyze.
tgrosch 0:62b846b3988a 53 This class acts as an intermediate translator to measure, store and calibration values. The class also invokes methods to convert the calibration coefficients to register settings to load to the device.
tgrosch 0:62b846b3988a 54 There are several members of this class where more than 1 instances of those members are required. The class only contain pointers for these coefficient classes.
tgrosch 0:62b846b3988a 55 The constructor definition of this class is generated by OPT3101 configurator tool. The file generated by the tool can be directly imported to this project for a complete operation SDK.
tgrosch 0:62b846b3988a 56 */
tgrosch 0:62b846b3988a 57 class calibrationC {
tgrosch 0:62b846b3988a 58 public:
tgrosch 0:62b846b3988a 59 crosstalkC internalCrosstalk[1]; ///< Pointer to analyze and store internal crosstalk class OPT3101::crosstalkC
tgrosch 0:62b846b3988a 60 crosstalkC illumCrosstalk[3][2]; ///< Pointer to analyze and store illumination crosstalk class OPT3101::crosstalkC
tgrosch 0:62b846b3988a 61 phaseOffsetC phaseOffset[3][2]; ///< Pointer to analyze and store phase offset class OPT3101::phaseOffsetC
tgrosch 0:62b846b3988a 62 crosstalkTempCoffC illumCrosstalkTempCoff[3][2]; ///< Pointer to analyze and store crosstalk temperature coefficients OPT3101::crosstalkTempCoffC
tgrosch 0:62b846b3988a 63 phaseTempCoffC phaseTempCoff[3][2]; ///< Pointer to analyze and store phase temperature coefficients OPT3101::phaseTempCoffC
tgrosch 0:62b846b3988a 64 phaseAmbientCoffC phaseAmbientCoff[1]; ///< Pointer to analyze and store phase ambient coefficients OPT3101::phaseAmbientCoffC
tgrosch 0:62b846b3988a 65 uint8_t registerAddressList[64]; ///< List of OPT3101::registers address which needs to be stored as calibration for the system.
tgrosch 0:62b846b3988a 66 uint8_t registerAddressListSize; ///< Number of OPT3101::registers address that need to be stores as calibration for the system
tgrosch 0:62b846b3988a 67 bool EEPROM_connected; ///< Flag to specify if EEPROM is connected to the OPT3101 device
tgrosch 0:62b846b3988a 68 bool extTempSensor_connected; ///< Flag to specify if external temperature sensor is connected to the OPT3101 device
tgrosch 0:62b846b3988a 69 uint8_t recordLength; ///< Specifies the length of records to be stored for calibration configurations. This is set be OPT3101 configurator tool.
tgrosch 0:62b846b3988a 70 /*!
tgrosch 0:62b846b3988a 71 * \brief Dummy function for documentation
tgrosch 0:62b846b3988a 72 * This function is to just document the functionality of the constructor
tgrosch 0:62b846b3988a 73 * \returns Nothing;
tgrosch 0:62b846b3988a 74 */
tgrosch 0:62b846b3988a 75 calibrationC(bool dummyFlag);
tgrosch 0:62b846b3988a 76 /*!
tgrosch 0:62b846b3988a 77 * \brief Constructor for class OPT3101::calibrationC
tgrosch 0:62b846b3988a 78 * Constructor definition for which comes from the OPT3101 configurator tool. Allocates memory for all the calibration coefficient classes.
tgrosch 0:62b846b3988a 79 * Since the actual allocation depends on the configuration of the system, this is generated by the configurator tool.
tgrosch 0:62b846b3988a 80 */
tgrosch 0:62b846b3988a 81 calibrationC();
tgrosch 0:62b846b3988a 82 /*!
tgrosch 0:62b846b3988a 83 * \brief Finds common crosstalk scale coff to be applied
tgrosch 0:62b846b3988a 84 * OPT3101 system could consist of multiple TX configuration operating together, switching between each other configurations. In such cases more than 1 illum crosstalk compensation registers needs to be applied however OPT3101 has only one common scale which this method computes
tgrosch 0:62b846b3988a 85 * \param[in,out] illumXtalk; illumXtalk is pointer to OPT3101::crosstalkC class which contains the list of crosstalk instances for which the common coefficient needs to be calculated.
tgrosch 0:62b846b3988a 86 * \param[in] txActiveList;
tgrosch 0:62b846b3988a 87 * \param[in] registerSetActiveList;
tgrosch 0:62b846b3988a 88 * \returns Nothing;
tgrosch 0:62b846b3988a 89 */
tgrosch 0:62b846b3988a 90 void findCommonCrosstalkScale(crosstalkC *illumXtalk, bool *txActiveList,bool *registerSetActiveList);
tgrosch 0:62b846b3988a 91 /*!
tgrosch 0:62b846b3988a 92 * \brief Calculates crosstalk temp coefficient registers from floating point precision coefficients
tgrosch 0:62b846b3988a 93 * OPT3101 system could consist of multiple TX configuration operating together, switching between each other configurations. In such cases more than 1 illum crosstalk temperature compensation registers needs to be applied.
tgrosch 0:62b846b3988a 94 * OPT3101 has only one common scale which this method computes along with the registers that need to be written to compensate these effects.
tgrosch 0:62b846b3988a 95 * \param[in,out] illumXtalkCoff; illumXtalkCoff is pointer to OPT3101::crosstalkTempCoffC class which contains the list of crosstalk temp coefficients for which the register values needs to be calculated.
tgrosch 0:62b846b3988a 96 * \param[in] txActiveList;
tgrosch 0:62b846b3988a 97 * \param[in] registerSetActiveList;
tgrosch 0:62b846b3988a 98 * \param[in] illumXtalk; illumXtalk is pointer to OPT3101::crosstalkTempCoffC class which contains the list of crosstalk instances for which the common coefficient needs to be calculated. This is mainly required to scale the crosstalk values with magnitude
tgrosch 0:62b846b3988a 99 * \returns Nothing;
tgrosch 0:62b846b3988a 100 */
tgrosch 0:62b846b3988a 101 void findCrosstalkTempRegisterValues(crosstalkTempCoffC *illumXtalkCoff, bool *txActiveList,bool *registerSetActiveList, crosstalkC *illumXtalk);
tgrosch 0:62b846b3988a 102 /*!
tgrosch 0:62b846b3988a 103 * \brief calculates the phase temp coff register values from the floating point coff
tgrosch 0:62b846b3988a 104 * OPT3101 system could consist of multiple TX configuration operating together, switching between each other configurations. In such cases more than 1 phase temperature compensation registers needs to be applied.
tgrosch 0:62b846b3988a 105 * OPT3101 has only one common scale which this method computes along with the registers that need to be written to compensate these effects.
tgrosch 0:62b846b3988a 106 * \param[in,out] phaseTempCoff; phaseTempCoff is pointer to OPT3101::phaseTempCoffC class which contains the list of phase temp coefficients for which the register values needs to be calculated.
tgrosch 0:62b846b3988a 107 * \param[in] txActiveList;
tgrosch 0:62b846b3988a 108 * \param[in] registerSetActiveList;
tgrosch 0:62b846b3988a 109 * \param[in] freqCount; freqCount is frequency count register read from OPT3101::registers::freq_count_read_reg. This is used to scale the coefficients accordingly
tgrosch 0:62b846b3988a 110 * \returns Nothing;
tgrosch 0:62b846b3988a 111 */
tgrosch 0:62b846b3988a 112 void findPhaseTempRegisterValues(phaseTempCoffC* phaseTempCoff, bool *txActiveList,bool *registerSetActiveList, uint16_t freqCount);
tgrosch 0:62b846b3988a 113 /*!
tgrosch 0:62b846b3988a 114 * \brief reports members of the instance
tgrosch 0:62b846b3988a 115 * Print the members of the class instance on screen
tgrosch 0:62b846b3988a 116 * \returns Nothing;
tgrosch 0:62b846b3988a 117 */
tgrosch 0:62b846b3988a 118 void report();
tgrosch 0:62b846b3988a 119 };
tgrosch 0:62b846b3988a 120 }
tgrosch 0:62b846b3988a 121
tgrosch 0:62b846b3988a 122 #endif /* OPT3101CALIBRATION_H_ */
tgrosch 0:62b846b3988a 123