Colony

// FIXME remove

typedef unsigned char uint8_t;

/**

 * Copyright (c) 2007 Colony Project

 * 

 * Permission is hereby granted, free of charge, to any person

 * obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without

 * restriction, including without limitation the rights to use,

 * copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the

 * Software is furnished to do so, subject to the following

 * conditions:

 * 

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 * 

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 * OTHER DEALINGS IN THE SOFTWARE.

 **/

/**

 * @file lights.h

 * @brief Contains declarations for managing the orbs.

 *

 * Contains declarations for using the orbs and PWM.

 *

 * @author Colony Project, CMU Robotics Club

 * Based on Firefly Library, by Tom Lauwers and Steven Shamlian

 **/

#ifndef _LIGHTS_H_

#define _LIGHTS_H_

/**

 * @addtogroup orbs

 * @{

 **/

// ***** Predefined colors *****

/** @brief Red **/

#define RED       0xE0

/** @brief Orange **/

#define ORANGE    0xE4

/** @brief Yellow **/

#define YELLOW    0xE8

/** @brief Lime **/

#define LIME      0x68

/** @brief Green **/

#define GREEN     0x1C

/** @brief Cyan **/

#define CYAN      0x1F

/** @brief Blue **/

#define BLUE      0x03

/** @brief Pink **/

#define PINK      0xA6 

/** @brief Purple **/

#define PURPLE    0x41

/** @brief Magenta **/

#define MAGENTA   0xE3

/** @brief White **/

#define WHITE     0xFE

/** @brief Turn the orb off **/

#define ORB_OFF   0x00

// ***** Initialization *****

/** @brief Enables the orbs in default mode **/

void orb_init(void);

/** @brief Enables the orbs in binary mode **/

void orb_init_binary (void);

/** @brief Enables the orbs in PWM mode **/

void orb_init_pwm (void);

// ***** Mode setting *****

/** Specification of the orb mode **/

typedef uint8_t orb_mode_t;

/** @brief PWM mode **/

#define orb_mode_pwm 0

/** @brief Binary mode **/

#define orb_mode_binary 1

/** @brief Switches the orbs to the specified mode **/

void orb_set_mode (orb_mode_t mode);

/** @brief Disables the orb timer, but does not change the mode **/

void orb_disable_timer (void);

/** @brief Enables the orb timer, but does not change the mode **/

void orb_enable_timer (void);

// ***** Setting RGB colors *****

/** @brief set the specified orb to a specified color **/

void orb_n_set (uint8_t num, uint8_t red, uint8_t green, uint8_t blue);

/** @brief Set both orbs to a specified color **/

void orb_set(uint8_t red, uint8_t green, uint8_t blue);

/** @brief Set orb1 to a specified color **/

void orb1_set(uint8_t red_led, uint8_t green_led, uint8_t blue_led); 

/** @brief Set orb2 to a specified color **/

void orb2_set(uint8_t red_led, uint8_t green_led, uint8_t blue_led);

void orbs_set (uint8_t red1, uint8_t green1, uint8_t blue1, uint8_t red2, uint8_t green2, uint8_t blue2);

// ***** Settings predefined colors *****

/** @brief set the specified orb to the specified color **/

void orb_n_set_color(uint8_t num, uint8_t col);

/** @brief Set orb1 to a specified color **/

void orb1_set_color(uint8_t col);

/** @brief Set orb2 to a specified color **/

void orb2_set_color(uint8_t col);

/** @brief set the orbs to specified colors **/

void orbs_set_color(uint8_t col1, uint8_t col2);

/** @brief Set both orbs to a specified color **/

void orb_set_color(uint8_t col);

/** @} **/ //end addtogroup

#endif