Colony

/**

 * @file wl_recharge_group.h

 * @brief A packet group for recharging messages.

 *

 * A packet group for sending and receiving recharging 

 * messages.

 *

 * @author Brian Coltin, Colony Project, CMU Robotics Club

 **/

/**

 * @defgroup wlrecharge Recharging Packets

 * @brief Functions for sending and receiving recharging packets

 * 

 * Functions for sending and receiving recharging packets.

 * 

 * @{

 **/

/** The robot is not attempting to recharging. **/

#define NOT_RECHARGING 0

/** Waiting for an available charging station. **/

#define POLLING 1

/** Requesting to dock with a charging station. **/

#define REQUESTING 2

/** Traveling to a charging station. **/

#define SEEKING 3

/** Docked with a charging station. **/

#define DOCKED 4

/** Leaving a charging station. **/

#define DEPARTING 5

/**@brief Register this packet group with the wireless library **/

void wl_recharge_register(void);

/**@brief Unregister this packet group with the wireless library **/

void wl_recharge_unregister(void);

/**@brief Begin charging **/

void wl_recharge_begin(void);

/**@brief Stop recharging **/

void wl_recharge_stop(void);

/**@brief Robot has docked **/

void wl_recharge_dock(void);

/**@brief Robot has departed station **/

void wl_recharge_depart(void);

/**@brief Get the current robot state **/

int wl_recharge_get_state(void);

/**@brief Get the station we are homing to **/

int wl_recharge_get_station(void);

/** @} **/ // end defgroup