Ted Grosch / Mbed 2 deprecated Nucleo_TOF_I2C_DISCO

Export to MBED Studio for DISCO Board

Dependencies:   mbed

OPT3101PhaseOffset.cpp@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 OPT3101PhaseOffset.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::phaseOffsetC
tgrosch 0:62b846b3988a 26 */
tgrosch 0:62b846b3988a 27
tgrosch 0:62b846b3988a 28 #include "OPT3101PhaseOffset.h"
tgrosch 0:62b846b3988a 29 #include "hostController.h"
tgrosch 0:62b846b3988a 30
tgrosch 0:62b846b3988a 31
tgrosch 0:62b846b3988a 32 OPT3101::phaseOffsetC::phaseOffsetC()
tgrosch 0:62b846b3988a 33 {
tgrosch 0:62b846b3988a 34 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 35 this->phaseOffset = 0; ///* Initializes all members to 0
tgrosch 0:62b846b3988a 36 this->referenceDistanceInCodes = 0;
tgrosch 0:62b846b3988a 37 this->illumScale = 0;
tgrosch 0:62b846b3988a 38 this->illumDac=0;
tgrosch 0:62b846b3988a 39 this->illumDCdac = 0;
tgrosch 0:62b846b3988a 40 this->freqCount = 0;
tgrosch 0:62b846b3988a 41 this->shiftIllumPhase=0;
tgrosch 0:62b846b3988a 42 }
tgrosch 0:62b846b3988a 43
tgrosch 0:62b846b3988a 44 void OPT3101::phaseOffsetC::report()
tgrosch 0:62b846b3988a 45 {
tgrosch 0:62b846b3988a 46 host.printf("-------------------------\r\n");
tgrosch 0:62b846b3988a 47 host.printf("Phase Offset Class Report\r\n");
tgrosch 0:62b846b3988a 48 host.printf("-------------------------\r\n"); ///* Prints all the members and values of members on screen.
tgrosch 0:62b846b3988a 49 host.printf("phaseOffset=%d\r\n", this->phaseOffset);
tgrosch 0:62b846b3988a 50 host.printf("referenceDistanceInCodes=%d\r\n", this->referenceDistanceInCodes);
tgrosch 0:62b846b3988a 51 host.printf("illumScale=%d\r\n", this->illumScale);
tgrosch 0:62b846b3988a 52 host.printf("illumDac=%d\r\n", this->illumDac);
tgrosch 0:62b846b3988a 53 host.printf("illumDCdac=%d\r\n", this->illumDCdac);
tgrosch 0:62b846b3988a 54 host.printf("freqCount=%d\r\n", this->freqCount);
tgrosch 0:62b846b3988a 55 host.printf("shiftIllumPhase=%d\r\n", this->shiftIllumPhase);
tgrosch 0:62b846b3988a 56 host.printf("data=\r\n");
tgrosch 0:62b846b3988a 57 this->data.report();
tgrosch 0:62b846b3988a 58 host.printf("-------------------------\r\n"); ///* Prints all the members and values of members on screen.
tgrosch 0:62b846b3988a 59 }
tgrosch 0:62b846b3988a 60
tgrosch 0:62b846b3988a 61 void OPT3101::phaseOffsetC::printHeader()
tgrosch 0:62b846b3988a 62 {
tgrosch 0:62b846b3988a 63 host.printfSetColor(0b001);
tgrosch 0:62b846b3988a 64 host.printf("\r\nPhOfft,");
tgrosch 0:62b846b3988a 65 host.printf("rfDCod,");
tgrosch 0:62b846b3988a 66 host.printf("ilmScl,");
tgrosch 0:62b846b3988a 67 host.printf("ilmDac,");
tgrosch 0:62b846b3988a 68 host.printf(" fqCnt\r\n");
tgrosch 0:62b846b3988a 69 host.printfSetColor(0xFF);
tgrosch 0:62b846b3988a 70 }
tgrosch 0:62b846b3988a 71 void OPT3101::phaseOffsetC::print()
tgrosch 0:62b846b3988a 72 {
tgrosch 0:62b846b3988a 73 host.printfSetColor(0b001);
tgrosch 0:62b846b3988a 74 host.printf("%06u,",this->phaseOffset);
tgrosch 0:62b846b3988a 75 host.printf("%06u,",this->referenceDistanceInCodes);
tgrosch 0:62b846b3988a 76 host.printf(" %01u,",this->illumScale);
tgrosch 0:62b846b3988a 77 host.printf(" %02u,",this->illumDac);
tgrosch 0:62b846b3988a 78 host.printf(" %05u,\r\n",this->freqCount);
tgrosch 0:62b846b3988a 79 host.printfSetColor(0xFF);
tgrosch 0:62b846b3988a 80 this->data.printHeader();
tgrosch 0:62b846b3988a 81 this->data.print();
tgrosch 0:62b846b3988a 82 }
tgrosch 0:62b846b3988a 83
tgrosch 0:62b846b3988a 84
tgrosch 0:62b846b3988a 85 #ifdef OPT3101_USE_STDIOLIB
tgrosch 0:62b846b3988a 86 void OPT3101::phaseOffsetC::storeToFile(char * fileName)
tgrosch 0:62b846b3988a 87 {
tgrosch 0:62b846b3988a 88 #ifdef OPT3101_USE_STREAMLIB
tgrosch 0:62b846b3988a 89 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 90 std::ofstream ofs(fileName);
tgrosch 0:62b846b3988a 91 ofs << this;
tgrosch 0:62b846b3988a 92 ofs.close(); ///* User needs to implement file storage based on host.
tgrosch 0:62b846b3988a 93 #endif
tgrosch 0:62b846b3988a 94 }
tgrosch 0:62b846b3988a 95 #endif
tgrosch 0:62b846b3988a 96
tgrosch 0:62b846b3988a 97 #ifdef OPT3101_USE_STDIOLIB
tgrosch 0:62b846b3988a 98 void OPT3101::phaseOffsetC::loadFromFile(char * fileName)
tgrosch 0:62b846b3988a 99 {
tgrosch 0:62b846b3988a 100 #ifdef OPT3101_USE_STREAMLIB
tgrosch 0:62b846b3988a 101 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 102 std::ifstream ifs(fileName);
tgrosch 0:62b846b3988a 103 ifs >> this;
tgrosch 0:62b846b3988a 104 ifs.close(); ///* User needs to implement file load/restore based on host.
tgrosch 0:62b846b3988a 105 #endif
tgrosch 0:62b846b3988a 106 }
tgrosch 0:62b846b3988a 107 #endif
tgrosch 0:62b846b3988a 108
tgrosch 0:62b846b3988a 109 #ifdef OPT3101_USE_STREAMLIB
tgrosch 0:62b846b3988a 110 std::ostream & OPT3101::operator<<(std::ostream & os, const phaseOffsetC * data)
tgrosch 0:62b846b3988a 111 {
tgrosch 0:62b846b3988a 112 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 113 os << data->phaseOffset<<'\n'; ///* Serializes all the members and returns to the stream
tgrosch 0:62b846b3988a 114 os << data->referenceDistanceInCodes << '\n';
tgrosch 0:62b846b3988a 115 os << data->illumScale << '\n';
tgrosch 0:62b846b3988a 116 os << data->illumDac << '\n';
tgrosch 0:62b846b3988a 117 os << data->illumDCdac << '\n';
tgrosch 0:62b846b3988a 118 os << data->freqCount << '\n';
tgrosch 0:62b846b3988a 119 os << data->shiftIllumPhase << '\n';
tgrosch 0:62b846b3988a 120 os << &data->data << '\n';
tgrosch 0:62b846b3988a 121 return os;
tgrosch 0:62b846b3988a 122 }
tgrosch 0:62b846b3988a 123 #endif
tgrosch 0:62b846b3988a 124
tgrosch 0:62b846b3988a 125 #ifdef OPT3101_USE_STREAMLIB
tgrosch 0:62b846b3988a 126 std::istream & OPT3101::operator>>(std::istream & is, phaseOffsetC * data)
tgrosch 0:62b846b3988a 127 {
tgrosch 0:62b846b3988a 128 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 129 is >> data->phaseOffset; ///* Reads from stream and de-serializes all the members
tgrosch 0:62b846b3988a 130 is >> data->referenceDistanceInCodes;
tgrosch 0:62b846b3988a 131 is >> data->illumScale;
tgrosch 0:62b846b3988a 132 is >> data->illumDac;
tgrosch 0:62b846b3988a 133 is >> data->illumDCdac;
tgrosch 0:62b846b3988a 134 is >> data->freqCount;
tgrosch 0:62b846b3988a 135 is >> data->shiftIllumPhase;
tgrosch 0:62b846b3988a 136 is >> &data->data;
tgrosch 0:62b846b3988a 137 return is;
tgrosch 0:62b846b3988a 138 }
tgrosch 0:62b846b3988a 139 #endif
tgrosch 0:62b846b3988a 140