definitions.h

00001 /*!
00002 * \file definition.h
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 * This is header file with all #define statements
00026 *
00027 */
00028 #ifndef DEFINITIONS_H_
00029 #define DEFINITIONS_H_
00030 
00031 /*! \def TIMSP430F5529_LAUNCHPAD_CALIBRATION_TOOL
00032 \brief This pre-processor derivative dictates whether the host is TI MSP430 calibration hardware is being used or not
00033 */
00034 #define TIMSP430F5529_LAUNCHPAD_CALIBRATION_TOOL
00035 
00036 #ifndef TIMSP430F5529_LAUNCHPAD_CALIBRATION_TOOL
00037 /*! \def HOST_PC
00038 \brief This pre-processor derivative dictates whether the host is PC
00039 In a PC environment file storage, std::iostream and stdio::printf methods are available. All these libraries are enabled then this derivative is defined
00040 Disable this derivative in MCU or RTOS like environments where file storage doesn't make sense
00041 Disabling this disabled report routines and file storage and load routines
00042 */
00043 #define HOST_PC
00044 #endif
00045 
00046 #ifdef TIMSP430F5529_LAUNCHPAD_CALIBRATION_TOOL
00047 /*! \def PRINT_COLOR_TERMINAL
00048 \brief Prints colors in terminal
00049 */
00050 #define PRINT_COLOR_TERMINAL
00051 #endif
00052 
00053 #define OPT3101_I2C_SLAVEADDRESS 0x58
00054 
00055 
00056 #ifdef TIMSP430F5529_LAUNCHPAD_CALIBRATION_TOOL
00057 /*! \def VERBOSE_MODE
00058 \brief This pre-processor derivative dictates whether to print INFO, WARN and ERROR
00059 */
00060 #define VERBOSE_MODE
00061 #endif
00062 
00063 
00064 #define TEMP_CYCLE_DELAY_IN_SECONDS_BETWEEN_DATA_POINTS 1
00065 #define TEMP_CYCLE_TOTAL_NUMBER_OF_DATA_POINTS_PER_SETTING 1000 // MAX is 65535
00066 
00067 
00068 #ifdef HOST_PC
00069 #define PRINT_COLOR_TERMINAL
00070 /*! \def VERBOSE_MODE
00071 \brief This pre-processor derivative dictates whether to print INFO, WARN and ERROR
00072 */
00073 #define VERBOSE_MODE
00074 /*! \def OPT3101_USE_SERIALLIB
00075 \brief This pre-processor derivative dictates whether to use included serial.h library
00076 This is enabled by default in SDK. Not defining this derivate would disable the serial communication capability.
00077 In case of usage with TI EVM this derivative is required, if using any other method of communication this can be disabled by user
00078 */
00079 #define OPT3101_USE_SERIALLIB
00080 
00081 /*! \def OPT3101_USE_STREAMLIB
00082 \brief This pre-processor derivative dictates whether to load std::iostream and std::fstream  libraries
00083 This is enabled by default in SDK. Not defining this derivate would disable all the std::iostream and related libraries. File storage will no longer be possible with the SDK.
00084 All methods related to loadFromFile and saveToFile are hidden to the compiler.
00085 */
00086 #define OPT3101_USE_STREAMLIB
00087 
00088 /*! \def OPT3101_USE_STDIOLIB
00089 \brief This pre-processor derivative dictates whether to load stdio library which contains printf and sprintf methods
00090 This is enabled by default in SDK. Not defining this derivate would disable all sprintf and printf methods.
00091 This means that the report() methods on several calls will be blank to the compiler. All file storage is also disabled since the name for the files cannot be resolved without the sprintf method
00092 */
00093 #define OPT3101_USE_STDIOLIB
00094 #endif
00095 
00096 #endif /* DEFINITIONS_H_ */
00097