Ted Grosch / Mbed 2 deprecated Nucleo_TOF_I2C_DISCO

Export to MBED Studio for DISCO Board

Dependencies:   mbed

environmentControl.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 environmentControl.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 * The file contains class environmentalController methods and declaration
tgrosch 0:62b846b3988a 26 */
tgrosch 0:62b846b3988a 27
tgrosch 0:62b846b3988a 28 #include "environmentControl.h"
tgrosch 0:62b846b3988a 29 #include "definitions.h"
tgrosch 0:62b846b3988a 30 #include "hostController.h"
tgrosch 0:62b846b3988a 31
tgrosch 0:62b846b3988a 32 /** \brief environmentalController declaration
tgrosch 0:62b846b3988a 33 This global variable declaration with name envController of environmentalController is used by class for various environmental setup during calibration steps
tgrosch 0:62b846b3988a 34 */
tgrosch 0:62b846b3988a 35 environmentalController envController;
tgrosch 0:62b846b3988a 36
tgrosch 0:62b846b3988a 37 environmentalController::environmentalController()
tgrosch 0:62b846b3988a 38 {
tgrosch 0:62b846b3988a 39 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 40 /// This is empty method to be overwritten by user
tgrosch 0:62b846b3988a 41 }
tgrosch 0:62b846b3988a 42
tgrosch 0:62b846b3988a 43 void environmentalController::setTargetDistance(uint16_t targetDistanceInMM)
tgrosch 0:62b846b3988a 44 {
tgrosch 0:62b846b3988a 45 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 46 host.printf("Set Target to distance [%04d]mm\r\n",targetDistanceInMM); ///* Prints Set Target message on console
tgrosch 0:62b846b3988a 47 host.pause(); ///* Waits on user input
tgrosch 0:62b846b3988a 48 ///* User implemented function to set the target distance.
tgrosch 0:62b846b3988a 49 }
tgrosch 0:62b846b3988a 50
tgrosch 0:62b846b3988a 51 void environmentalController::setChamberTemperature(int8_t chamberTemperatureInC)
tgrosch 0:62b846b3988a 52 {
tgrosch 0:62b846b3988a 53 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 54 host.printf("INFO:Settings Chamber Temperature to %dC\r\n",chamberTemperatureInC); ///* Prints Set Chamber temperature message on console
tgrosch 0:62b846b3988a 55 host.pause(); ///* Waits on user input
tgrosch 0:62b846b3988a 56 ///* User implemented function to set the target distance.
tgrosch 0:62b846b3988a 57 }
tgrosch 0:62b846b3988a 58
tgrosch 0:62b846b3988a 59 void environmentalController::setAmbientLight(uint32_t setAmbientLightInLux)
tgrosch 0:62b846b3988a 60 {
tgrosch 0:62b846b3988a 61 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 62 host.printf("Set Ambient light to %dlux\r\n",setAmbientLightInLux); ///* Prints Set Ambient light message on console
tgrosch 0:62b846b3988a 63 host.pause();///* Waits on user input
tgrosch 0:62b846b3988a 64 ///* User implemented function to set the target distance.
tgrosch 0:62b846b3988a 65 }
tgrosch 0:62b846b3988a 66
tgrosch 0:62b846b3988a 67 void environmentalController::setTargetToInfinity_OR_coverPhotodiode()
tgrosch 0:62b846b3988a 68 {
tgrosch 0:62b846b3988a 69 /// <b>Algorithm of the method is as follows</b>
tgrosch 0:62b846b3988a 70 /// * This is an empty function to convey the measurement setup required.
tgrosch 0:62b846b3988a 71 /// * With a cover glass in place, the system is expected to be pointed towards a target with very low reflectivity far beyond the range of the system
tgrosch 0:62b846b3988a 72 /// * It is also acceptable to cover the photo diode alone with an optically isolating light blocker.
tgrosch 0:62b846b3988a 73 host.printf("INFO::Cover Photodiode with optical shied for illumination Cross talk measurement\r\n"); ///* Prints message to set target to infinity or cover up photodiode
tgrosch 0:62b846b3988a 74 host.pause();///* Waits on user input
tgrosch 0:62b846b3988a 75 }
tgrosch 0:62b846b3988a 76