root / branches / wireless / code / projects / libwireless / wireless.h @ 1576
History | View | Annotate | Download (2.37 KB)
1 |
/**
|
---|---|
2 |
* Copyright (c) 2009 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 wireless.h
|
28 |
* @brief Contains definitions for using the wireless library
|
29 |
*
|
30 |
* Contains definitions for interfacing with the
|
31 |
* wireless library.
|
32 |
*
|
33 |
* @author Colony Project, CMU Robotics Club
|
34 |
**/
|
35 |
|
36 |
#ifndef WIRELESS_H
|
37 |
#define WIRELESS_H
|
38 |
|
39 |
// need this for C99 int types
|
40 |
#ifndef STDINT_H
|
41 |
#define STDINT_H
|
42 |
#include <stdint.h> |
43 |
#endif
|
44 |
|
45 |
|
46 |
/**
|
47 |
* @defgroup wireless Wireless
|
48 |
* @brief Interface with the wireless library
|
49 |
*
|
50 |
* Interface with the wireless library.
|
51 |
*
|
52 |
* @{
|
53 |
**/
|
54 |
|
55 |
|
56 |
// TODO: write doxygen comments
|
57 |
|
58 |
// the init function
|
59 |
int8_t wl_init(void);
|
60 |
|
61 |
// the send functions
|
62 |
int8_t wl_send(char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode);
|
63 |
int8_t wl_send_global(char *data, uint8_t length, uint8_t group);
|
64 |
int8_t wl_send_pan(char *data, uint8_t length, uint8_t group);
|
65 |
int8_t wl_send_robot/p2p(char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode);
|
66 |
int8_t wl_send_basic(char *data);
|
67 |
|
68 |
// the ack function
|
69 |
int8_t wl_ack_error(void);
|
70 |
|
71 |
// the receive functions
|
72 |
int8_t wl_get(char *data, uint8_t length);
|
73 |
int8_t wl_get_basic(char *data, uint8_t length);
|
74 |
int8_t wl_dispatch(void);
|
75 |
|
76 |
// the group register function
|
77 |
int8_t wl_register_handler(uint8_t group, void (*func)(void), uint8_t priority); |
78 |
|
79 |
|
80 |
/**@}**/ //end defgroup |
81 |
|
82 |
#endif
|