root / branches / autonomous_recharging / code / projects / libbayboard / orb.h @ 641
History | View | Annotate | Download (1.64 KB)
1 |
/**
|
---|---|
2 |
* Copyright (c) 2008 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 |
* @file orb.h
|
28 |
* @brief Contains declarations for managing the orbs.
|
29 |
*
|
30 |
* Contains declarations for using the orbs and PWM.
|
31 |
*
|
32 |
* @author Colony Project, CMU Robotics Club
|
33 |
**/
|
34 |
|
35 |
#ifndef _ORB_H_
|
36 |
#define _ORB_H_
|
37 |
|
38 |
/**
|
39 |
* @addtogroup orbs
|
40 |
* @{
|
41 |
**/
|
42 |
|
43 |
/** @brief Enables the orbs **/
|
44 |
int orb_init(void); |
45 |
/** @brief Set both orbs to a specified color **/
|
46 |
int set_orb (int red, int green, int blue); |
47 |
/** @brief Set orb1 to a specified color **/
|
48 |
|
49 |
/** @} **/ //end addtogroup |
50 |
|
51 |
#endif
|