Ted Grosch / Mbed OS Nucleo_TOF_I2C_OS5

New Version with OS5

OPT3101Calibration.cpp@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 OPT3101Calibration.cpp
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 method definitions for class OPT3101::calibrationC
tgrosch 0:62b846b3988a 26 */
tgrosch 0:62b846b3988a 27
tgrosch 0:62b846b3988a 28 #include "OPT3101Calibration.h"
tgrosch 0:62b846b3988a 29 #include <stdlib.h>
tgrosch 0:62b846b3988a 30
tgrosch 0:62b846b3988a 31 void OPT3101::calibrationC::findCrosstalkTempRegisterValues(OPT3101::crosstalkTempCoffC *illumXtalkCoff, bool *txActiveList,bool *registerSetActiveList, OPT3101::crosstalkC *illumXtalk) {
tgrosch 0:62b846b3988a 32 uint8_t c0,c1,scaleCoff;
tgrosch 0:62b846b3988a 33 double maxCoff = -1;
tgrosch 0:62b846b3988a 34 double magnitude[3][2];
tgrosch 0:62b846b3988a 35
tgrosch 0:62b846b3988a 36 for (c0 = 0; c0 < 3; c0++) {
tgrosch 0:62b846b3988a 37 for (c1 = 0; c1 < 2; c1++) {
tgrosch 0:62b846b3988a 38 if(txActiveList[c0] && registerSetActiveList[c1]){
tgrosch 0:62b846b3988a 39 magnitude[c0][c1] = illumXtalk[(c0<<1)+c1].magnitude();
tgrosch 0:62b846b3988a 40 maxCoff = abs(illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1]) > maxCoff ? abs(illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1]) : maxCoff;
tgrosch 0:62b846b3988a 41 maxCoff = abs(illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1]) > maxCoff ? abs(illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1]) : maxCoff;
tgrosch 0:62b846b3988a 42 }
tgrosch 0:62b846b3988a 43 }
tgrosch 0:62b846b3988a 44 }
tgrosch 0:62b846b3988a 45 scaleCoff = 7;
tgrosch 0:62b846b3988a 46 for (c0 = 12; c0 >= 5; c0--)
tgrosch 0:62b846b3988a 47 scaleCoff = maxCoff < (1 << (c0)) ? (12 - c0) : scaleCoff;
tgrosch 0:62b846b3988a 48
tgrosch 0:62b846b3988a 49 for (c0 = 0; c0 < 3; c0++) {
tgrosch 0:62b846b3988a 50 for (c1 = 0; c1 < 2; c1++) {
tgrosch 0:62b846b3988a 51 if(txActiveList[c0] && registerSetActiveList[c1]){
tgrosch 0:62b846b3988a 52 if (scaleCoff >= 5) {
tgrosch 0:62b846b3988a 53 illumXtalkCoff[(c0<<1)+c1].coffIReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1])*(1 << (scaleCoff - 5)));
tgrosch 0:62b846b3988a 54 illumXtalkCoff[(c0<<1)+c1].coffQReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1])*(1 << (scaleCoff - 5)));
tgrosch 0:62b846b3988a 55 }
tgrosch 0:62b846b3988a 56 else {
tgrosch 0:62b846b3988a 57 illumXtalkCoff[(c0<<1)+c1].coffIReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1]) / (1 << (5 - scaleCoff)));
tgrosch 0:62b846b3988a 58 illumXtalkCoff[(c0<<1)+c1].coffQReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1]) / (1 << (5 - scaleCoff)));
tgrosch 0:62b846b3988a 59 }
tgrosch 0:62b846b3988a 60 illumXtalkCoff[(c0<<1)+c1].commonScale = scaleCoff;
tgrosch 0:62b846b3988a 61 }
tgrosch 0:62b846b3988a 62 }
tgrosch 0:62b846b3988a 63 }
tgrosch 0:62b846b3988a 64 }
tgrosch 0:62b846b3988a 65
tgrosch 0:62b846b3988a 66 void OPT3101::calibrationC::findPhaseTempRegisterValues(OPT3101::phaseTempCoffC* phaseTempCoff, bool *txActiveList,bool *registerSetActiveList, uint16_t freqCount) {
tgrosch 0:62b846b3988a 67 uint8_t scaleCoff;
tgrosch 0:62b846b3988a 68 uint8_t c1;
tgrosch 0:62b846b3988a 69 int8_t c0;
tgrosch 0:62b846b3988a 70 double maxCoff = -1;
tgrosch 0:62b846b3988a 71 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 72 for (c0 = 0; c0 < 3; c0++) {
tgrosch 0:62b846b3988a 73 for (c1 = 0; c1 < 2; c1++) {
tgrosch 0:62b846b3988a 74 if(txActiveList[c0] && registerSetActiveList[c1])
tgrosch 0:62b846b3988a 75 maxCoff = abs(phaseTempCoff[(c0<<1)+c1].coff) > maxCoff ? abs(phaseTempCoff[(c0<<1)+c1].coff) : maxCoff; ///* Identifies max of absolute of OPT3101::phaseTempCoffC::coff values
tgrosch 0:62b846b3988a 76 }
tgrosch 0:62b846b3988a 77 }
tgrosch 0:62b846b3988a 78 maxCoff *= 16384.0 / freqCount; ///* scales the max coefficient with input frequencyCount
tgrosch 0:62b846b3988a 79 // 3200
tgrosch 0:62b846b3988a 80 scaleCoff = 0;
tgrosch 0:62b846b3988a 81 for (c0 = 7; c0 >= 0; c0--)
tgrosch 0:62b846b3988a 82 scaleCoff = (maxCoff*(1 << (10 - c0))) < (1 << 11) ? c0 : scaleCoff; ///* Finds a OPT3101::phaseTempCoffC::commonScale which can fit the OPT3101::phaseTempCoffC::coff to 12 bit registers
tgrosch 0:62b846b3988a 83 for (c0 = 0; c0 < 3; c0++) {
tgrosch 0:62b846b3988a 84 for (c1 = 0; c1 < 2; c1++) {
tgrosch 0:62b846b3988a 85 if(txActiveList[c0] && registerSetActiveList[c1]){
tgrosch 0:62b846b3988a 86 phaseTempCoff[(c0<<1)+c1].coffReg = ((int16_t)(16384.0 / freqCount * phaseTempCoff[(c0<<1)+c1].coff*(1 << (10 - scaleCoff)))) & 0xFFF;///* Finds OPT3101::phaseTempCoffC::coffReg values (12 bit register values) based on OPT3101::phaseTempCoffC::coff and OPT3101::phaseTempCoffC::commonScale
tgrosch 0:62b846b3988a 87 phaseTempCoff[(c0<<1)+c1].commonScale = scaleCoff;
tgrosch 0:62b846b3988a 88 }
tgrosch 0:62b846b3988a 89 }
tgrosch 0:62b846b3988a 90 }
tgrosch 0:62b846b3988a 91 }
tgrosch 0:62b846b3988a 92
tgrosch 0:62b846b3988a 93 void OPT3101::calibrationC::report()
tgrosch 0:62b846b3988a 94 {
tgrosch 0:62b846b3988a 95 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 96 host.printf("------------------------\r\n");
tgrosch 0:62b846b3988a 97 host.printf("Calibration Class Report\r\n");
tgrosch 0:62b846b3988a 98 host.printf("------------------------\r\n"); ///* Prints all the members and values of members on screen.
tgrosch 0:62b846b3988a 99 this->internalCrosstalk[0].report();
tgrosch 0:62b846b3988a 100 host.printf("EEPROM_connected=%d\r\n", this->EEPROM_connected);
tgrosch 0:62b846b3988a 101 host.printf("extTempSensor_connected=%d\r\n", this->extTempSensor_connected);
tgrosch 0:62b846b3988a 102 host.printf("------------------------\r\n");
tgrosch 0:62b846b3988a 103 }
tgrosch 0:62b846b3988a 104