root / branches / autonomous_recharging / code / projects / autonomous_recharging / dragonfly / wl_recharge_group.h @ 734
History | View | Annotate | Download (1.41 KB)
1 | 93 | jykong | /**
|
---|---|---|---|
2 | * @file wl_recharge_group.h
|
||
3 | * @brief A packet group for recharging messages.
|
||
4 | *
|
||
5 | * A packet group for sending and receiving recharging
|
||
6 | * messages.
|
||
7 | *
|
||
8 | * @author Brian Coltin, Colony Project, CMU Robotics Club
|
||
9 | **/
|
||
10 | |||
11 | /**
|
||
12 | * @defgroup wlrecharge Recharging Packets
|
||
13 | * @brief Functions for sending and receiving recharging packets
|
||
14 | *
|
||
15 | * Functions for sending and receiving recharging packets.
|
||
16 | *
|
||
17 | * @{
|
||
18 | **/
|
||
19 | |||
20 | /** The robot is not attempting to recharging. **/
|
||
21 | #define NOT_RECHARGING 0 |
||
22 | /** Waiting for an available charging station. **/
|
||
23 | #define POLLING 1 |
||
24 | /** Requesting to dock with a charging station. **/
|
||
25 | #define REQUESTING 2 |
||
26 | /** Traveling to a charging station. **/
|
||
27 | #define SEEKING 3 |
||
28 | /** Docked with a charging station. **/
|
||
29 | #define DOCKED 4 |
||
30 | /** Leaving a charging station. **/
|
||
31 | #define DEPARTING 5 |
||
32 | |||
33 | |||
34 | /**@brief Register this packet group with the wireless library **/
|
||
35 | void wl_recharge_register(void); |
||
36 | /**@brief Unregister this packet group with the wireless library **/
|
||
37 | void wl_recharge_unregister(void); |
||
38 | /**@brief Begin charging **/
|
||
39 | void wl_recharge_begin(void); |
||
40 | /**@brief Stop recharging **/
|
||
41 | void wl_recharge_stop(void); |
||
42 | /**@brief Robot has docked **/
|
||
43 | void wl_recharge_dock(void); |
||
44 | /**@brief Robot has departed station **/
|
||
45 | void wl_recharge_depart(void); |
||
46 | /**@brief Get the current robot state **/
|
||
47 | int wl_recharge_get_state(void); |
||
48 | 100 | bcoltin | /**@brief Get the station we are homing to **/
|
49 | int wl_recharge_get_station(void); |
||
50 | 93 | jykong | |
51 | /** @} **/ // end defgroup |