Colony

/**

 * Copyright (c) 2007 Colony Project

 * 

 * Permission is hereby granted, free of charge, to any person

 * obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without

 * restriction, including without limitation the rights to use,

 * copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the

 * Software is furnished to do so, subject to the following

 * conditions:

 * 

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 * 

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 * OTHER DEALINGS IN THE SOFTWARE.

 **/

/**

 * @file battery.h

 * @brief Definitions for checking battery voltage.

 * 

 * Contains definitions for checking the voltage of the 

 * battery.

 *

 * @author Colony Project, CMU Robotics Club

 **/

#ifndef _BATTERY_H_

#define _BATTERY_H_

/**

 * @defgroup battery Battery

 * @brief Functions for reading battery voltage.

 * 

 * Contains functions for checking the current

 * voltage of the battery. Include battery.h to

 * access these functions.

 *

 * @{

 **/

/** @brief Normal battery voltage. (6 V) **/

#define BATTERY_NORMALV 154

/** @brief Charging battery voltage. (7 V) **/

#define BATTERY_CHARINGV 179

/** @brief Low battery voltage. ( < 6 V) **/

#define BATTERY_LOWV 152

/**

 * @brief Read the battery voltage.

 *

 * Returns the voltage of the battery as an analog8

 * reading. 128 is approximately 5 volts. analog_init

 * must be called before using this function.

 *

 * @return the voltage of the battery as an analog8

 * reading

 *

 * @see analog_init, battery, analog8

 **/

int battery8(void);

/**

 * @brief Read the battery voltage in deciVolts.

 *

 * Returns the voltage of the battery in deciVolts.

 * analog_init must be called before using this function.

 *

 * @return the voltage of the battery in deciVolts.

 *

 * @see analog_init, battery8

 **/

int battery(void);

/**

 * @brief Check if the battery is low.

 *

 * Checks if the battery is low. analog_init must be called before

 * this function can be used. This function waits for several low

 * battery readings in a row to avoid false positives.

 *

 * @return 1 if the battery is low, 0 otherwise

 *

 * @see analog_init

 **/

char battery_low(void);

/**

 * @brief Get an average battery voltage reading.

 *

 * Averages n_samples battery8 readings. This function may

 * take a while to complete, and is only made available

 * for convenience. analog_init must be called before this

 * function may be used.

 *

 * @param n_samples the number of times to sample the battery voltage

 *

 * @return the average reading for the battery voltage, where 128

 * is approximately 5 Volts.

 *

 * @see analog_init, battery

 **/

int battery8_avg(int n_samples);

/** @} **/ //end addtogroup

#endif