environmentControl.cpp

00001 /*!
00002 * \file environmentControl.cpp
00003 * \author  Karthik Rajagopal <krthik@ti.com>
00004 * \version 0.9.1
00005 *
00006 * \section COPYRIGHT
00007 * TEXAS INSTRUMENTS TEXT FILE LICENSE
00008 * Copyright (c) 2018 Texas Instruments Incorporated
00009 * All rights reserved not granted herein.
00010 * Limited License.
00011 * 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.
00012 * 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
00013 * Redistribution and use in binary form, without modification, are permitted provided that the following conditions are met:
00014 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any software provided in binary form.
00015 * * any redistribution and use are licensed by TI for use only with TI Devices.
00016 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
00017 * If software source code is provided to you, modification and redistribution of the source code are permitted provided that the following conditions are met:
00018 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by TI for use only with TI Devices.
00019 * * 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.
00020 * 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.
00021 * DISCLAIMER.
00022 * 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.
00023 *
00024 * \section DESCRIPTION
00025 * The file contains class environmentalController methods and declaration
00026 */
00027 
00028 #include "environmentControl.h "
00029 #include "definitions.h"
00030 #include "hostController.h "
00031 
00032 /** \brief environmentalController declaration
00033 This global variable declaration with name envController of environmentalController is used by class for various environmental setup during calibration steps
00034 */
00035 environmentalController envController;
00036 
00037 environmentalController::environmentalController()
00038 {
00039     /// <b>Algorithm of the method is as follows</b>
00040     /// This is empty method to be overwritten by user
00041 }
00042 
00043 void environmentalController::setTargetDistance(uint16_t targetDistanceInMM)
00044 {
00045     /// <b>Algorithm of the method is as follows</b>
00046     host.printf("Set Target to distance [%04d]mm\r\n",targetDistanceInMM); ///* Prints Set Target message on console
00047     host.pause(); ///* Waits on user input
00048     ///* User implemented function to set the target distance.
00049 }
00050 
00051 void environmentalController::setChamberTemperature(int8_t chamberTemperatureInC)
00052 {
00053     /// <b>Algorithm of the method is as follows</b>
00054     host.printf("INFO:Settings Chamber Temperature to %dC\r\n",chamberTemperatureInC); ///* Prints Set Chamber temperature message on console
00055     host.pause(); ///* Waits on user input
00056     ///* User implemented function to set the target distance.
00057 }
00058 
00059 void environmentalController::setAmbientLight(uint32_t setAmbientLightInLux) 
00060 {
00061     /// <b>Algorithm of the method is as follows</b>
00062     host.printf("Set Ambient light to %dlux\r\n",setAmbientLightInLux); ///* Prints Set Ambient light message on console
00063     host.pause();///* Waits on user input
00064     ///* User implemented function to set the target distance.
00065 }
00066 
00067 void environmentalController::setTargetToInfinity_OR_coverPhotodiode()
00068 {
00069     /// <b>Algorithm of the method is as follows</b>
00070     /// * This is an empty function to convey the measurement setup required. 
00071     /// * 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 
00072     /// * It is also acceptable to cover the photo diode alone with an optically isolating light blocker. 
00073     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
00074     host.pause();///* Waits on user input
00075 }
00076