xpal_bat.h

Go to the documentation of this file.

/* Project eXplorersPal
 * Battery Management Module
 *
 */
/* Copyright (C) 2010 ThomasKlosa
 *
 *   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; version 2 of the License.
 *
 *   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, write to the Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef XPAL_BAT_H
#define XPAL_BAT_H

#include <avr/io.h>

// Bat Voltage Defines
#define HL_BAT_VOLT_INVALID             0x7fff  // invalid Voltage value

#define HL_BAT_MEASURE_ACTIVE   0x8000  // Flag for measurement in progress

#define HL_BAT_FULL_VOLT        4500  

#define HL_BAT_MIN_VOLT         2500  

#define HL_BAT_MIN_GPS_VOLT     3500  

#define HL_BAT_MAX_VOLT_GRADIENT        -50


#define HL_BAT_GRADIENT_COUNT_PON       -5              //!< Loaded at power up to ignore the first 5 cycles  
#define HL_BAT_GRADIENT_COUNT_MAX       32400   //!< 9 hours, Value will not be incremented beyond this limit  

#define HL_BAT_ST_FOPMAX  0x09 
#define HL_BAT_V_FOPMAX   HL_BAT_FULL_VOLT 
#define HL_BAT_ST_FOP4    0x08 
#define HL_BAT_V_FOP4     HL_BAT_MIN_GPS_VOLT + (4 * (HL_BAT_FULL_VOLT - HL_BAT_MIN_GPS_VOLT) / 5)
#define HL_BAT_ST_FOP3    0x07 
#define HL_BAT_V_FOP3     HL_BAT_MIN_GPS_VOLT + (3 * (HL_BAT_FULL_VOLT - HL_BAT_MIN_GPS_VOLT) / 5)
#define HL_BAT_ST_FOP2    0x06 
#define HL_BAT_V_FOP2     HL_BAT_MIN_GPS_VOLT + (2 * (HL_BAT_FULL_VOLT - HL_BAT_MIN_GPS_VOLT) / 5)
#define HL_BAT_ST_FOP1    0x05 
#define HL_BAT_V_FOP1     HL_BAT_MIN_GPS_VOLT + (1 * (HL_BAT_FULL_VOLT - HL_BAT_MIN_GPS_VOLT) / 5)
#define HL_BAT_ST_FOPMIN  0x04 
#define HL_BAT_V_FOPMIN   HL_BAT_MIN_GPS_VOLT 
#define HL_BAT_ST_LIM3    0x03 
#define HL_BAT_V_LIM3     HL_BAT_MIN_VOLT + (3 * (HL_BAT_MIN_GPS_VOLT - HL_BAT_MIN_VOLT)/ 4)
#define HL_BAT_ST_LIM2    0x02 
#define HL_BAT_V_LIM2     HL_BAT_MIN_VOLT + (2 * (HL_BAT_MIN_GPS_VOLT - HL_BAT_MIN_VOLT)/ 4) 
#define HL_BAT_ST_LIM1    0x01 
#define HL_BAT_V_LIM1     HL_BAT_MIN_VOLT + (1 * (HL_BAT_MIN_GPS_VOLT - HL_BAT_MIN_VOLT)/ 4)
#define HL_BAT_ST_EMPTY   0x00 
#define HL_BAT_V_EMPTY    HL_BAT_MIN_VOLT 

#define HL_BAT_ST_MASK    0x0F  //!< Battery State bits
#define HL_BAT_UPDATE     0x80  //!< Check Bat Condition when set (xpal_bat internal bit)
#define HL_BAT_NEWSTAT    0x40  //!< Status is new and returned for the first time
#define HL_BAT_BLED_OFF   0x20  //!< Notice that Battery level is fast decreasing 
#define HL_BAT_GPS_STOP   0x10  //!< Notice that GPS will be powered off

extern volatile uint8_t         BatStatus;              

extern volatile uint16_t        BatVoltage;             
extern volatile int16_t         BatGradient;    
extern volatile int16_t         BatGradientTimer;       

void hl_InitBatMan(void);

uint8_t hl_bat_GetBatStatus(void);


inline uint16_t hl_pwr_GetBatVoltage(void){
        return (BatVoltage & ~HL_BAT_MEASURE_ACTIVE);
};


inline uint16_t hl_pwr_GetBatGradient(void){
        return BatGradient;
};

extern int8_t adc_calibration;

inline uint16_t hl_adc_correct (uint16_t r)
{
  return r + ((int32_t)r * adc_calibration >> 8);
}

#define HL_BAT_MV_PER_DIGIT 5

inline uint16_t hl_adc_convert (uint16_t r)
{
  return (r * HL_BAT_MV_PER_DIGIT);
}

#endif