root / demos / john / projects / libwireless / lib / xbee.h @ 1692
History | View | Annotate | Download (3.29 KB)
1 |
/**
|
---|---|
2 |
* Copyright (c) 2007 Colony Project
|
3 |
*
|
4 |
* Permission is hereby granted, free of charge, to any person
|
5 |
* obtaining a copy of this software and associated documentation
|
6 |
* files (the "Software"), to deal in the Software without
|
7 |
* restriction, including without limitation the rights to use,
|
8 |
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9 |
* copies of the Software, and to permit persons to whom the
|
10 |
* Software is furnished to do so, subject to the following
|
11 |
* conditions:
|
12 |
*
|
13 |
* The above copyright notice and this permission notice shall be
|
14 |
* included in all copies or substantial portions of the Software.
|
15 |
*
|
16 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17 |
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
18 |
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19 |
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
20 |
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
21 |
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
22 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
23 |
* OTHER DEALINGS IN THE SOFTWARE.
|
24 |
**/
|
25 |
|
26 |
/**
|
27 |
* @file xbee.h
|
28 |
* @brief Contains definitions for using the XBee
|
29 |
*
|
30 |
* Contains definitions for interfacing with the
|
31 |
* XBee module, from either a robot or a computer.
|
32 |
* To use a robot, define ROBOT in wl_defs.h, and
|
33 |
* to use a computer, don't define ROBOT.
|
34 |
*
|
35 |
* @author Brian Coltin, Colony Project, CMU Robotics Club
|
36 |
**/
|
37 |
|
38 |
#ifndef XBEE_H
|
39 |
#define XBEE_H
|
40 |
|
41 |
/**
|
42 |
* The port to use the XBee from on the computer.
|
43 |
* Also, a backup port if the other is used.
|
44 |
**/
|
45 |
#ifndef ROBOT
|
46 |
#define XBEE_PORT_DEFAULT "/dev/ttyUSB1" |
47 |
#endif
|
48 |
|
49 |
/**
|
50 |
* @defgroup xbee XBee
|
51 |
* @brief Interface with the XBee module
|
52 |
*
|
53 |
* Interface with the XBee module.
|
54 |
*
|
55 |
* @{
|
56 |
**/
|
57 |
|
58 |
/*Definitions*/
|
59 |
/**@brief Unset PAN, uses XBee default **/
|
60 |
#define XBEE_PAN_DEFAULT 0xFFFF |
61 |
/**@brief Unset channel, uses XBee default **/
|
62 |
#define XBEE_CHANNEL_DEFAULT 0 |
63 |
/**@brief Broadcast to all robots in the PAN **/
|
64 |
#define XBEE_BROADCAST 0xFFFF |
65 |
/**@brief No special options **/
|
66 |
#define XBEE_OPTIONS_NONE 0x00 |
67 |
/**@brief Do not receive a TX_STATUS message from this packet **/
|
68 |
#define XBEE_OPTIONS_DISABLE_RESPONSE 0x01 |
69 |
/**@brief Send the packet to all PANS **/
|
70 |
#define XBEE_OPTIONS_BROADCAST_ALL_PANS 0x04 |
71 |
/**@brief A transmit status packet **/
|
72 |
#define XBEE_TX_STATUS 0x89 |
73 |
/**@brief A packet received from another XBee **/
|
74 |
#define XBEE_RX 0x81 |
75 |
|
76 |
/**@brief Initialize the XBee library **/
|
77 |
int xbee_lib_init(void); |
78 |
/**@brief Uninitialize the XBee library **/
|
79 |
void xbee_terminate(void); |
80 |
/**@brief Get a packet from the XBee **/
|
81 |
int xbee_get_packet(unsigned char* packet); |
82 |
/**@brief Send a packet to the XBee **/
|
83 |
int xbee_send_packet(char* packet, int len, int dest, char options, char frame); |
84 |
/**@brief Set the PAN ID for the XBee **/
|
85 |
int xbee_set_pan_id(int id); |
86 |
/**@brief Get the XBee's PAN ID **/
|
87 |
unsigned int xbee_get_pan_id(void); |
88 |
/**@brief Set the channel the XBee is currently using **/
|
89 |
int xbee_set_channel(int channel); |
90 |
/**@brief Get the channel the XBee is currently using **/
|
91 |
int xbee_get_channel(void); |
92 |
/**@brief Get the XBee's 16-bit address **/
|
93 |
unsigned int xbee_get_address(void); |
94 |
/**@brief Set the com port on a computer, undefined on the robot**/
|
95 |
void xbee_set_com_port(char* port); |
96 |
/**@brief Reset XBee **/
|
97 |
int xbee_reset(void); |
98 |
|
99 |
/**@}**/ //end defgroup |
100 |
|
101 |
#endif
|