Revision 1417
fixed doxygen to call bom refresh
trunk/code/projects/libdragonfly/bom.c | ||
---|---|---|
157 | 157 |
/** |
158 | 158 |
* Iterates through each bit in the bit_field. For each set bit, sets the corresponding bom select bits |
159 | 159 |
* and updates the corresponding bom value with an analog_get8 reading. analog_init and bom_init |
160 |
* must be called for this to work. |
|
160 |
* must be called for this to work. Must call this before reading BOM values!
|
|
161 | 161 |
* |
162 | 162 |
* |
163 | 163 |
* @param bit_field specifies which elements in bom_val[] should be updated. Use BOM_ALL to refresh all values. |
... | ... | |
192 | 192 |
/** |
193 | 193 |
* Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new bom values. |
194 | 194 |
* |
195 |
* @pre must call bom refresh first |
|
196 |
* |
|
195 | 197 |
* @param which which bom value to return |
196 | 198 |
* |
197 | 199 |
* @return the bom value |
... | ... | |
205 | 207 |
/** |
206 | 208 |
* Compares all the values in bom_val[] and returns the index to the lowest (max) value element. |
207 | 209 |
* |
210 |
* @pre must call bom refresh |
|
208 | 211 |
* @return index to the lowest (max) bom value element. -1 if no value is lower than |
209 | 212 |
* BOM_VALUE_THRESHOLD |
210 | 213 |
**/ |
trunk/code/projects/libdragonfly/bom.h | ||
---|---|---|
71 | 71 |
/** @brief Enables the selected bom leds on a BOM1.5 **/ |
72 | 72 |
void bom_set_leds(int bit_field); |
73 | 73 |
|
74 |
/** @brief (DEPRECATED) Gets and compares all bom values. Returns the index to the highest value element. **/ |
|
74 |
/** @brief (DEPRECATED) Gets and compares all bom values. Returns the index to the highest value element since last refresh. **/
|
|
75 | 75 |
int get_max_bom(void); |
76 | 76 |
|
77 | 77 |
/** @brief Turns on all BOM leds, or turns on enabled leds on a BOM1.5. **/ |
Also available in: Unified diff