Colony

/**

 * Copyright (c) 2009 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 xbee.h

 * @brief Contains definitions for using the XBee

 *

 * Contains definitions for interfacing with the

 * XBee module, from either a robot or a computer.

 * To use a robot, define ROBOT in wl_defs.h, and

 * to use a computer, don't define ROBOT.

 *

 * @author Colony Project, CMU Robotics Club

 **/

#ifndef XBEE_H

#define XBEE_H

// need this for C99 int types

#ifndef STDINT_H

#define STDINT_H

#include <stdint.h>

#endif

/**

 * @defgroup xbee XBee

 * @brief Interface with the XBee module

 *

 * Interface with the XBee module.

 *

 * @{

 **/

 /**@defgroup xbee_const xbee constants

  * @brief These are constants used for the xbee module.

  * @{ **/

#ifndef XBEE_BAUD

/** @brief The XBee baud rate **/

#define XBEE_BAUD 115200

#endif

/**@name xbee options

 * @{ **/

/**@brief Unset PAN, uses XBee default **/

#define XBEE_PAN_DEFAULT 0xFFFF

/**@brief Unset channel, uses XBee default **/

#define XBEE_CHANNEL_DEFAULT 0

/**@brief Broadcast to all robots in the PAN **/

#define XBEE_BROADCAST 0xFFFF

/**@brief No special options **/

#define XBEE_OPTIONS_NONE 0x00

/**@brief Do not receive a TX_STATUS message from this packet **/

#define XBEE_OPTIONS_DISABLE_RESPONSE 0x01

/**@brief Send the packet to all PANS **/

#define XBEE_OPTIONS_BROADCAST_ALL_PANS 0x04

/**@brief A transmit status packet **/

#define XBEE_TX_STATUS 0x89

/**@brief A packet received from another XBee **/

#define XBEE_RX 0x81

/**@}

 * @name xbee frame types

 * @{ **/

// TODO: add comments for all of these definitions

/*Frame Types*/

#define XBEE_FRAME_START 0x7E

#define XBEE_FRAME_STATUS 0x8A

#define XBEE_FRAME_AT_COMMAND 0x08

#define XBEE_FRAME_AT_COMMAND_RESPONSE 0x88

#define XBEE_FRAME_TX_REQUEST_64 0x00

#define XBEE_FRAME_TX_REQUEST_16 0x01

#define XBEE_FRAME_TX_STATUS XBEE_TX_STATUS

#define XBEE_FRAME_RX_64 0x80

#define XBEE_FRAME_RX_16 XBEE_RX

/** @} **/

/**@} **/ // end const group

/**

 * @defgroup xbee_funcs Xbee Functions

 * @brief These are the public xbee functions.

 * @{

 **/

// TODO: convert all int references to int16_t syntax (see stdint.h)

/**@brief Initialize the XBee library **/

int8_t xbee_init(void);

/**@brief Uninitialize the XBee library **/

int8_t xbee_terminate(void);

/**@brief Send a byte to the xbee **/

int8_t xbee_putc(uint8_t c);

/**@brief Read a byte form the xbee **/

int16_t xbee_getc(void);

/**@brief Read a byte from the xbee (nonblocking) **/

int8_t xbee_getc_nb(uint8_t *c);

/**@brief Send an array of bytes to the xbee **/

static int8_t xbee_send(uint8_t* buf, uint16_t size);

/**@brief Add a buffer to the checksum value **/

static int8_t xbee_checksum_add(uint8_t *buf, uint8_t len, uint8_t* sum);

/**@brief Send a frame header to the xbee **/

static int8_t xbee_send_header(uint8_t type, uint16_t len);

/**@brief Send a packet to the XBee **/

int8_t xbee_send_packet(uint8_t* packet, uint8_t len, uint16_t dest, uint8_t options, uint8_t frame);

/**@brief Set the PAN ID for the XBee **/

int8_t xbee_set_pan_id(uint16_t id);

/**@brief Get the XBee's PAN ID **/

uint16_t xbee_get_pan_id(void);

/**@brief Set the channel the XBee is currently using **/

int8_t xbee_set_channel(uint8_t channel);

/**@brief Get the channel the XBee is currently using **/

int8_t xbee_get_channel(void);

/**@brief Get the XBee's 16-bit address **/

uint16_t xbee_get_address(void);

/**@brief Reset XBee **/

int8_t xbee_reset(void); // TODO: implement this function

/**@} **/ //end xbee_funcs group

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

#endif