Ted Grosch / Mbed 2 deprecated Nucleo_TOF_I2C

Export to MBED Studio

Dependencies:   mbed

OPT3101PhaseOffset.h@0:62b846b3988a, 2020-10-25 (annotated)

Committer:
tgrosch
Date:
Sun Oct 25 00:58:24 2020 +0000
Revision:
0:62b846b3988a
First successful compile.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
tgrosch 0:62b846b3988a 1 /*!
tgrosch 0:62b846b3988a 2 * \file OPT3101PhaseOffset.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::phaseOffsetC class declaration
tgrosch 0:62b846b3988a 26 */
tgrosch 0:62b846b3988a 27
tgrosch 0:62b846b3988a 28 #ifndef OPT3101PHASEOFFSET_H_
tgrosch 0:62b846b3988a 29 #define OPT3101PHASEOFFSET_H_
tgrosch 0:62b846b3988a 30
tgrosch 0:62b846b3988a 31 #include <stdint.h>
tgrosch 0:62b846b3988a 32 //#include "OPT3101device.h"
tgrosch 0:62b846b3988a 33 #include "OPT3101frameData.h"
tgrosch 0:62b846b3988a 34
tgrosch 0:62b846b3988a 35 #ifdef OPT3101_USE_STREAMLIB
tgrosch 0:62b846b3988a 36 #include <fstream>
tgrosch 0:62b846b3988a 37 #include <iostream>
tgrosch 0:62b846b3988a 38 #include <istream>
tgrosch 0:62b846b3988a 39 #include <string>
tgrosch 0:62b846b3988a 40 #endif
tgrosch 0:62b846b3988a 41
tgrosch 0:62b846b3988a 42
tgrosch 0:62b846b3988a 43 namespace OPT3101{
tgrosch 0:62b846b3988a 44 /*! \class OPT3101::phaseOffsetC
tgrosch 0:62b846b3988a 45 \brief Class that holds phase offset register data
tgrosch 0:62b846b3988a 46
tgrosch 0:62b846b3988a 47 The class contains the phase offset calibration registers and related snapshot from the device settings.
tgrosch 0:62b846b3988a 48 Phase offset calibration is an important factory calibration that needs to be performed on every unit. The calibration is important to remove all the offsets and delays and read accurate distance or phase.
tgrosch 0:62b846b3988a 49 The calibration involves having a target at a known distance and setting up offset register so that the device reads distance as expected.
tgrosch 0:62b846b3988a 50 This class besides capturing the register settings also holds critical snapshot from device for analysis and debug.
tgrosch 0:62b846b3988a 51 */
tgrosch 0:62b846b3988a 52 class phaseOffsetC {
tgrosch 0:62b846b3988a 53 public:
tgrosch 0:62b846b3988a 54 uint16_t phaseOffset; ///< This it the 16 bit phase offset register value to be written to the device registers for correcting the delays and offsets.
tgrosch 0:62b846b3988a 55 uint16_t referenceDistanceInCodes; ///< Captures a snapshot of the distances measured in OPT3101::frameData::phase codes used during calibration
tgrosch 0:62b846b3988a 56 uint8_t illumScale; ///< Captures the illumination scale used during phase offset measurement
tgrosch 0:62b846b3988a 57 uint8_t illumDac; ///< Captures the illumination current setting used during phase offset measurement
tgrosch 0:62b846b3988a 58 uint8_t illumDCdac; ///< Captures the illumination DC current setting used during phase offset measurement
tgrosch 0:62b846b3988a 59 uint16_t freqCount; ///< Captures the frequency Count register OPT3101::registers::freq_count_read_reg during phase offset measurement
tgrosch 0:62b846b3988a 60 uint8_t shiftIllumPhase; ///< Captures the register OPT3101::registers::shift_illum_phase during phase offset measurement
tgrosch 0:62b846b3988a 61 frameData data; ///< Captures the OPT3101::frameData used to calculate the OPT3101::phaseOffsetC::phaseOffset register
tgrosch 0:62b846b3988a 62 /*!
tgrosch 0:62b846b3988a 63 * \brief initializes the members to 0
tgrosch 0:62b846b3988a 64 *
tgrosch 0:62b846b3988a 65 * \returns Nothing;
tgrosch 0:62b846b3988a 66 */
tgrosch 0:62b846b3988a 67 phaseOffsetC();
tgrosch 0:62b846b3988a 68 /*!
tgrosch 0:62b846b3988a 69 * \brief reports members of the instance
tgrosch 0:62b846b3988a 70 * Print the members of the class instance on screen
tgrosch 0:62b846b3988a 71 * \returns Nothing;
tgrosch 0:62b846b3988a 72 */
tgrosch 0:62b846b3988a 73 void report();
tgrosch 0:62b846b3988a 74 /*!
tgrosch 0:62b846b3988a 75 * \brief print header
tgrosch 0:62b846b3988a 76 * Print the members of the class instance on screen
tgrosch 0:62b846b3988a 77 * \returns Nothing;
tgrosch 0:62b846b3988a 78 */
tgrosch 0:62b846b3988a 79 void printHeader();
tgrosch 0:62b846b3988a 80 /*!
tgrosch 0:62b846b3988a 81 * \brief prints the contents of the class
tgrosch 0:62b846b3988a 82 * Print the members of the class instance on screen
tgrosch 0:62b846b3988a 83 * \returns Nothing;
tgrosch 0:62b846b3988a 84 */
tgrosch 0:62b846b3988a 85 void print();
tgrosch 0:62b846b3988a 86 #ifdef OPT3101_USE_STDIOLIB
tgrosch 0:62b846b3988a 87 /*!
tgrosch 0:62b846b3988a 88 * \brief store phase offset values to file
tgrosch 0:62b846b3988a 89 * This methods stores the phase offset values to a non-volatile memory. Storage to non-volatile memory is important to be able to calculate temperature coefficient OPT3101::crosstalkTempCoffC
tgrosch 0:62b846b3988a 90 * \param[in] fileName; Path and name of the file to capture the crosstalk values to
tgrosch 0:62b846b3988a 91 * \returns Nothing;
tgrosch 0:62b846b3988a 92 */
tgrosch 0:62b846b3988a 93 void storeToFile(char *fileName);
tgrosch 0:62b846b3988a 94 /*!
tgrosch 0:62b846b3988a 95 * \brief load phase offset values from file
tgrosch 0:62b846b3988a 96 * This methods loads the phase offset values to a non-volatile memory. Storage/Restoration to/from non-volatile memory is important to be able to calculate temperature coefficient OPT3101::crosstalkTempCoffC
tgrosch 0:62b846b3988a 97 * \param[in] fileName; Path and name of the file from where the crosstalk values are loaded
tgrosch 0:62b846b3988a 98 * \returns Nothing;
tgrosch 0:62b846b3988a 99 */
tgrosch 0:62b846b3988a 100 void loadFromFile(char *fileName);
tgrosch 0:62b846b3988a 101 #endif
tgrosch 0:62b846b3988a 102 #ifdef OPT3101_USE_STREAMLIB
tgrosch 0:62b846b3988a 103 /*!
tgrosch 0:62b846b3988a 104 * \brief Operator overload to store class contents to a file
tgrosch 0:62b846b3988a 105 * Casts all the class members for file storage
tgrosch 0:62b846b3988a 106 * \param[out] os; os is data stream to serialize data
tgrosch 0:62b846b3988a 107 * \param[in] data; data is pointer to the class to be serialized and stored
tgrosch 0:62b846b3988a 108 * \returns std::ostream; Serialized std::ostream to be written to a file
tgrosch 0:62b846b3988a 109 */
tgrosch 0:62b846b3988a 110 friend std::ostream& operator<<(std::ostream& os, const phaseOffsetC *data);
tgrosch 0:62b846b3988a 111 /*!
tgrosch 0:62b846b3988a 112 * \brief Operator overload to load class contents to from a file
tgrosch 0:62b846b3988a 113 * Retreives all the class members from a stored file
tgrosch 0:62b846b3988a 114 * \param[in] is; is input stream from where the data is loaded
tgrosch 0:62b846b3988a 115 * \param[out] data; data is pointer to the class to be restored
tgrosch 0:62b846b3988a 116 * \returns std::istream; Serialized Input stream loaded from file
tgrosch 0:62b846b3988a 117 */
tgrosch 0:62b846b3988a 118 friend std::istream& operator>>(std::istream& is, phaseOffsetC *data);
tgrosch 0:62b846b3988a 119 #endif
tgrosch 0:62b846b3988a 120 };
tgrosch 0:62b846b3988a 121 }
tgrosch 0:62b846b3988a 122 #endif /* OPT3101PHASEOFFSET_H_ */
tgrosch 0:62b846b3988a 123