temperature.h

/*
    temperature.h: Temperature driver header

    Copyright (C) 2012 Matthew Excell <matt@excellclan.com>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
// *************************************************************************************************
//
//      Copyright (C) 2009 Texas Instruments Incorporated - http://www.ti.com/
//
//
//        Redistribution and use in source and binary forms, with or without
//        modification, are permitted provided that the following conditions
//        are met:
//
//          Redistributions of source code must retain the above copyright
//          notice, this list of conditions and the following disclaimer.
//
//          Redistributions in binary form must reproduce the above copyright
//          notice, this list of conditions and the following disclaimer in the
//          documentation and/or other materials provided with the
//          distribution.
//
//          Neither the name of Texas Instruments Incorporated nor the names of
//          its contributors may be used to endorse or promote products derived
//          from this software without specific prior written permission.
//
//        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
//        "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 THE COPYRIGHT
//        OWNER OR CONTRIBUTORS 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.
//
// *************************************************************************************************

#ifndef TEMPERATURE_H_
#define TEMPERATURE_H_

// *************************************************************************************************
// Include section
#include <openchronos.h>

// *************************************************************************************************
// Prototypes section

// internal functions
extern void reset_temp_measurement(void);
extern void temperature_measurement(uint8_t filter);

#ifndef CONFIG_TEMPERATUREMON_METRIC_ONLY
extern int16_t convert_C_to_F(int16_t value);
extern int16_t convert_F_to_C(int16_t value);
#endif
// *************************************************************************************************
// Defines section


// *************************************************************************************************
// Global Variable section
/* TODO: pack this stuff!!!! */
struct temp
{
        // Temperature (�C) in 2.1 format
        int16_t         degrees;
        // User set calibration value (�C) in 2.1 format
        int16_t         offset;
        // Update available for sys_msg?
        uint8_t has_update :1;
#ifndef CONFIG_TEMPERATUREMON_METRIC_ONLY
    //C or F
    uint8_t         is_c :1;
#endif

};
extern struct temp sTemp;

#ifndef FALSE
  // the classic false
  #define FALSE (0 == 1)
#endif

#ifndef TRUE
  // the classic true
  #define TRUE  (1 == 1)
#endif

#define FILTER_OFF (0)
#define FILTER_ON (1)

// *************************************************************************************************
// Extern section


#endif /*TEMPERATURE_H_*/