Revision 891
Moved comments to headers. That was painful.
| rangefinder.h | ||
|---|---|---|
| 38 | 38 |
#define _RANGEFINDER_H_ |
| 39 | 39 |
|
| 40 | 40 |
/** |
| 41 |
* @addtogroup rangefinder |
|
| 41 |
* @defgroup rangefinder Rangefinder |
|
| 42 |
* @brief Functions for using the IR rangefinders |
|
| 43 |
* |
|
| 44 |
* Functions for using the IR rangefinders. |
|
| 45 |
* |
|
| 42 | 46 |
* @{
|
| 43 | 47 |
**/ |
| 44 | 48 |
|
| 49 |
|
|
| 45 | 50 |
/** @brief IR Rangefinder 1 **/ |
| 46 | 51 |
#define IR1 6 |
| 47 | 52 |
/** @brief IR Rangefinder 2 **/ |
| ... | ... | |
| 53 | 58 |
/** @brief IR Rangefinder 5 **/ |
| 54 | 59 |
#define IR5 2 |
| 55 | 60 |
|
| 56 |
/** @brief Initialize the rangefinders **/ |
|
| 61 |
/** |
|
| 62 |
* @brief Initialize the rangefinders |
|
| 63 |
* |
|
| 64 |
* Initializes the rangefinders. This must be called before |
|
| 65 |
* range_read_distance. |
|
| 66 |
* |
|
| 67 |
* @see range_read_distance |
|
| 68 |
**/ |
|
| 57 | 69 |
void range_init(void); |
| 58 |
/** @brief Read the distance from a rangefinder **/ |
|
| 70 |
/** |
|
| 71 |
* @brief Read the distance from a rangefinder |
|
| 72 |
* |
|
| 73 |
* Reads the distance measured by one of the rangefinders. |
|
| 74 |
* This distance is in arbitrary units. |
|
| 75 |
* |
|
| 76 |
* @param range_id the rangefinder to use. This should be one |
|
| 77 |
* of the constants IR1 - IR5. |
|
| 78 |
* |
|
| 79 |
* @return the distance measured by the rangefinder |
|
| 80 |
* |
|
| 81 |
* @see range_init |
|
| 82 |
**/ |
|
| 59 | 83 |
int range_read_distance(int range_id); |
| 60 | 84 |
|
| 61 | 85 |
/** @} **/ //end addtogroup |
Also available in: Unified diff