Revision 568
updated comments for BOM wrapper functions. no compiler warnings since they just call the new code.
| trunk/code/projects/libdragonfly/bom.c | ||
|---|---|---|
| 154 | 154 |
* |
| 155 | 155 |
* @return the bom value |
| 156 | 156 |
* |
| 157 |
* see bom_refresh |
|
| 157 |
* @see bom_refresh
|
|
| 158 | 158 |
**/ |
| 159 | 159 |
int bom_get(int which) {
|
| 160 | 160 |
return bom_val[which]; |
| ... | ... | |
| 162 | 162 |
|
| 163 | 163 |
/** |
| 164 | 164 |
* Compares all the values in bom_val[] and returns the index to the lowest (max) value element. |
| 165 |
* |
|
| 165 |
* Returns the direction of the maximum BOM reading,as an integer in the range 0-15. 0 indicates |
|
| 166 |
* to the robot's right, while the rest of the sensors are numbered counterclockwise. |
|
| 167 |
* |
|
| 166 | 168 |
* @return index to the lowest (max) bom value element. -1 if no value is lower than |
| 167 | 169 |
* BOM_VALUE_THRESHOLD |
| 168 | 170 |
**/ |
| ... | ... | |
| 231 | 233 |
|
| 232 | 234 |
|
| 233 | 235 |
/** |
| 234 |
* (DEPRECATED) Returns the direction of the maximum BOM reading, |
|
| 235 |
* as an integer in the range 0-15. 0 indicates to the |
|
| 236 |
* robot's right, while the rest of the sensors are |
|
| 237 |
* numbered counterclockwise. This is useful for determining |
|
| 238 |
* the direction of a robot flashing its BOM, of only one |
|
| 239 |
* robot is currently doing so. analog_init must be called |
|
| 240 |
* before this function can be used. |
|
| 236 |
* (DEPRECATED) Wrapper function for new BOM code. Refreshes buffer and returns the max bom value. |
|
| 241 | 237 |
* |
| 242 | 238 |
* @return the direction of the maximum BOM reading |
| 243 | 239 |
* |
| 244 |
* @see analog_init
|
|
| 240 |
* @see bom_refresh, bom_get_max
|
|
| 245 | 241 |
**/ |
| 246 | 242 |
int get_max_bom(void) {
|
| 247 | 243 |
bom_refresh(BOM_ALL); |
| trunk/code/projects/libdragonfly/bom.h | ||
|---|---|---|
| 65 | 65 |
/** @brief Turns off the selected bom leds. Only works with BOM_ALL if using the original bom. **/ |
| 66 | 66 |
void bom_leds_off(int bit_field); |
| 67 | 67 |
|
| 68 |
/** @brief (DEPRECATED) Gets and compares all bom values. Returns the index to the highest value element. **/
|
|
| 68 |
/** @brief (DEPRECATED) Wrapper function. See bom_refresh and bom_get_max **/
|
|
| 69 | 69 |
int get_max_bom(void); |
| 70 |
/** @brief (DEPRECATED) Turns on all bom leds. **/
|
|
| 70 |
/** @brief (DEPRECATED) Wrapper function. See bom_leds_on. **/
|
|
| 71 | 71 |
void bom_on(void); |
| 72 |
/** @brief (DEPRECATED) Turns off all bom leds. **/
|
|
| 72 |
/** @brief (DEPRECATED) Wrapper function. See bom_leds_off. **/
|
|
| 73 | 73 |
void bom_off(void); |
| 74 | 74 |
|
| 75 | 75 |
/** @} **/ |
Also available in: Unified diff