Revision 1581
editing wireless branch, added error codes and constants
| wl_defs.h | ||
|---|---|---|
| 35 | 35 |
#ifndef WL_DEFS_H |
| 36 | 36 |
#define WL_DEFS_H |
| 37 | 37 |
|
| 38 |
// create main wireless page documentation |
|
| 39 |
|
|
| 40 |
/** @mainpage The Wireless Library |
|
| 41 |
* |
|
| 42 |
* This is the documentation for the Colony wireless library.\n\n |
|
| 43 |
* Xbee documentation can be found under @ref xbee \n |
|
| 44 |
* Higher level wireless documentation can be found under @ref wireless \n |
|
| 45 |
**/ |
|
| 46 |
|
|
| 47 |
|
|
| 38 | 48 |
// need this for C99 int types |
| 39 | 49 |
#ifndef STDINT_H |
| 40 | 50 |
#define STDINT_H |
| ... | ... | |
| 49 | 59 |
//uncomment this line for debug information |
| 50 | 60 |
//#define WL_DEBUG |
| 51 | 61 |
|
| 62 |
/**@addtogroup wireless |
|
| 63 |
* @{ **/
|
|
| 64 |
|
|
| 65 |
/**@defgroup wl_error Error Codes |
|
| 66 |
* @{ **/
|
|
| 67 |
|
|
| 68 |
/** @brief Success **/ |
|
| 69 |
#define WL_SUCCESS INT8_C(0) |
|
| 52 | 70 |
|
| 53 |
// Error Codes |
|
| 54 |
|
|
| 55 | 71 |
/** @brief Error code for init failure **/ |
| 56 | 72 |
#define WL_ERROR_INIT_FAILED INT8_C(-1) |
| 73 |
|
|
| 57 | 74 |
/** @brief Error code for duplicate init calls **/ |
| 58 | 75 |
#define WL_ERROR_INIT_ALREADY_INITD INT8_C(-2) |
| 76 |
|
|
| 59 | 77 |
/** @brief Error code for not calling init **/ |
| 60 | 78 |
#define WL_ERROR_LIBRARY_NOT_INITD INT8_C(-3) |
| 61 | 79 |
|
| 80 |
/** @brief Error code for failed termination **/ |
|
| 81 |
#define WL_ERROR_TERMINATION_FAILED INT8_C(-4) |
|
| 62 | 82 |
|
| 83 |
/** @brief Error code for failed packet group registration **/ |
|
| 84 |
#define WL_ERROR_FAILED_REGISTRATION INT8_C(-5) |
|
| 85 |
|
|
| 86 |
/** @brief Error in arguments **/ |
|
| 87 |
#define WL_ERROR_ARGUMENT INT8_C(-6) |
|
| 88 |
|
|
| 89 |
/** @brief Error code for send failure **/ |
|
| 90 |
#define WL_ERROR_SEND INT8_C(-10) |
|
| 91 |
|
|
| 92 |
/** @brief Error code for a bad group number **/ |
|
| 93 |
#define WL_ERROR_BAD_GROUP INT8_C(-11) |
|
| 94 |
|
|
| 95 |
/** @brief Error code for a bad scope **/ |
|
| 96 |
#define WL_ERROR_SCOPE INIT8_C(-12) |
|
| 97 |
|
|
| 98 |
/** @brief Error code for a bad robot address **/ |
|
| 99 |
#define WL_ERROR_ADDRESS INIT8_C(-13) |
|
| 100 |
|
|
| 101 |
/** @brief Error code for a bad mode **/ |
|
| 102 |
#define WL_ERROR_MODE INIT8_C(-14) |
|
| 103 |
|
|
| 104 |
|
|
| 105 |
/**@} */ // end error group |
|
| 106 |
|
|
| 107 |
/**@} */ // end wireless group |
|
| 108 |
|
|
| 63 | 109 |
#ifdef WL_DEBUG |
| 64 | 110 |
|
| 65 | 111 |
#ifdef ROBOT |
Also available in: Unified diff