Revision 948
Added symbolic links to the odometry in mapping to the library, and provided documentation.
odometry.h | ||
---|---|---|
1 | 1 |
|
2 |
/** |
|
3 |
* @file odometry.h |
|
4 |
* @brief Code for estimating the robots pose. |
|
5 |
* |
|
6 |
* Offers simple position and orientation information. |
|
7 |
* |
|
8 |
* @author Colony Project, CMU Robotics Club |
|
9 |
**/ |
|
10 |
|
|
2 | 11 |
#ifndef __ODOMETRY_C__ |
3 | 12 |
#define __ODOMETRY_C__ |
4 | 13 |
|
... | ... | |
19 | 28 |
|
20 | 29 |
//Standard measures will be mm and us |
21 | 30 |
|
31 |
/** @brief Retrieve the robots estimated x position*/ |
|
22 | 32 |
long odometry_dx(void); |
33 |
/** @brief Retrieve the robots estimated y position*/ |
|
23 | 34 |
long odometry_dy(void); |
35 |
/** @brief Retrieve the robots estimated orientation*/ |
|
24 | 36 |
double odometry_angle(void); |
37 |
/** @brief Initialize odometry. MUST be called before |
|
38 |
* the other functions work.**/ |
|
25 | 39 |
void odometry_init(void); |
40 |
/** @brief Reset position and orientation to the origin facing |
|
41 |
* the x axis.*/ |
|
26 | 42 |
void odometry_reset(void); |
27 | 43 |
|
28 | 44 |
#endif |
Also available in: Unified diff