scoutos / scout / sonar / src / sonar.h @ 85538662
History | View | Annotate | Download (1.85 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 sonar.h
|
29 |
* @brief Contains sonar declarations and functions
|
30 |
*
|
31 |
* Contains functions and definitions for the use of
|
32 |
* sonar
|
33 |
*
|
34 |
* @author Colony Project, CMU Robotics Club
|
35 |
**/
|
36 |
|
37 |
#ifndef _SONAR_H_
|
38 |
#define _SONAR_H_
|
39 |
|
40 |
/** @brief Initialize the sonar in the library module **/
|
41 |
void sonar_init(void); |
42 |
|
43 |
/** @brief Initialize the sonar module and drivers **/
|
44 |
void sonar_module_init(void); |
45 |
|
46 |
/** @brief Read raw sonar data from the sonar module. Takes stepper
|
47 |
** position and sensor to read **/
|
48 |
int sonar_read_raw(int direction, int sensor); |
49 |
|
50 |
/** @brief Wrapper for reading sonar data (angle in degrees and distance in
|
51 |
** cm) **/
|
52 |
int sonar_read(int direction); |
53 |
|
54 |
/** @brief Subscribe function to sonar topic **/
|
55 |
void sonar_subscribe(int *function()); |
56 |
|
57 |
#endif
|