Project

General

Profile

Revision 241

Updated libdragonfly documentation.

View differences:

battery.c
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.c
29
 * @brief Implementation for reading battery level
30
 *
31
 * Contains functions for reading the battery level.
32
 *
33
 * @author Colony Project, CMU Robotics Club
34
 **/
35

  
1 36
#include "battery.h"
2 37
#include "analog.h"
3 38

  
......
96 131
 * for convenience. analog_init must be called before this
97 132
 * function may be used.
98 133
 *
99
 * @param n_samples The number of times to sample the battery voltage
134
 * @param n_samples the number of times to sample the battery voltage
100 135
 *
101 136
 * @return the average reading for the battery voltage, where 128
102 137
 * is approximately 5 Volts.

Also available in: Unified diff