Colony

/**

 * @file charging.h Charging

 *

 * @brief Charging station functions

 *

 * Contains functions for the charging station, controlling

 * bay management, homing beacons and BOMS.

 **/

/**

 * @defgroup charging Charging Station

 * 

 * @brief Charging Station Functionality

 *

 * Contains functions for the charging station,

 * controlling bay management, the homing beacons

 * and BOMS.

 *

 * @{

 **/

//possible robot states

#define STATE_NOT_CHARGING 1

#define STATE_SEEKING 2

#define STATE_DOCKED 3

/** @brief Initialize charging **/

void charging_init(void);

/** @brief Initialize an iterator through the robots **/

void charging_robot_iterator_init(void);

/** @brief Check if there is another robot to iterate through **/

int charging_robot_iterator_has_next(void);

/** @brief Get the next robot's id **/

int charging_robot_iterator_next(void);

/** @brief Get the verify count for a robot **/

int charging_get_verify_count(int robot);

/** @brief Set the verify count for a robot **/

void charging_set_verify_count(int robot, int count);

/** @brief Cancel charging for a robot **/

void charging_cancel(int robot);

/** @brief Begin seeking for a robot **/

void charging_begin_seeking(int robot);

/** @brief Dock a robot with the charging station **/

void charging_dock(int robot);

/** @brief Check if room is available to charge **/

int charging_is_space_available(void);

/** @brief Check if a robot is currently seeking **/

int charging_is_robot_seeking(void);

/** @brief Get the supposed state of a robot **/

int charging_get_robot_state(int robot);

/** @} **/