root / trunk / code / projects / libdragonfly / bom.h @ 1266
History | View | Annotate | Download (2.57 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 bom.h
|
29 |
* @brief Definitions for using the BOM
|
30 |
*
|
31 |
* This file contains definitions for using the Bearing and
|
32 |
* Orientation Module (BOM).
|
33 |
*
|
34 |
* @author Colony Project, CMU Robotics Club
|
35 |
*
|
36 |
**/
|
37 |
|
38 |
#ifndef _BOM_H
|
39 |
#define _BOM_H
|
40 |
|
41 |
/**
|
42 |
* @addtogroup bom
|
43 |
* @{
|
44 |
**/
|
45 |
|
46 |
/** @brief Include all elements in the 16-bit bitfield **/
|
47 |
#define BOM_ALL 0xFFFF |
48 |
|
49 |
/** @brief Original BOM - No Range, No Individual LED control **/
|
50 |
#define BOM10 0 |
51 |
|
52 |
/** @brief BOM 1.5 - No Range, Individual LED control **/
|
53 |
#define BOM15 1 |
54 |
|
55 |
/** @brief RBOM - Range, Individual LED control **/
|
56 |
#define RBOM 2 |
57 |
|
58 |
|
59 |
/** @brief Initialize the bom according to bom type **/
|
60 |
void bom_init(char type); |
61 |
|
62 |
/** @brief Refresh bom_val[] with new values from analog8. analog_init and bom_init must be called for this to work. **/
|
63 |
void bom_refresh(int bit_field); |
64 |
|
65 |
/** @brief Gets the bom reading from bom_val[which]. Call bom_refresh beforehand to read new bom values. **/
|
66 |
int bom_get(int which); |
67 |
|
68 |
/** @brief Compares all the values in bom_val[] and returns the index to the highest value element. **/
|
69 |
int bom_get_max(void); |
70 |
|
71 |
/** @brief Enables the selected bom leds on a BOM1.5 **/
|
72 |
void bom_set_leds(int bit_field); |
73 |
|
74 |
/** @brief (DEPRECATED) Gets and compares all bom values. Returns the index to the highest value element. **/
|
75 |
int get_max_bom(void); |
76 |
|
77 |
/** @brief Turns on all BOM leds, or turns on enabled leds on a BOM1.5. **/
|
78 |
void bom_on(void); |
79 |
|
80 |
/** @brief Turns off all bom leds. **/
|
81 |
void bom_off(void); |
82 |
|
83 |
/** @} **/
|
84 |
|
85 |
#endif
|
86 |
|