root / include / libdragonfly / rangefinder.h @ 1554
History | View | Annotate | Download (2.19 KB)
1 | 1554 | gnagaraj | /**
|
---|---|---|---|
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 rangefinder.h
|
||
29 | * @brief Contains rangefinder declarations and functions
|
||
30 | *
|
||
31 | * Contains functions and definitions for the use of
|
||
32 | * IR rangefinders.
|
||
33 | *
|
||
34 | * @author Colony Project, CMU Robotics Club
|
||
35 | **/
|
||
36 | |||
37 | #ifndef _RANGEFINDER_H_
|
||
38 | #define _RANGEFINDER_H_
|
||
39 | |||
40 | /**
|
||
41 | * @addtogroup rangefinder
|
||
42 | * @{
|
||
43 | **/
|
||
44 | |||
45 | /** @brief IR Rangefinder 1 **/
|
||
46 | #define IR1 6 |
||
47 | /** @brief IR Rangefinder 2 **/
|
||
48 | #define IR2 5 |
||
49 | /** @brief IR Rangefinder 3 **/
|
||
50 | #define IR3 4 |
||
51 | /** @brief IR Rangefinder 4 **/
|
||
52 | #define IR4 3 |
||
53 | /** @brief IR Rangefinder 5 **/
|
||
54 | #define IR5 2 |
||
55 | /** @brief smallest meaningful rangefinder reading (logarithmic scale) **/
|
||
56 | #define MIN_IR_ADC8 20 |
||
57 | /** @brief largest meaningful rangefinder reading (logarithmic scale) **/
|
||
58 | #define MAX_IR_ADC8 133 |
||
59 | |||
60 | /** @brief Initialize the rangefinders **/
|
||
61 | void range_init(void); |
||
62 | /** @brief Read the distance from a rangefinder **/
|
||
63 | int range_read_distance(int range_id); |
||
64 | /** @brief Convert logarithmic-scale distance readings to a linear scale **/
|
||
65 | int linearize_distance(int value); |
||
66 | |||
67 | /** @} **/ //end addtogroup |
||
68 | |||
69 | #endif
|