root / trunk / code / projects / libdragonfly / battery.h @ 241
History | View | Annotate | Download (1.92 KB)
1 |
/**
|
---|---|
2 |
* Copyright (c) 2007 Colony Project
|
3 |
*
|
4 |
* Permission is hereby granted, free of charge, to any person
|
5 |
* obtaining a copy of this software and associated documentation
|
6 |
* files (the "Software"), to deal in the Software without
|
7 |
* restriction, including without limitation the rights to use,
|
8 |
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9 |
* copies of the Software, and to permit persons to whom the
|
10 |
* Software is furnished to do so, subject to the following
|
11 |
* conditions:
|
12 |
*
|
13 |
* The above copyright notice and this permission notice shall be
|
14 |
* included in all copies or substantial portions of the Software.
|
15 |
*
|
16 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17 |
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
18 |
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19 |
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
20 |
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
21 |
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
22 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
23 |
* OTHER DEALINGS IN THE SOFTWARE.
|
24 |
**/
|
25 |
|
26 |
|
27 |
/**
|
28 |
* @file battery.h
|
29 |
* @brief Definitions for checking battery voltage.
|
30 |
*
|
31 |
* Contains definitions for checking the voltage of the
|
32 |
* battery.
|
33 |
*
|
34 |
* @author Colony Project, CMU Robotics Club
|
35 |
**/
|
36 |
|
37 |
#ifndef _BATTERY_H_
|
38 |
#define _BATTERY_H_
|
39 |
|
40 |
/**
|
41 |
* @addtogroup battery
|
42 |
* @{
|
43 |
**/
|
44 |
|
45 |
/** @brief Normal battery voltage. (6 V) **/
|
46 |
#define BATTERY_NORMALV 154 |
47 |
/** @brief Charging battery voltage. (7 V) **/
|
48 |
#define BATTERY_CHARINGV 179 |
49 |
/** @brief Low battery voltage. ( < 6 V) **/
|
50 |
#define BATTERY_LOWV 152 |
51 |
|
52 |
/** @brief Read the battery voltage. **/
|
53 |
int battery8(void); |
54 |
/** @brief Read the battery voltage in deciVolts. **/
|
55 |
int battery(void); |
56 |
/** @brief Check if the battery is low. **/
|
57 |
char battery_low(void); |
58 |
/** @brief Get an average battery voltage reading. **/
|
59 |
int battery8_avg(int n_samples); |
60 |
|
61 |
/** @} **/ //end addtogroup |
62 |
|
63 |
#endif
|
64 |
|