ban4jp -
Xbee API library with support SPI connection. (use only SPI supported model. see also http://www.digi.com/support/kbase/kbaseresultdetl?id=3362 )
Dependents: XBeeWiFi_SPI_example
Fork of
XBee
by 
Suga koubou
XBee.h@1:e3b2027e685c, 2011-01-10 (annotated)
- Committer:
- okini3939
- Date:
- Mon Jan 10 16:32:18 2011 +0000
- Revision:
- 1:e3b2027e685c
- Parent:
- 0:c4ca662ef73e
- Child:
- 3:8573b122fa84
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| okini3939 | 1:e3b2027e685c | 1 | /** |
| okini3939 | 1:e3b2027e685c | 2 | * XBee-mbed library |
| okini3939 | 1:e3b2027e685c | 3 | * Modified for mbed, 2011 Suga. |
| okini3939 | 1:e3b2027e685c | 4 | * |
| okini3939 | 1:e3b2027e685c | 5 | * |
| okini3939 | 1:e3b2027e685c | 6 | * Copyright (c) 2009 Andrew Rapp. All rights reserved. |
| okini3939 | 1:e3b2027e685c | 7 | * |
| okini3939 | 1:e3b2027e685c | 8 | * This file is part of XBee-Arduino. |
| okini3939 | 1:e3b2027e685c | 9 | * |
| okini3939 | 1:e3b2027e685c | 10 | * XBee-Arduino is free software: you can redistribute it and/or modify |
| okini3939 | 1:e3b2027e685c | 11 | * it under the terms of the GNU General Public License as published by |
| okini3939 | 1:e3b2027e685c | 12 | * the Free Software Foundation, either version 3 of the License, or |
| okini3939 | 1:e3b2027e685c | 13 | * (at your option) any later version. |
| okini3939 | 1:e3b2027e685c | 14 | * |
| okini3939 | 1:e3b2027e685c | 15 | * XBee-Arduino is distributed in the hope that it will be useful, |
| okini3939 | 1:e3b2027e685c | 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| okini3939 | 1:e3b2027e685c | 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| okini3939 | 1:e3b2027e685c | 18 | * GNU General Public License for more details. |
| okini3939 | 1:e3b2027e685c | 19 | * |
| okini3939 | 1:e3b2027e685c | 20 | * You should have received a copy of the GNU General Public License |
| okini3939 | 1:e3b2027e685c | 21 | * along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>. |
| okini3939 | 1:e3b2027e685c | 22 | */ |
| okini3939 | 1:e3b2027e685c | 23 | |
| okini3939 | 1:e3b2027e685c | 24 | #ifndef XBee_h |
| okini3939 | 1:e3b2027e685c | 25 | #define XBee_h |
| okini3939 | 1:e3b2027e685c | 26 | |
| okini3939 | 1:e3b2027e685c | 27 | #include "mbed.h" |
| okini3939 | 1:e3b2027e685c | 28 | #include <inttypes.h> |
| okini3939 | 1:e3b2027e685c | 29 | |
| okini3939 | 1:e3b2027e685c | 30 | #define SERIES_1 |
| okini3939 | 1:e3b2027e685c | 31 | #define SERIES_2 |
| okini3939 | 1:e3b2027e685c | 32 | |
| okini3939 | 1:e3b2027e685c | 33 | // set to ATAP value of XBee. AP=2 is recommended |
| okini3939 | 1:e3b2027e685c | 34 | #define ATAP 2 |
| okini3939 | 1:e3b2027e685c | 35 | |
| okini3939 | 1:e3b2027e685c | 36 | #define START_BYTE 0x7e |
| okini3939 | 1:e3b2027e685c | 37 | #define ESCAPE 0x7d |
| okini3939 | 1:e3b2027e685c | 38 | #define XON 0x11 |
| okini3939 | 1:e3b2027e685c | 39 | #define XOFF 0x13 |
| okini3939 | 1:e3b2027e685c | 40 | |
| okini3939 | 1:e3b2027e685c | 41 | // This value determines the size of the byte array for receiving RX packets |
| okini3939 | 1:e3b2027e685c | 42 | // Most users won't be dealing with packets this large so you can adjust this |
| okini3939 | 1:e3b2027e685c | 43 | // value to reduce memory consumption. But, remember that |
| okini3939 | 1:e3b2027e685c | 44 | // if a RX packet exceeds this size, it cannot be parsed! |
| okini3939 | 1:e3b2027e685c | 45 | |
| okini3939 | 1:e3b2027e685c | 46 | // This value is determined by the largest packet size (100 byte payload + 64-bit address + option byte and rssi byte) of a series 1 radio |
| okini3939 | 1:e3b2027e685c | 47 | #define MAX_FRAME_DATA_SIZE 110 |
| okini3939 | 1:e3b2027e685c | 48 | |
| okini3939 | 1:e3b2027e685c | 49 | #define BROADCAST_ADDRESS 0xffff |
| okini3939 | 1:e3b2027e685c | 50 | #define ZB_BROADCAST_ADDRESS 0xfffe |
| okini3939 | 1:e3b2027e685c | 51 | |
| okini3939 | 1:e3b2027e685c | 52 | // the non-variable length of the frame data (not including frame id or api id or variable data size (e.g. payload, at command set value) |
| okini3939 | 1:e3b2027e685c | 53 | #define ZB_TX_API_LENGTH 12 |
| okini3939 | 1:e3b2027e685c | 54 | #define TX_16_API_LENGTH 3 |
| okini3939 | 1:e3b2027e685c | 55 | #define TX_64_API_LENGTH 9 |
| okini3939 | 1:e3b2027e685c | 56 | #define AT_COMMAND_API_LENGTH 2 |
| okini3939 | 1:e3b2027e685c | 57 | #define REMOTE_AT_COMMAND_API_LENGTH 13 |
| okini3939 | 1:e3b2027e685c | 58 | // start/length(2)/api/frameid/checksum bytes |
| okini3939 | 1:e3b2027e685c | 59 | #define PACKET_OVERHEAD_LENGTH 6 |
| okini3939 | 1:e3b2027e685c | 60 | // api is always the third byte in packet |
| okini3939 | 1:e3b2027e685c | 61 | #define API_ID_INDEX 3 |
| okini3939 | 1:e3b2027e685c | 62 | |
| okini3939 | 1:e3b2027e685c | 63 | // frame position of rssi byte |
| okini3939 | 1:e3b2027e685c | 64 | #define RX_16_RSSI_OFFSET 2 |
| okini3939 | 1:e3b2027e685c | 65 | #define RX_64_RSSI_OFFSET 8 |
| okini3939 | 1:e3b2027e685c | 66 | |
| okini3939 | 1:e3b2027e685c | 67 | #define DEFAULT_FRAME_ID 1 |
| okini3939 | 1:e3b2027e685c | 68 | #define NO_RESPONSE_FRAME_ID 0 |
| okini3939 | 1:e3b2027e685c | 69 | |
| okini3939 | 1:e3b2027e685c | 70 | // TODO put in tx16 class |
| okini3939 | 1:e3b2027e685c | 71 | #define ACK_OPTION 0 |
| okini3939 | 1:e3b2027e685c | 72 | #define DISABLE_ACK_OPTION 1 |
| okini3939 | 1:e3b2027e685c | 73 | #define BROADCAST_OPTION 4 |
| okini3939 | 1:e3b2027e685c | 74 | |
| okini3939 | 1:e3b2027e685c | 75 | // RX options |
| okini3939 | 1:e3b2027e685c | 76 | #define ZB_PACKET_ACKNOWLEDGED 0x01 |
| okini3939 | 1:e3b2027e685c | 77 | #define ZB_BROADCAST_PACKET 0x02 |
| okini3939 | 1:e3b2027e685c | 78 | |
| okini3939 | 1:e3b2027e685c | 79 | // not everything is implemented! |
| okini3939 | 1:e3b2027e685c | 80 | /** |
| okini3939 | 1:e3b2027e685c | 81 | * Api Id constants |
| okini3939 | 1:e3b2027e685c | 82 | */ |
| okini3939 | 1:e3b2027e685c | 83 | #define TX_64_REQUEST 0x0 |
| okini3939 | 1:e3b2027e685c | 84 | #define TX_16_REQUEST 0x1 |
| okini3939 | 1:e3b2027e685c | 85 | #define AT_COMMAND_REQUEST 0x08 |
| okini3939 | 1:e3b2027e685c | 86 | #define AT_COMMAND_QUEUE_REQUEST 0x09 |
| okini3939 | 1:e3b2027e685c | 87 | #define REMOTE_AT_REQUEST 0x17 |
| okini3939 | 1:e3b2027e685c | 88 | #define ZB_TX_REQUEST 0x10 |
| okini3939 | 1:e3b2027e685c | 89 | #define ZB_EXPLICIT_TX_REQUEST 0x11 |
| okini3939 | 1:e3b2027e685c | 90 | #define RX_64_RESPONSE 0x80 |
| okini3939 | 1:e3b2027e685c | 91 | #define RX_16_RESPONSE 0x81 |
| okini3939 | 1:e3b2027e685c | 92 | #define RX_64_IO_RESPONSE 0x82 |
| okini3939 | 1:e3b2027e685c | 93 | #define RX_16_IO_RESPONSE 0x83 |
| okini3939 | 1:e3b2027e685c | 94 | #define AT_RESPONSE 0x88 |
| okini3939 | 1:e3b2027e685c | 95 | #define TX_STATUS_RESPONSE 0x89 |
| okini3939 | 1:e3b2027e685c | 96 | #define MODEM_STATUS_RESPONSE 0x8a |
| okini3939 | 1:e3b2027e685c | 97 | #define ZB_RX_RESPONSE 0x90 |
| okini3939 | 1:e3b2027e685c | 98 | #define ZB_EXPLICIT_RX_RESPONSE 0x91 |
| okini3939 | 1:e3b2027e685c | 99 | #define ZB_TX_STATUS_RESPONSE 0x8b |
| okini3939 | 1:e3b2027e685c | 100 | #define ZB_IO_SAMPLE_RESPONSE 0x92 |
| okini3939 | 1:e3b2027e685c | 101 | #define ZB_IO_NODE_IDENTIFIER_RESPONSE 0x95 |
| okini3939 | 1:e3b2027e685c | 102 | #define AT_COMMAND_RESPONSE 0x88 |
| okini3939 | 1:e3b2027e685c | 103 | #define REMOTE_AT_COMMAND_RESPONSE 0x97 |
| okini3939 | 1:e3b2027e685c | 104 | |
| okini3939 | 1:e3b2027e685c | 105 | |
| okini3939 | 1:e3b2027e685c | 106 | /** |
| okini3939 | 1:e3b2027e685c | 107 | * TX STATUS constants |
| okini3939 | 1:e3b2027e685c | 108 | */ |
| okini3939 | 1:e3b2027e685c | 109 | #define SUCCESS 0x0 |
| okini3939 | 1:e3b2027e685c | 110 | #define CCA_FAILURE 0x2 |
| okini3939 | 1:e3b2027e685c | 111 | #define INVALID_DESTINATION_ENDPOINT_SUCCESS 0x15 |
| okini3939 | 1:e3b2027e685c | 112 | #define NETWORK_ACK_FAILURE 0x21 |
| okini3939 | 1:e3b2027e685c | 113 | #define NOT_JOINED_TO_NETWORK 0x22 |
| okini3939 | 1:e3b2027e685c | 114 | #define SELF_ADDRESSED 0x23 |
| okini3939 | 1:e3b2027e685c | 115 | #define ADDRESS_NOT_FOUND 0x24 |
| okini3939 | 1:e3b2027e685c | 116 | #define ROUTE_NOT_FOUND 0x25 |
| okini3939 | 1:e3b2027e685c | 117 | #define PAYLOAD_TOO_LARGE 0x74 |
| okini3939 | 1:e3b2027e685c | 118 | |
| okini3939 | 1:e3b2027e685c | 119 | // modem status |
| okini3939 | 1:e3b2027e685c | 120 | #define HARDWARE_RESET 0 |
| okini3939 | 1:e3b2027e685c | 121 | #define WATCHDOG_TIMER_RESET 1 |
| okini3939 | 1:e3b2027e685c | 122 | #define ASSOCIATED 2 |
| okini3939 | 1:e3b2027e685c | 123 | #define DISASSOCIATED 3 |
| okini3939 | 1:e3b2027e685c | 124 | #define SYNCHRONIZATION_LOST 4 |
| okini3939 | 1:e3b2027e685c | 125 | #define COORDINATOR_REALIGNMENT 5 |
| okini3939 | 1:e3b2027e685c | 126 | #define COORDINATOR_STARTED 6 |
| okini3939 | 1:e3b2027e685c | 127 | |
| okini3939 | 1:e3b2027e685c | 128 | #define ZB_BROADCAST_RADIUS_MAX_HOPS 0 |
| okini3939 | 1:e3b2027e685c | 129 | |
| okini3939 | 1:e3b2027e685c | 130 | #define ZB_TX_UNICAST 0 |
| okini3939 | 1:e3b2027e685c | 131 | #define ZB_TX_BROADCAST 8 |
| okini3939 | 1:e3b2027e685c | 132 | |
| okini3939 | 1:e3b2027e685c | 133 | #define AT_OK 0 |
| okini3939 | 1:e3b2027e685c | 134 | #define AT_ERROR 1 |
| okini3939 | 1:e3b2027e685c | 135 | #define AT_INVALID_COMMAND 2 |
| okini3939 | 1:e3b2027e685c | 136 | #define AT_INVALID_PARAMETER 3 |
| okini3939 | 1:e3b2027e685c | 137 | #define AT_NO_RESPONSE 4 |
| okini3939 | 1:e3b2027e685c | 138 | |
| okini3939 | 1:e3b2027e685c | 139 | #define NO_ERROR 0 |
| okini3939 | 1:e3b2027e685c | 140 | #define CHECKSUM_FAILURE 1 |
| okini3939 | 1:e3b2027e685c | 141 | #define PACKET_EXCEEDS_BYTE_ARRAY_LENGTH 2 |
| okini3939 | 1:e3b2027e685c | 142 | #define UNEXPECTED_START_BYTE 3 |
| okini3939 | 1:e3b2027e685c | 143 | |
| okini3939 | 1:e3b2027e685c | 144 | /** |
| okini3939 | 1:e3b2027e685c | 145 | * The super class of all XBee responses (RX packets) |
| okini3939 | 1:e3b2027e685c | 146 | * Users should never attempt to create an instance of this class; instead |
| okini3939 | 1:e3b2027e685c | 147 | * create an instance of a subclass |
| okini3939 | 1:e3b2027e685c | 148 | * It is recommend to reuse subclasses to conserve memory |
| okini3939 | 1:e3b2027e685c | 149 | */ |
| okini3939 | 1:e3b2027e685c | 150 | class XBeeResponse { |
| okini3939 | 1:e3b2027e685c | 151 | public: |
| okini3939 | 1:e3b2027e685c | 152 | //static const int MODEM_STATUS = 0x8a; |
| okini3939 | 1:e3b2027e685c | 153 | /** |
| okini3939 | 1:e3b2027e685c | 154 | * Default constructor |
| okini3939 | 1:e3b2027e685c | 155 | */ |
| okini3939 | 1:e3b2027e685c | 156 | XBeeResponse(); |
| okini3939 | 1:e3b2027e685c | 157 | /** |
| okini3939 | 1:e3b2027e685c | 158 | * Returns Api Id of the response |
| okini3939 | 1:e3b2027e685c | 159 | */ |
| okini3939 | 1:e3b2027e685c | 160 | uint8_t getApiId(); |
| okini3939 | 1:e3b2027e685c | 161 | void setApiId(uint8_t apiId); |
| okini3939 | 1:e3b2027e685c | 162 | /** |
| okini3939 | 1:e3b2027e685c | 163 | * Returns the MSB length of the packet |
| okini3939 | 1:e3b2027e685c | 164 | */ |
| okini3939 | 1:e3b2027e685c | 165 | uint8_t getMsbLength(); |
| okini3939 | 1:e3b2027e685c | 166 | void setMsbLength(uint8_t msbLength); |
| okini3939 | 1:e3b2027e685c | 167 | /** |
| okini3939 | 1:e3b2027e685c | 168 | * Returns the LSB length of the packet |
| okini3939 | 1:e3b2027e685c | 169 | */ |
| okini3939 | 1:e3b2027e685c | 170 | uint8_t getLsbLength(); |
| okini3939 | 1:e3b2027e685c | 171 | void setLsbLength(uint8_t lsbLength); |
| okini3939 | 1:e3b2027e685c | 172 | /** |
| okini3939 | 1:e3b2027e685c | 173 | * Returns the packet checksum |
| okini3939 | 1:e3b2027e685c | 174 | */ |
| okini3939 | 1:e3b2027e685c | 175 | uint8_t getChecksum(); |
| okini3939 | 1:e3b2027e685c | 176 | void setChecksum(uint8_t checksum); |
| okini3939 | 1:e3b2027e685c | 177 | /** |
| okini3939 | 1:e3b2027e685c | 178 | * Returns the length of the frame data: all bytes after the api id, and prior to the checksum |
| okini3939 | 1:e3b2027e685c | 179 | * Note up to release 0.1.2, this was incorrectly including the checksum in the length. |
| okini3939 | 1:e3b2027e685c | 180 | */ |
| okini3939 | 1:e3b2027e685c | 181 | uint8_t getFrameDataLength(); |
| okini3939 | 1:e3b2027e685c | 182 | void setFrameData(uint8_t* frameDataPtr); |
| okini3939 | 1:e3b2027e685c | 183 | /** |
| okini3939 | 1:e3b2027e685c | 184 | * Returns the buffer that contains the response. |
| okini3939 | 1:e3b2027e685c | 185 | * Starts with byte that follows API ID and includes all bytes prior to the checksum |
| okini3939 | 1:e3b2027e685c | 186 | * Length is specified by getFrameDataLength() |
| okini3939 | 1:e3b2027e685c | 187 | * Note: Unlike Digi's definition of the frame data, this does not start with the API ID.. |
| okini3939 | 1:e3b2027e685c | 188 | * The reason for this is all responses include an API ID, whereas my frame data |
| okini3939 | 1:e3b2027e685c | 189 | * includes only the API specific data. |
| okini3939 | 1:e3b2027e685c | 190 | */ |
| okini3939 | 1:e3b2027e685c | 191 | uint8_t* getFrameData(); |
| okini3939 | 1:e3b2027e685c | 192 | |
| okini3939 | 1:e3b2027e685c | 193 | void setFrameLength(uint8_t frameLength); |
| okini3939 | 1:e3b2027e685c | 194 | // to support future 65535 byte packets I guess |
| okini3939 | 1:e3b2027e685c | 195 | /** |
| okini3939 | 1:e3b2027e685c | 196 | * Returns the length of the packet |
| okini3939 | 1:e3b2027e685c | 197 | */ |
| okini3939 | 1:e3b2027e685c | 198 | uint16_t getPacketLength(); |
| okini3939 | 1:e3b2027e685c | 199 | /** |
| okini3939 | 1:e3b2027e685c | 200 | * Resets the response to default values |
| okini3939 | 1:e3b2027e685c | 201 | */ |
| okini3939 | 1:e3b2027e685c | 202 | void reset(); |
| okini3939 | 1:e3b2027e685c | 203 | /** |
| okini3939 | 1:e3b2027e685c | 204 | * Initializes the response |
| okini3939 | 1:e3b2027e685c | 205 | */ |
| okini3939 | 1:e3b2027e685c | 206 | void init(); |
| okini3939 | 1:e3b2027e685c | 207 | #ifdef SERIES_2 |
| okini3939 | 1:e3b2027e685c | 208 | /** |
| okini3939 | 1:e3b2027e685c | 209 | * Call with instance of ZBTxStatusResponse class only if getApiId() == ZB_TX_STATUS_RESPONSE |
| okini3939 | 1:e3b2027e685c | 210 | * to populate response |
| okini3939 | 1:e3b2027e685c | 211 | */ |
| okini3939 | 1:e3b2027e685c | 212 | void getZBTxStatusResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 213 | /** |
| okini3939 | 1:e3b2027e685c | 214 | * Call with instance of ZBRxResponse class only if getApiId() == ZB_RX_RESPONSE |
| okini3939 | 1:e3b2027e685c | 215 | * to populate response |
| okini3939 | 1:e3b2027e685c | 216 | */ |
| okini3939 | 1:e3b2027e685c | 217 | void getZBRxResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 218 | /** |
| okini3939 | 1:e3b2027e685c | 219 | * Call with instance of ZBRxIoSampleResponse class only if getApiId() == ZB_IO_SAMPLE_RESPONSE |
| okini3939 | 1:e3b2027e685c | 220 | * to populate response |
| okini3939 | 1:e3b2027e685c | 221 | */ |
| okini3939 | 1:e3b2027e685c | 222 | void getZBRxIoSampleResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 223 | #endif |
| okini3939 | 1:e3b2027e685c | 224 | #ifdef SERIES_1 |
| okini3939 | 1:e3b2027e685c | 225 | /** |
| okini3939 | 1:e3b2027e685c | 226 | * Call with instance of TxStatusResponse only if getApiId() == TX_STATUS_RESPONSE |
| okini3939 | 1:e3b2027e685c | 227 | */ |
| okini3939 | 1:e3b2027e685c | 228 | void getTxStatusResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 229 | /** |
| okini3939 | 1:e3b2027e685c | 230 | * Call with instance of Rx16Response only if getApiId() == RX_16_RESPONSE |
| okini3939 | 1:e3b2027e685c | 231 | */ |
| okini3939 | 1:e3b2027e685c | 232 | void getRx16Response(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 233 | /** |
| okini3939 | 1:e3b2027e685c | 234 | * Call with instance of Rx64Response only if getApiId() == RX_64_RESPONSE |
| okini3939 | 1:e3b2027e685c | 235 | */ |
| okini3939 | 1:e3b2027e685c | 236 | void getRx64Response(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 237 | /** |
| okini3939 | 1:e3b2027e685c | 238 | * Call with instance of Rx16IoSampleResponse only if getApiId() == RX_16_IO_RESPONSE |
| okini3939 | 1:e3b2027e685c | 239 | */ |
| okini3939 | 1:e3b2027e685c | 240 | void getRx16IoSampleResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 241 | /** |
| okini3939 | 1:e3b2027e685c | 242 | * Call with instance of Rx64IoSampleResponse only if getApiId() == RX_64_IO_RESPONSE |
| okini3939 | 1:e3b2027e685c | 243 | */ |
| okini3939 | 1:e3b2027e685c | 244 | void getRx64IoSampleResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 245 | #endif |
| okini3939 | 1:e3b2027e685c | 246 | /** |
| okini3939 | 1:e3b2027e685c | 247 | * Call with instance of AtCommandResponse only if getApiId() == AT_COMMAND_RESPONSE |
| okini3939 | 1:e3b2027e685c | 248 | */ |
| okini3939 | 1:e3b2027e685c | 249 | void getAtCommandResponse(XBeeResponse &responses); |
| okini3939 | 1:e3b2027e685c | 250 | /** |
| okini3939 | 1:e3b2027e685c | 251 | * Call with instance of RemoteAtCommandResponse only if getApiId() == REMOTE_AT_COMMAND_RESPONSE |
| okini3939 | 1:e3b2027e685c | 252 | */ |
| okini3939 | 1:e3b2027e685c | 253 | void getRemoteAtCommandResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 254 | /** |
| okini3939 | 1:e3b2027e685c | 255 | * Call with instance of ModemStatusResponse only if getApiId() == MODEM_STATUS_RESPONSE |
| okini3939 | 1:e3b2027e685c | 256 | */ |
| okini3939 | 1:e3b2027e685c | 257 | void getModemStatusResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 258 | /** |
| okini3939 | 1:e3b2027e685c | 259 | * Returns true if the response has been successfully parsed and is complete and ready for use |
| okini3939 | 1:e3b2027e685c | 260 | */ |
| okini3939 | 1:e3b2027e685c | 261 | bool isAvailable(); |
| okini3939 | 1:e3b2027e685c | 262 | void setAvailable(bool complete); |
| okini3939 | 1:e3b2027e685c | 263 | /** |
| okini3939 | 1:e3b2027e685c | 264 | * Returns true if the response contains errors |
| okini3939 | 1:e3b2027e685c | 265 | */ |
| okini3939 | 1:e3b2027e685c | 266 | bool isError(); |
| okini3939 | 1:e3b2027e685c | 267 | /** |
| okini3939 | 1:e3b2027e685c | 268 | * Returns an error code, or zero, if successful. |
| okini3939 | 1:e3b2027e685c | 269 | * Error codes include: CHECKSUM_FAILURE, PACKET_EXCEEDS_BYTE_ARRAY_LENGTH, UNEXPECTED_START_BYTE |
| okini3939 | 1:e3b2027e685c | 270 | */ |
| okini3939 | 1:e3b2027e685c | 271 | uint8_t getErrorCode(); |
| okini3939 | 1:e3b2027e685c | 272 | void setErrorCode(uint8_t errorCode); |
| okini3939 | 1:e3b2027e685c | 273 | protected: |
| okini3939 | 1:e3b2027e685c | 274 | // pointer to frameData |
| okini3939 | 1:e3b2027e685c | 275 | uint8_t* _frameDataPtr; |
| okini3939 | 1:e3b2027e685c | 276 | private: |
| okini3939 | 1:e3b2027e685c | 277 | void setCommon(XBeeResponse &target); |
| okini3939 | 1:e3b2027e685c | 278 | uint8_t _apiId; |
| okini3939 | 1:e3b2027e685c | 279 | uint8_t _msbLength; |
| okini3939 | 1:e3b2027e685c | 280 | uint8_t _lsbLength; |
| okini3939 | 1:e3b2027e685c | 281 | uint8_t _checksum; |
| okini3939 | 1:e3b2027e685c | 282 | uint8_t _frameLength; |
| okini3939 | 1:e3b2027e685c | 283 | bool _complete; |
| okini3939 | 1:e3b2027e685c | 284 | uint8_t _errorCode; |
| okini3939 | 1:e3b2027e685c | 285 | }; |
| okini3939 | 1:e3b2027e685c | 286 | |
| okini3939 | 1:e3b2027e685c | 287 | class XBeeAddress { |
| okini3939 | 1:e3b2027e685c | 288 | public: |
| okini3939 | 1:e3b2027e685c | 289 | XBeeAddress(); |
| okini3939 | 1:e3b2027e685c | 290 | }; |
| okini3939 | 1:e3b2027e685c | 291 | |
| okini3939 | 1:e3b2027e685c | 292 | /** |
| okini3939 | 1:e3b2027e685c | 293 | * Represents a 64-bit XBee Address |
| okini3939 | 1:e3b2027e685c | 294 | */ |
| okini3939 | 1:e3b2027e685c | 295 | class XBeeAddress64 : public XBeeAddress { |
| okini3939 | 1:e3b2027e685c | 296 | public: |
| okini3939 | 1:e3b2027e685c | 297 | XBeeAddress64(uint32_t msb, uint32_t lsb); |
| okini3939 | 1:e3b2027e685c | 298 | XBeeAddress64(); |
| okini3939 | 1:e3b2027e685c | 299 | uint32_t getMsb(); |
| okini3939 | 1:e3b2027e685c | 300 | uint32_t getLsb(); |
| okini3939 | 1:e3b2027e685c | 301 | void setMsb(uint32_t msb); |
| okini3939 | 1:e3b2027e685c | 302 | void setLsb(uint32_t lsb); |
| okini3939 | 1:e3b2027e685c | 303 | private: |
| okini3939 | 1:e3b2027e685c | 304 | uint32_t _msb; |
| okini3939 | 1:e3b2027e685c | 305 | uint32_t _lsb; |
| okini3939 | 1:e3b2027e685c | 306 | }; |
| okini3939 | 1:e3b2027e685c | 307 | |
| okini3939 | 1:e3b2027e685c | 308 | //class XBeeAddress16 : public XBeeAddress { |
| okini3939 | 1:e3b2027e685c | 309 | //public: |
| okini3939 | 1:e3b2027e685c | 310 | // XBeeAddress16(uint16_t addr); |
| okini3939 | 1:e3b2027e685c | 311 | // XBeeAddress16(); |
| okini3939 | 1:e3b2027e685c | 312 | // uint16_t getAddress(); |
| okini3939 | 1:e3b2027e685c | 313 | // void setAddress(uint16_t addr); |
| okini3939 | 1:e3b2027e685c | 314 | //private: |
| okini3939 | 1:e3b2027e685c | 315 | // uint16_t _addr; |
| okini3939 | 1:e3b2027e685c | 316 | //}; |
| okini3939 | 1:e3b2027e685c | 317 | |
| okini3939 | 1:e3b2027e685c | 318 | /** |
| okini3939 | 1:e3b2027e685c | 319 | * This class is extended by all Responses that include a frame id |
| okini3939 | 1:e3b2027e685c | 320 | */ |
| okini3939 | 1:e3b2027e685c | 321 | class FrameIdResponse : public XBeeResponse { |
| okini3939 | 1:e3b2027e685c | 322 | public: |
| okini3939 | 1:e3b2027e685c | 323 | FrameIdResponse(); |
| okini3939 | 1:e3b2027e685c | 324 | uint8_t getFrameId(); |
| okini3939 | 1:e3b2027e685c | 325 | private: |
| okini3939 | 1:e3b2027e685c | 326 | uint8_t _frameId; |
| okini3939 | 1:e3b2027e685c | 327 | }; |
| okini3939 | 1:e3b2027e685c | 328 | |
| okini3939 | 1:e3b2027e685c | 329 | /** |
| okini3939 | 1:e3b2027e685c | 330 | * Common functionality for both Series 1 and 2 data RX data packets |
| okini3939 | 1:e3b2027e685c | 331 | */ |
| okini3939 | 1:e3b2027e685c | 332 | class RxDataResponse : public XBeeResponse { |
| okini3939 | 1:e3b2027e685c | 333 | public: |
| okini3939 | 1:e3b2027e685c | 334 | RxDataResponse(); |
| okini3939 | 1:e3b2027e685c | 335 | /** |
| okini3939 | 1:e3b2027e685c | 336 | * Returns the specified index of the payload. The index may be 0 to getDataLength() - 1 |
| okini3939 | 1:e3b2027e685c | 337 | * This method is deprecated; use uint8_t* getData() |
| okini3939 | 1:e3b2027e685c | 338 | */ |
| okini3939 | 1:e3b2027e685c | 339 | uint8_t getData(int index); |
| okini3939 | 1:e3b2027e685c | 340 | /** |
| okini3939 | 1:e3b2027e685c | 341 | * Returns the payload array. This may be accessed from index 0 to getDataLength() - 1 |
| okini3939 | 1:e3b2027e685c | 342 | */ |
| okini3939 | 1:e3b2027e685c | 343 | uint8_t* getData(); |
| okini3939 | 1:e3b2027e685c | 344 | /** |
| okini3939 | 1:e3b2027e685c | 345 | * Returns the length of the payload |
| okini3939 | 1:e3b2027e685c | 346 | */ |
| okini3939 | 1:e3b2027e685c | 347 | virtual uint8_t getDataLength() = 0; |
| okini3939 | 1:e3b2027e685c | 348 | /** |
| okini3939 | 1:e3b2027e685c | 349 | * Returns the position in the frame data where the data begins |
| okini3939 | 1:e3b2027e685c | 350 | */ |
| okini3939 | 1:e3b2027e685c | 351 | virtual uint8_t getDataOffset() = 0; |
| okini3939 | 1:e3b2027e685c | 352 | }; |
| okini3939 | 1:e3b2027e685c | 353 | |
| okini3939 | 1:e3b2027e685c | 354 | // getResponse to return the proper subclass: |
| okini3939 | 1:e3b2027e685c | 355 | // we maintain a pointer to each type of response, when a response is parsed, it is allocated only if NULL |
| okini3939 | 1:e3b2027e685c | 356 | // can we allocate an object in a function? |
| okini3939 | 1:e3b2027e685c | 357 | |
| okini3939 | 1:e3b2027e685c | 358 | #ifdef SERIES_2 |
| okini3939 | 1:e3b2027e685c | 359 | /** |
| okini3939 | 1:e3b2027e685c | 360 | * Represents a Series 2 TX status packet |
| okini3939 | 1:e3b2027e685c | 361 | */ |
| okini3939 | 1:e3b2027e685c | 362 | class ZBTxStatusResponse : public FrameIdResponse { |
| okini3939 | 1:e3b2027e685c | 363 | public: |
| okini3939 | 1:e3b2027e685c | 364 | ZBTxStatusResponse(); |
| okini3939 | 1:e3b2027e685c | 365 | uint16_t getRemoteAddress(); |
| okini3939 | 1:e3b2027e685c | 366 | uint8_t getTxRetryCount(); |
| okini3939 | 1:e3b2027e685c | 367 | uint8_t getDeliveryStatus(); |
| okini3939 | 1:e3b2027e685c | 368 | uint8_t getDiscoveryStatus(); |
| okini3939 | 1:e3b2027e685c | 369 | bool isSuccess(); |
| okini3939 | 1:e3b2027e685c | 370 | }; |
| okini3939 | 1:e3b2027e685c | 371 | |
| okini3939 | 1:e3b2027e685c | 372 | /** |
| okini3939 | 1:e3b2027e685c | 373 | * Represents a Series 2 RX packet |
| okini3939 | 1:e3b2027e685c | 374 | */ |
| okini3939 | 1:e3b2027e685c | 375 | class ZBRxResponse : public RxDataResponse { |
| okini3939 | 1:e3b2027e685c | 376 | public: |
| okini3939 | 1:e3b2027e685c | 377 | ZBRxResponse(); |
| okini3939 | 1:e3b2027e685c | 378 | XBeeAddress64& getRemoteAddress64(); |
| okini3939 | 1:e3b2027e685c | 379 | uint16_t getRemoteAddress16(); |
| okini3939 | 1:e3b2027e685c | 380 | uint8_t getOption(); |
| okini3939 | 1:e3b2027e685c | 381 | virtual uint8_t getDataLength(); |
| okini3939 | 1:e3b2027e685c | 382 | // frame position where data starts |
| okini3939 | 1:e3b2027e685c | 383 | virtual uint8_t getDataOffset(); |
| okini3939 | 1:e3b2027e685c | 384 | private: |
| okini3939 | 1:e3b2027e685c | 385 | XBeeAddress64 _remoteAddress64; |
| okini3939 | 1:e3b2027e685c | 386 | }; |
| okini3939 | 1:e3b2027e685c | 387 | |
| okini3939 | 1:e3b2027e685c | 388 | /** |
| okini3939 | 1:e3b2027e685c | 389 | * Represents a Series 2 RX I/O Sample packet |
| okini3939 | 1:e3b2027e685c | 390 | */ |
| okini3939 | 1:e3b2027e685c | 391 | class ZBRxIoSampleResponse : public ZBRxResponse { |
| okini3939 | 1:e3b2027e685c | 392 | public: |
| okini3939 | 1:e3b2027e685c | 393 | ZBRxIoSampleResponse(); |
| okini3939 | 1:e3b2027e685c | 394 | bool containsAnalog(); |
| okini3939 | 1:e3b2027e685c | 395 | bool containsDigital(); |
| okini3939 | 1:e3b2027e685c | 396 | /** |
| okini3939 | 1:e3b2027e685c | 397 | * Returns true if the pin is enabled |
| okini3939 | 1:e3b2027e685c | 398 | */ |
| okini3939 | 1:e3b2027e685c | 399 | bool isAnalogEnabled(uint8_t pin); |
| okini3939 | 1:e3b2027e685c | 400 | /** |
| okini3939 | 1:e3b2027e685c | 401 | * Returns true if the pin is enabled |
| okini3939 | 1:e3b2027e685c | 402 | */ |
| okini3939 | 1:e3b2027e685c | 403 | bool isDigitalEnabled(uint8_t pin); |
| okini3939 | 1:e3b2027e685c | 404 | /** |
| okini3939 | 1:e3b2027e685c | 405 | * Returns the 10-bit analog reading of the specified pin. |
| okini3939 | 1:e3b2027e685c | 406 | * Valid pins include ADC:xxx. |
| okini3939 | 1:e3b2027e685c | 407 | */ |
| okini3939 | 1:e3b2027e685c | 408 | uint16_t getAnalog(uint8_t pin); |
| okini3939 | 1:e3b2027e685c | 409 | /** |
| okini3939 | 1:e3b2027e685c | 410 | * Returns true if the specified pin is high/on. |
| okini3939 | 1:e3b2027e685c | 411 | * Valid pins include DIO:xxx. |
| okini3939 | 1:e3b2027e685c | 412 | */ |
| okini3939 | 1:e3b2027e685c | 413 | bool isDigitalOn(uint8_t pin); |
| okini3939 | 1:e3b2027e685c | 414 | uint8_t getDigitalMaskMsb(); |
| okini3939 | 1:e3b2027e685c | 415 | uint8_t getDigitalMaskLsb(); |
| okini3939 | 1:e3b2027e685c | 416 | uint8_t getAnalogMask(); |
| okini3939 | 1:e3b2027e685c | 417 | }; |
| okini3939 | 1:e3b2027e685c | 418 | |
| okini3939 | 1:e3b2027e685c | 419 | #endif |
| okini3939 | 1:e3b2027e685c | 420 | |
| okini3939 | 1:e3b2027e685c | 421 | #ifdef SERIES_1 |
| okini3939 | 1:e3b2027e685c | 422 | /** |
| okini3939 | 1:e3b2027e685c | 423 | * Represents a Series 1 TX Status packet |
| okini3939 | 1:e3b2027e685c | 424 | */ |
| okini3939 | 1:e3b2027e685c | 425 | class TxStatusResponse : public FrameIdResponse { |
| okini3939 | 1:e3b2027e685c | 426 | public: |
| okini3939 | 1:e3b2027e685c | 427 | TxStatusResponse(); |
| okini3939 | 1:e3b2027e685c | 428 | uint8_t getStatus(); |
| okini3939 | 1:e3b2027e685c | 429 | bool isSuccess(); |
| okini3939 | 1:e3b2027e685c | 430 | }; |
| okini3939 | 1:e3b2027e685c | 431 | |
| okini3939 | 1:e3b2027e685c | 432 | /** |
| okini3939 | 1:e3b2027e685c | 433 | * Represents a Series 1 RX packet |
| okini3939 | 1:e3b2027e685c | 434 | */ |
| okini3939 | 1:e3b2027e685c | 435 | class RxResponse : public RxDataResponse { |
| okini3939 | 1:e3b2027e685c | 436 | public: |
| okini3939 | 1:e3b2027e685c | 437 | RxResponse(); |
| okini3939 | 1:e3b2027e685c | 438 | // remember rssi is negative but this is unsigned byte so it's up to you to convert |
| okini3939 | 1:e3b2027e685c | 439 | uint8_t getRssi(); |
| okini3939 | 1:e3b2027e685c | 440 | uint8_t getOption(); |
| okini3939 | 1:e3b2027e685c | 441 | bool isAddressBroadcast(); |
| okini3939 | 1:e3b2027e685c | 442 | bool isPanBroadcast(); |
| okini3939 | 1:e3b2027e685c | 443 | virtual uint8_t getDataLength(); |
| okini3939 | 1:e3b2027e685c | 444 | virtual uint8_t getDataOffset(); |
| okini3939 | 1:e3b2027e685c | 445 | virtual uint8_t getRssiOffset() = 0; |
| okini3939 | 1:e3b2027e685c | 446 | }; |
| okini3939 | 1:e3b2027e685c | 447 | |
| okini3939 | 1:e3b2027e685c | 448 | /** |
| okini3939 | 1:e3b2027e685c | 449 | * Represents a Series 1 16-bit address RX packet |
| okini3939 | 1:e3b2027e685c | 450 | */ |
| okini3939 | 1:e3b2027e685c | 451 | class Rx16Response : public RxResponse { |
| okini3939 | 1:e3b2027e685c | 452 | public: |
| okini3939 | 1:e3b2027e685c | 453 | Rx16Response(); |
| okini3939 | 1:e3b2027e685c | 454 | virtual uint8_t getRssiOffset(); |
| okini3939 | 1:e3b2027e685c | 455 | uint16_t getRemoteAddress16(); |
| okini3939 | 1:e3b2027e685c | 456 | protected: |
| okini3939 | 1:e3b2027e685c | 457 | uint16_t _remoteAddress; |
| okini3939 | 1:e3b2027e685c | 458 | }; |
| okini3939 | 1:e3b2027e685c | 459 | |
| okini3939 | 1:e3b2027e685c | 460 | /** |
| okini3939 | 1:e3b2027e685c | 461 | * Represents a Series 1 64-bit address RX packet |
| okini3939 | 1:e3b2027e685c | 462 | */ |
| okini3939 | 1:e3b2027e685c | 463 | class Rx64Response : public RxResponse { |
| okini3939 | 1:e3b2027e685c | 464 | public: |
| okini3939 | 1:e3b2027e685c | 465 | Rx64Response(); |
| okini3939 | 1:e3b2027e685c | 466 | virtual uint8_t getRssiOffset(); |
| okini3939 | 1:e3b2027e685c | 467 | XBeeAddress64& getRemoteAddress64(); |
| okini3939 | 1:e3b2027e685c | 468 | private: |
| okini3939 | 1:e3b2027e685c | 469 | XBeeAddress64 _remoteAddress; |
| okini3939 | 1:e3b2027e685c | 470 | }; |
| okini3939 | 1:e3b2027e685c | 471 | |
| okini3939 | 1:e3b2027e685c | 472 | /** |
| okini3939 | 1:e3b2027e685c | 473 | * Represents a Series 1 RX I/O Sample packet |
| okini3939 | 1:e3b2027e685c | 474 | */ |
| okini3939 | 1:e3b2027e685c | 475 | class RxIoSampleBaseResponse : public RxResponse { |
| okini3939 | 1:e3b2027e685c | 476 | public: |
| okini3939 | 1:e3b2027e685c | 477 | RxIoSampleBaseResponse(); |
| okini3939 | 1:e3b2027e685c | 478 | /** |
| okini3939 | 1:e3b2027e685c | 479 | * Returns the number of samples in this packet |
| okini3939 | 1:e3b2027e685c | 480 | */ |
| okini3939 | 1:e3b2027e685c | 481 | uint8_t getSampleSize(); |
| okini3939 | 1:e3b2027e685c | 482 | bool containsAnalog(); |
| okini3939 | 1:e3b2027e685c | 483 | bool containsDigital(); |
| okini3939 | 1:e3b2027e685c | 484 | /** |
| okini3939 | 1:e3b2027e685c | 485 | * Returns true if the specified analog pin is enabled |
| okini3939 | 1:e3b2027e685c | 486 | */ |
| okini3939 | 1:e3b2027e685c | 487 | bool isAnalogEnabled(uint8_t pin); |
| okini3939 | 1:e3b2027e685c | 488 | /** |
| okini3939 | 1:e3b2027e685c | 489 | * Returns true if the specified digital pin is enabled |
| okini3939 | 1:e3b2027e685c | 490 | */ |
| okini3939 | 1:e3b2027e685c | 491 | bool isDigitalEnabled(uint8_t pin); |
| okini3939 | 1:e3b2027e685c | 492 | /** |
| okini3939 | 1:e3b2027e685c | 493 | * Returns the 10-bit analog reading of the specified pin. |
| okini3939 | 1:e3b2027e685c | 494 | * Valid pins include ADC:0-5. Sample index starts at 0 |
| okini3939 | 1:e3b2027e685c | 495 | */ |
| okini3939 | 1:e3b2027e685c | 496 | uint16_t getAnalog(uint8_t pin, uint8_t sample); |
| okini3939 | 1:e3b2027e685c | 497 | /** |
| okini3939 | 1:e3b2027e685c | 498 | * Returns true if the specified pin is high/on. |
| okini3939 | 1:e3b2027e685c | 499 | * Valid pins include DIO:0-8. Sample index starts at 0 |
| okini3939 | 1:e3b2027e685c | 500 | */ |
| okini3939 | 1:e3b2027e685c | 501 | bool isDigitalOn(uint8_t pin, uint8_t sample); |
| okini3939 | 1:e3b2027e685c | 502 | uint8_t getSampleOffset(); |
| okini3939 | 1:e3b2027e685c | 503 | private: |
| okini3939 | 1:e3b2027e685c | 504 | }; |
| okini3939 | 1:e3b2027e685c | 505 | |
| okini3939 | 1:e3b2027e685c | 506 | class Rx16IoSampleResponse : public RxIoSampleBaseResponse { |
| okini3939 | 1:e3b2027e685c | 507 | public: |
| okini3939 | 1:e3b2027e685c | 508 | Rx16IoSampleResponse(); |
| okini3939 | 1:e3b2027e685c | 509 | uint16_t getRemoteAddress16(); |
| okini3939 | 1:e3b2027e685c | 510 | virtual uint8_t getRssiOffset(); |
| okini3939 | 1:e3b2027e685c | 511 | |
| okini3939 | 1:e3b2027e685c | 512 | }; |
| okini3939 | 1:e3b2027e685c | 513 | |
| okini3939 | 1:e3b2027e685c | 514 | class Rx64IoSampleResponse : public RxIoSampleBaseResponse { |
| okini3939 | 1:e3b2027e685c | 515 | public: |
| okini3939 | 1:e3b2027e685c | 516 | Rx64IoSampleResponse(); |
| okini3939 | 1:e3b2027e685c | 517 | XBeeAddress64& getRemoteAddress64(); |
| okini3939 | 1:e3b2027e685c | 518 | virtual uint8_t getRssiOffset(); |
| okini3939 | 1:e3b2027e685c | 519 | private: |
| okini3939 | 1:e3b2027e685c | 520 | XBeeAddress64 _remoteAddress; |
| okini3939 | 1:e3b2027e685c | 521 | }; |
| okini3939 | 1:e3b2027e685c | 522 | |
| okini3939 | 1:e3b2027e685c | 523 | #endif |
| okini3939 | 1:e3b2027e685c | 524 | |
| okini3939 | 1:e3b2027e685c | 525 | /** |
| okini3939 | 1:e3b2027e685c | 526 | * Represents a Modem Status RX packet |
| okini3939 | 1:e3b2027e685c | 527 | */ |
| okini3939 | 1:e3b2027e685c | 528 | class ModemStatusResponse : public XBeeResponse { |
| okini3939 | 1:e3b2027e685c | 529 | public: |
| okini3939 | 1:e3b2027e685c | 530 | ModemStatusResponse(); |
| okini3939 | 1:e3b2027e685c | 531 | uint8_t getStatus(); |
| okini3939 | 1:e3b2027e685c | 532 | }; |
| okini3939 | 1:e3b2027e685c | 533 | |
| okini3939 | 1:e3b2027e685c | 534 | /** |
| okini3939 | 1:e3b2027e685c | 535 | * Represents an AT Command RX packet |
| okini3939 | 1:e3b2027e685c | 536 | */ |
| okini3939 | 1:e3b2027e685c | 537 | class AtCommandResponse : public FrameIdResponse { |
| okini3939 | 1:e3b2027e685c | 538 | public: |
| okini3939 | 1:e3b2027e685c | 539 | AtCommandResponse(); |
| okini3939 | 1:e3b2027e685c | 540 | /** |
| okini3939 | 1:e3b2027e685c | 541 | * Returns an array containing the two character command |
| okini3939 | 1:e3b2027e685c | 542 | */ |
| okini3939 | 1:e3b2027e685c | 543 | uint8_t* getCommand(); |
| okini3939 | 1:e3b2027e685c | 544 | /** |
| okini3939 | 1:e3b2027e685c | 545 | * Returns the command status code. |
| okini3939 | 1:e3b2027e685c | 546 | * Zero represents a successful command |
| okini3939 | 1:e3b2027e685c | 547 | */ |
| okini3939 | 1:e3b2027e685c | 548 | uint8_t getStatus(); |
| okini3939 | 1:e3b2027e685c | 549 | /** |
| okini3939 | 1:e3b2027e685c | 550 | * Returns an array containing the command value. |
| okini3939 | 1:e3b2027e685c | 551 | * This is only applicable to query commands. |
| okini3939 | 1:e3b2027e685c | 552 | */ |
| okini3939 | 1:e3b2027e685c | 553 | uint8_t* getValue(); |
| okini3939 | 1:e3b2027e685c | 554 | /** |
| okini3939 | 1:e3b2027e685c | 555 | * Returns the length of the command value array. |
| okini3939 | 1:e3b2027e685c | 556 | */ |
| okini3939 | 1:e3b2027e685c | 557 | uint8_t getValueLength(); |
| okini3939 | 1:e3b2027e685c | 558 | /** |
| okini3939 | 1:e3b2027e685c | 559 | * Returns true if status equals AT_OK |
| okini3939 | 1:e3b2027e685c | 560 | */ |
| okini3939 | 1:e3b2027e685c | 561 | bool isOk(); |
| okini3939 | 1:e3b2027e685c | 562 | }; |
| okini3939 | 1:e3b2027e685c | 563 | |
| okini3939 | 1:e3b2027e685c | 564 | /** |
| okini3939 | 1:e3b2027e685c | 565 | * Represents a Remote AT Command RX packet |
| okini3939 | 1:e3b2027e685c | 566 | */ |
| okini3939 | 1:e3b2027e685c | 567 | class RemoteAtCommandResponse : public AtCommandResponse { |
| okini3939 | 1:e3b2027e685c | 568 | public: |
| okini3939 | 1:e3b2027e685c | 569 | RemoteAtCommandResponse(); |
| okini3939 | 1:e3b2027e685c | 570 | /** |
| okini3939 | 1:e3b2027e685c | 571 | * Returns an array containing the two character command |
| okini3939 | 1:e3b2027e685c | 572 | */ |
| okini3939 | 1:e3b2027e685c | 573 | uint8_t* getCommand(); |
| okini3939 | 1:e3b2027e685c | 574 | /** |
| okini3939 | 1:e3b2027e685c | 575 | * Returns the command status code. |
| okini3939 | 1:e3b2027e685c | 576 | * Zero represents a successful command |
| okini3939 | 1:e3b2027e685c | 577 | */ |
| okini3939 | 1:e3b2027e685c | 578 | uint8_t getStatus(); |
| okini3939 | 1:e3b2027e685c | 579 | /** |
| okini3939 | 1:e3b2027e685c | 580 | * Returns an array containing the command value. |
| okini3939 | 1:e3b2027e685c | 581 | * This is only applicable to query commands. |
| okini3939 | 1:e3b2027e685c | 582 | */ |
| okini3939 | 1:e3b2027e685c | 583 | uint8_t* getValue(); |
| okini3939 | 1:e3b2027e685c | 584 | /** |
| okini3939 | 1:e3b2027e685c | 585 | * Returns the length of the command value array. |
| okini3939 | 1:e3b2027e685c | 586 | */ |
| okini3939 | 1:e3b2027e685c | 587 | uint8_t getValueLength(); |
| okini3939 | 1:e3b2027e685c | 588 | /** |
| okini3939 | 1:e3b2027e685c | 589 | * Returns the 16-bit address of the remote radio |
| okini3939 | 1:e3b2027e685c | 590 | */ |
| okini3939 | 1:e3b2027e685c | 591 | uint16_t getRemoteAddress16(); |
| okini3939 | 1:e3b2027e685c | 592 | /** |
| okini3939 | 1:e3b2027e685c | 593 | * Returns the 64-bit address of the remote radio |
| okini3939 | 1:e3b2027e685c | 594 | */ |
| okini3939 | 1:e3b2027e685c | 595 | XBeeAddress64& getRemoteAddress64(); |
| okini3939 | 1:e3b2027e685c | 596 | /** |
| okini3939 | 1:e3b2027e685c | 597 | * Returns true if command was successful |
| okini3939 | 1:e3b2027e685c | 598 | */ |
| okini3939 | 1:e3b2027e685c | 599 | bool isOk(); |
| okini3939 | 1:e3b2027e685c | 600 | private: |
| okini3939 | 1:e3b2027e685c | 601 | XBeeAddress64 _remoteAddress64; |
| okini3939 | 1:e3b2027e685c | 602 | }; |
| okini3939 | 1:e3b2027e685c | 603 | |
| okini3939 | 1:e3b2027e685c | 604 | |
| okini3939 | 1:e3b2027e685c | 605 | /** |
| okini3939 | 1:e3b2027e685c | 606 | * Super class of all XBee requests (TX packets) |
| okini3939 | 1:e3b2027e685c | 607 | * Users should never create an instance of this class; instead use an subclass of this class |
| okini3939 | 1:e3b2027e685c | 608 | * It is recommended to reuse Subclasses of the class to conserve memory |
| okini3939 | 1:e3b2027e685c | 609 | * <p/> |
| okini3939 | 1:e3b2027e685c | 610 | * This class allocates a buffer to |
| okini3939 | 1:e3b2027e685c | 611 | */ |
| okini3939 | 1:e3b2027e685c | 612 | class XBeeRequest { |
| okini3939 | 1:e3b2027e685c | 613 | public: |
| okini3939 | 1:e3b2027e685c | 614 | /** |
| okini3939 | 1:e3b2027e685c | 615 | * Constructor |
| okini3939 | 1:e3b2027e685c | 616 | * TODO make protected |
| okini3939 | 1:e3b2027e685c | 617 | */ |
| okini3939 | 1:e3b2027e685c | 618 | XBeeRequest(uint8_t apiId, uint8_t frameId); |
| okini3939 | 1:e3b2027e685c | 619 | /** |
| okini3939 | 1:e3b2027e685c | 620 | * Sets the frame id. Must be between 1 and 255 inclusive to get a TX status response. |
| okini3939 | 1:e3b2027e685c | 621 | */ |
| okini3939 | 1:e3b2027e685c | 622 | void setFrameId(uint8_t frameId); |
| okini3939 | 1:e3b2027e685c | 623 | /** |
| okini3939 | 1:e3b2027e685c | 624 | * Returns the frame id |
| okini3939 | 1:e3b2027e685c | 625 | */ |
| okini3939 | 1:e3b2027e685c | 626 | uint8_t getFrameId(); |
| okini3939 | 1:e3b2027e685c | 627 | /** |
| okini3939 | 1:e3b2027e685c | 628 | * Returns the API id |
| okini3939 | 1:e3b2027e685c | 629 | */ |
| okini3939 | 1:e3b2027e685c | 630 | uint8_t getApiId(); |
| okini3939 | 1:e3b2027e685c | 631 | // setting = 0 makes this a pure virtual function, meaning the subclass must implement, like abstract in java |
| okini3939 | 1:e3b2027e685c | 632 | /** |
| okini3939 | 1:e3b2027e685c | 633 | * Starting after the frame id (pos = 0) and up to but not including the checksum |
| okini3939 | 1:e3b2027e685c | 634 | * Note: Unlike Digi's definition of the frame data, this does not start with the API ID. |
| okini3939 | 1:e3b2027e685c | 635 | * The reason for this is the API ID and Frame ID are common to all requests, whereas my definition of |
| okini3939 | 1:e3b2027e685c | 636 | * frame data is only the API specific data. |
| okini3939 | 1:e3b2027e685c | 637 | */ |
| okini3939 | 1:e3b2027e685c | 638 | virtual uint8_t getFrameData(uint8_t pos) = 0; |
| okini3939 | 1:e3b2027e685c | 639 | /** |
| okini3939 | 1:e3b2027e685c | 640 | * Returns the size of the api frame (not including frame id or api id or checksum). |
| okini3939 | 1:e3b2027e685c | 641 | */ |
| okini3939 | 1:e3b2027e685c | 642 | virtual uint8_t getFrameDataLength() = 0; |
| okini3939 | 1:e3b2027e685c | 643 | //void reset(); |
| okini3939 | 1:e3b2027e685c | 644 | protected: |
| okini3939 | 1:e3b2027e685c | 645 | void setApiId(uint8_t apiId); |
| okini3939 | 1:e3b2027e685c | 646 | private: |
| okini3939 | 1:e3b2027e685c | 647 | uint8_t _apiId; |
| okini3939 | 1:e3b2027e685c | 648 | uint8_t _frameId; |
| okini3939 | 1:e3b2027e685c | 649 | }; |
| okini3939 | 1:e3b2027e685c | 650 | |
| okini3939 | 1:e3b2027e685c | 651 | // TODO add reset/clear method since responses are often reused |
| okini3939 | 1:e3b2027e685c | 652 | /** |
| okini3939 | 1:e3b2027e685c | 653 | * Primary interface for communicating with an XBee Radio. |
| okini3939 | 1:e3b2027e685c | 654 | * This class provides methods for sending and receiving packets with an XBee radio via the serial port. |
| okini3939 | 1:e3b2027e685c | 655 | * The XBee radio must be configured in API (packet) mode (AP=2) |
| okini3939 | 1:e3b2027e685c | 656 | * in order to use this software. |
| okini3939 | 1:e3b2027e685c | 657 | * <p/> |
| okini3939 | 1:e3b2027e685c | 658 | * Since this code is designed to run on a microcontroller, with only one thread, you are responsible for reading the |
| okini3939 | 1:e3b2027e685c | 659 | * data off the serial buffer in a timely manner. This involves a call to a variant of readPacket(...). |
| okini3939 | 1:e3b2027e685c | 660 | * If your serial port is receiving data faster than you are reading, you can expect to lose packets. |
| okini3939 | 1:e3b2027e685c | 661 | * Arduino only has a 128 byte serial buffer so it can easily overflow if two or more packets arrive |
| okini3939 | 1:e3b2027e685c | 662 | * without a call to readPacket(...) |
| okini3939 | 1:e3b2027e685c | 663 | * <p/> |
| okini3939 | 1:e3b2027e685c | 664 | * In order to conserve resources, this class only supports storing one response packet in memory at a time. |
| okini3939 | 1:e3b2027e685c | 665 | * This means that you must fully consume the packet prior to calling readPacket(...), because calling |
| okini3939 | 1:e3b2027e685c | 666 | * readPacket(...) overwrites the previous response. |
| okini3939 | 1:e3b2027e685c | 667 | * <p/> |
| okini3939 | 1:e3b2027e685c | 668 | * This class creates an array of size MAX_FRAME_DATA_SIZE for storing the response packet. You may want |
| okini3939 | 1:e3b2027e685c | 669 | * to adjust this value to conserve memory. |
| okini3939 | 1:e3b2027e685c | 670 | * |
| okini3939 | 1:e3b2027e685c | 671 | * \author Andrew Rapp |
| okini3939 | 1:e3b2027e685c | 672 | */ |
| okini3939 | 1:e3b2027e685c | 673 | class XBee { |
| okini3939 | 1:e3b2027e685c | 674 | public: |
| okini3939 | 1:e3b2027e685c | 675 | XBee(PinName p_tx, PinName p_rx); |
| okini3939 | 1:e3b2027e685c | 676 | // for eclipse dev only |
| okini3939 | 1:e3b2027e685c | 677 | // void setSerial(HardwareSerial serial); |
| okini3939 | 1:e3b2027e685c | 678 | /** |
| okini3939 | 1:e3b2027e685c | 679 | * Reads all available serial bytes until a packet is parsed, an error occurs, or the buffer is empty. |
| okini3939 | 1:e3b2027e685c | 680 | * You may call <i>xbee</i>.getResponse().isAvailable() after calling this method to determine if |
| okini3939 | 1:e3b2027e685c | 681 | * a packet is ready, or <i>xbee</i>.getResponse().isError() to determine if |
| okini3939 | 1:e3b2027e685c | 682 | * a error occurred. |
| okini3939 | 1:e3b2027e685c | 683 | * <p/> |
| okini3939 | 1:e3b2027e685c | 684 | * This method should always return quickly since it does not wait for serial data to arrive. |
| okini3939 | 1:e3b2027e685c | 685 | * You will want to use this method if you are doing other timely stuff in your loop, where |
| okini3939 | 1:e3b2027e685c | 686 | * a delay would cause problems. |
| okini3939 | 1:e3b2027e685c | 687 | * NOTE: calling this method resets the current response, so make sure you first consume the |
| okini3939 | 1:e3b2027e685c | 688 | * current response |
| okini3939 | 1:e3b2027e685c | 689 | */ |
| okini3939 | 1:e3b2027e685c | 690 | void readPacket(); |
| okini3939 | 1:e3b2027e685c | 691 | /** |
| okini3939 | 1:e3b2027e685c | 692 | * Waits a maximum of <i>timeout</i> milliseconds for a response packet before timing out; returns true if packet is read. |
| okini3939 | 1:e3b2027e685c | 693 | * Returns false if timeout or error occurs. |
| okini3939 | 1:e3b2027e685c | 694 | */ |
| okini3939 | 1:e3b2027e685c | 695 | bool readPacket(int timeout); |
| okini3939 | 1:e3b2027e685c | 696 | /** |
| okini3939 | 1:e3b2027e685c | 697 | * Reads until a packet is received or an error occurs. |
| okini3939 | 1:e3b2027e685c | 698 | * Caution: use this carefully since if you don't get a response, your Arduino code will hang on this |
| okini3939 | 1:e3b2027e685c | 699 | * call forever!! often it's better to use a timeout: readPacket(int) |
| okini3939 | 1:e3b2027e685c | 700 | */ |
| okini3939 | 1:e3b2027e685c | 701 | void readPacketUntilAvailable(); |
| okini3939 | 1:e3b2027e685c | 702 | /** |
| okini3939 | 1:e3b2027e685c | 703 | * Starts the serial connection at the supplied baud rate |
| okini3939 | 1:e3b2027e685c | 704 | */ |
| okini3939 | 1:e3b2027e685c | 705 | void begin(long baud); |
| okini3939 | 1:e3b2027e685c | 706 | void getResponse(XBeeResponse &response); |
| okini3939 | 1:e3b2027e685c | 707 | /** |
| okini3939 | 1:e3b2027e685c | 708 | * Returns a reference to the current response |
| okini3939 | 1:e3b2027e685c | 709 | * Note: once readPacket is called again this response will be overwritten! |
| okini3939 | 1:e3b2027e685c | 710 | */ |
| okini3939 | 1:e3b2027e685c | 711 | XBeeResponse& getResponse(); |
| okini3939 | 1:e3b2027e685c | 712 | /** |
| okini3939 | 1:e3b2027e685c | 713 | * Sends a XBeeRequest (TX packet) out the serial port |
| okini3939 | 1:e3b2027e685c | 714 | */ |
| okini3939 | 1:e3b2027e685c | 715 | void send(XBeeRequest &request); |
| okini3939 | 1:e3b2027e685c | 716 | //uint8_t sendAndWaitForResponse(XBeeRequest &request, int timeout); |
| okini3939 | 1:e3b2027e685c | 717 | /** |
| okini3939 | 1:e3b2027e685c | 718 | * Returns a sequential frame id between 1 and 255 |
| okini3939 | 1:e3b2027e685c | 719 | */ |
| okini3939 | 1:e3b2027e685c | 720 | uint8_t getNextFrameId(); |
| okini3939 | 1:e3b2027e685c | 721 | private: |
| okini3939 | 1:e3b2027e685c | 722 | void sendByte(uint8_t b, bool escape); |
| okini3939 | 1:e3b2027e685c | 723 | void resetResponse(); |
| okini3939 | 1:e3b2027e685c | 724 | XBeeResponse _response; |
| okini3939 | 1:e3b2027e685c | 725 | bool _escape; |
| okini3939 | 1:e3b2027e685c | 726 | // current packet position for response. just a state variable for packet parsing and has no relevance for the response otherwise |
| okini3939 | 1:e3b2027e685c | 727 | uint8_t _pos; |
| okini3939 | 1:e3b2027e685c | 728 | // last byte read |
| okini3939 | 1:e3b2027e685c | 729 | uint8_t b; |
| okini3939 | 1:e3b2027e685c | 730 | uint8_t _checksumTotal; |
| okini3939 | 1:e3b2027e685c | 731 | uint8_t _nextFrameId; |
| okini3939 | 1:e3b2027e685c | 732 | // buffer for incoming RX packets. holds only the api specific frame data, starting after the api id byte and prior to checksum |
| okini3939 | 1:e3b2027e685c | 733 | uint8_t _responseFrameData[MAX_FRAME_DATA_SIZE]; |
| okini3939 | 1:e3b2027e685c | 734 | Serial _xbee; |
| okini3939 | 1:e3b2027e685c | 735 | }; |
| okini3939 | 1:e3b2027e685c | 736 | |
| okini3939 | 1:e3b2027e685c | 737 | /** |
| okini3939 | 1:e3b2027e685c | 738 | * All TX packets that support payloads extend this class |
| okini3939 | 1:e3b2027e685c | 739 | */ |
| okini3939 | 1:e3b2027e685c | 740 | class PayloadRequest : public XBeeRequest { |
| okini3939 | 1:e3b2027e685c | 741 | public: |
| okini3939 | 1:e3b2027e685c | 742 | PayloadRequest(uint8_t apiId, uint8_t frameId, uint8_t *payload, uint8_t payloadLength); |
| okini3939 | 1:e3b2027e685c | 743 | /** |
| okini3939 | 1:e3b2027e685c | 744 | * Returns the payload of the packet, if not null |
| okini3939 | 1:e3b2027e685c | 745 | */ |
| okini3939 | 1:e3b2027e685c | 746 | uint8_t* getPayload(); |
| okini3939 | 1:e3b2027e685c | 747 | /** |
| okini3939 | 1:e3b2027e685c | 748 | * Sets the payload array |
| okini3939 | 1:e3b2027e685c | 749 | */ |
| okini3939 | 1:e3b2027e685c | 750 | void setPayload(uint8_t* payloadPtr); |
| okini3939 | 1:e3b2027e685c | 751 | /** |
| okini3939 | 1:e3b2027e685c | 752 | * Returns the length of the payload array, as specified by the user. |
| okini3939 | 1:e3b2027e685c | 753 | */ |
| okini3939 | 1:e3b2027e685c | 754 | uint8_t getPayloadLength(); |
| okini3939 | 1:e3b2027e685c | 755 | /** |
| okini3939 | 1:e3b2027e685c | 756 | * Sets the length of the payload to include in the request. For example if the payload array |
| okini3939 | 1:e3b2027e685c | 757 | * is 50 bytes and you only want the first 10 to be included in the packet, set the length to 10. |
| okini3939 | 1:e3b2027e685c | 758 | * Length must be <= to the array length. |
| okini3939 | 1:e3b2027e685c | 759 | */ |
| okini3939 | 1:e3b2027e685c | 760 | void setPayloadLength(uint8_t payloadLength); |
| okini3939 | 1:e3b2027e685c | 761 | private: |
| okini3939 | 1:e3b2027e685c | 762 | uint8_t* _payloadPtr; |
| okini3939 | 1:e3b2027e685c | 763 | uint8_t _payloadLength; |
| okini3939 | 1:e3b2027e685c | 764 | }; |
| okini3939 | 1:e3b2027e685c | 765 | |
| okini3939 | 1:e3b2027e685c | 766 | #ifdef SERIES_1 |
| okini3939 | 1:e3b2027e685c | 767 | |
| okini3939 | 1:e3b2027e685c | 768 | /** |
| okini3939 | 1:e3b2027e685c | 769 | * Represents a Series 1 TX packet that corresponds to Api Id: TX_16_REQUEST |
| okini3939 | 1:e3b2027e685c | 770 | * <p/> |
| okini3939 | 1:e3b2027e685c | 771 | * Be careful not to send a data array larger than the max packet size of your radio. |
| okini3939 | 1:e3b2027e685c | 772 | * This class does not perform any validation of packet size and there will be no indication |
| okini3939 | 1:e3b2027e685c | 773 | * if the packet is too large, other than you will not get a TX Status response. |
| okini3939 | 1:e3b2027e685c | 774 | * The datasheet says 100 bytes is the maximum, although that could change in future firmware. |
| okini3939 | 1:e3b2027e685c | 775 | */ |
| okini3939 | 1:e3b2027e685c | 776 | class Tx16Request : public PayloadRequest { |
| okini3939 | 1:e3b2027e685c | 777 | public: |
| okini3939 | 1:e3b2027e685c | 778 | Tx16Request(uint16_t addr16, uint8_t option, uint8_t *payload, uint8_t payloadLength, uint8_t frameId); |
| okini3939 | 1:e3b2027e685c | 779 | /** |
| okini3939 | 1:e3b2027e685c | 780 | * Creates a Unicast Tx16Request with the ACK option and DEFAULT_FRAME_ID |
| okini3939 | 1:e3b2027e685c | 781 | */ |
| okini3939 | 1:e3b2027e685c | 782 | Tx16Request(uint16_t addr16, uint8_t *payload, uint8_t payloadLength); |
| okini3939 | 1:e3b2027e685c | 783 | /** |
| okini3939 | 1:e3b2027e685c | 784 | * Creates a default instance of this class. At a minimum you must specify |
| okini3939 | 1:e3b2027e685c | 785 | * a payload, payload length and a destination address before sending this request. |
| okini3939 | 1:e3b2027e685c | 786 | */ |
| okini3939 | 1:e3b2027e685c | 787 | Tx16Request(); |
| okini3939 | 1:e3b2027e685c | 788 | uint16_t getAddress16(); |
| okini3939 | 1:e3b2027e685c | 789 | void setAddress16(uint16_t addr16); |
| okini3939 | 1:e3b2027e685c | 790 | uint8_t getOption(); |
| okini3939 | 1:e3b2027e685c | 791 | void setOption(uint8_t option); |
| okini3939 | 1:e3b2027e685c | 792 | virtual uint8_t getFrameData(uint8_t pos); |
| okini3939 | 1:e3b2027e685c | 793 | virtual uint8_t getFrameDataLength(); |
| okini3939 | 1:e3b2027e685c | 794 | protected: |
| okini3939 | 1:e3b2027e685c | 795 | private: |
| okini3939 | 1:e3b2027e685c | 796 | uint16_t _addr16; |
| okini3939 | 1:e3b2027e685c | 797 | uint8_t _option; |
| okini3939 | 1:e3b2027e685c | 798 | }; |
| okini3939 | 1:e3b2027e685c | 799 | |
| okini3939 | 1:e3b2027e685c | 800 | /** |
| okini3939 | 1:e3b2027e685c | 801 | * Represents a Series 1 TX packet that corresponds to Api Id: TX_64_REQUEST |
| okini3939 | 1:e3b2027e685c | 802 | * |
| okini3939 | 1:e3b2027e685c | 803 | * Be careful not to send a data array larger than the max packet size of your radio. |
| okini3939 | 1:e3b2027e685c | 804 | * This class does not perform any validation of packet size and there will be no indication |
| okini3939 | 1:e3b2027e685c | 805 | * if the packet is too large, other than you will not get a TX Status response. |
| okini3939 | 1:e3b2027e685c | 806 | * The datasheet says 100 bytes is the maximum, although that could change in future firmware. |
| okini3939 | 1:e3b2027e685c | 807 | */ |
| okini3939 | 1:e3b2027e685c | 808 | class Tx64Request : public PayloadRequest { |
| okini3939 | 1:e3b2027e685c | 809 | public: |
| okini3939 | 1:e3b2027e685c | 810 | Tx64Request(XBeeAddress64 &addr64, uint8_t option, uint8_t *payload, uint8_t payloadLength, uint8_t frameId); |
| okini3939 | 1:e3b2027e685c | 811 | /** |
| okini3939 | 1:e3b2027e685c | 812 | * Creates a unicast Tx64Request with the ACK option and DEFAULT_FRAME_ID |
| okini3939 | 1:e3b2027e685c | 813 | */ |
| okini3939 | 1:e3b2027e685c | 814 | Tx64Request(XBeeAddress64 &addr64, uint8_t *payload, uint8_t payloadLength); |
| okini3939 | 1:e3b2027e685c | 815 | /** |
| okini3939 | 1:e3b2027e685c | 816 | * Creates a default instance of this class. At a minimum you must specify |
| okini3939 | 1:e3b2027e685c | 817 | * a payload, payload length and a destination address before sending this request. |
| okini3939 | 1:e3b2027e685c | 818 | */ |
| okini3939 | 1:e3b2027e685c | 819 | Tx64Request(); |
| okini3939 | 1:e3b2027e685c | 820 | XBeeAddress64& getAddress64(); |
| okini3939 | 1:e3b2027e685c | 821 | void setAddress64(XBeeAddress64& addr64); |
| okini3939 | 1:e3b2027e685c | 822 | // TODO move option to superclass |
| okini3939 | 1:e3b2027e685c | 823 | uint8_t getOption(); |
| okini3939 | 1:e3b2027e685c | 824 | void setOption(uint8_t option); |
| okini3939 | 1:e3b2027e685c | 825 | virtual uint8_t getFrameData(uint8_t pos); |
| okini3939 | 1:e3b2027e685c | 826 | virtual uint8_t getFrameDataLength(); |
| okini3939 | 1:e3b2027e685c | 827 | private: |
| okini3939 | 1:e3b2027e685c | 828 | XBeeAddress64 _addr64; |
| okini3939 | 1:e3b2027e685c | 829 | uint8_t _option; |
| okini3939 | 1:e3b2027e685c | 830 | }; |
| okini3939 | 1:e3b2027e685c | 831 | |
| okini3939 | 1:e3b2027e685c | 832 | #endif |
| okini3939 | 1:e3b2027e685c | 833 | |
| okini3939 | 1:e3b2027e685c | 834 | |
| okini3939 | 1:e3b2027e685c | 835 | #ifdef SERIES_2 |
| okini3939 | 1:e3b2027e685c | 836 | |
| okini3939 | 1:e3b2027e685c | 837 | /** |
| okini3939 | 1:e3b2027e685c | 838 | * Represents a Series 2 TX packet that corresponds to Api Id: ZB_TX_REQUEST |
| okini3939 | 1:e3b2027e685c | 839 | * |
| okini3939 | 1:e3b2027e685c | 840 | * Be careful not to send a data array larger than the max packet size of your radio. |
| okini3939 | 1:e3b2027e685c | 841 | * This class does not perform any validation of packet size and there will be no indication |
| okini3939 | 1:e3b2027e685c | 842 | * if the packet is too large, other than you will not get a TX Status response. |
| okini3939 | 1:e3b2027e685c | 843 | * The datasheet says 72 bytes is the maximum for ZNet firmware and ZB Pro firmware provides |
| okini3939 | 1:e3b2027e685c | 844 | * the ATNP command to get the max supported payload size. This command is useful since the |
| okini3939 | 1:e3b2027e685c | 845 | * maximum payload size varies according to certain settings, such as encryption. |
| okini3939 | 1:e3b2027e685c | 846 | * ZB Pro firmware provides a PAYLOAD_TOO_LARGE that is returned if payload size |
| okini3939 | 1:e3b2027e685c | 847 | * exceeds the maximum. |
| okini3939 | 1:e3b2027e685c | 848 | */ |
| okini3939 | 1:e3b2027e685c | 849 | class ZBTxRequest : public PayloadRequest { |
| okini3939 | 1:e3b2027e685c | 850 | public: |
| okini3939 | 1:e3b2027e685c | 851 | /** |
| okini3939 | 1:e3b2027e685c | 852 | * Creates a unicast ZBTxRequest with the ACK option and DEFAULT_FRAME_ID |
| okini3939 | 1:e3b2027e685c | 853 | */ |
| okini3939 | 1:e3b2027e685c | 854 | ZBTxRequest(XBeeAddress64 &addr64, uint8_t *payload, uint8_t payloadLength); |
| okini3939 | 1:e3b2027e685c | 855 | ZBTxRequest(XBeeAddress64 &addr64, uint16_t addr16, uint8_t broadcastRadius, uint8_t option, uint8_t *payload, uint8_t payloadLength, uint8_t frameId); |
| okini3939 | 1:e3b2027e685c | 856 | /** |
| okini3939 | 1:e3b2027e685c | 857 | * Creates a default instance of this class. At a minimum you must specify |
| okini3939 | 1:e3b2027e685c | 858 | * a payload, payload length and a destination address before sending this request. |
| okini3939 | 1:e3b2027e685c | 859 | */ |
| okini3939 | 1:e3b2027e685c | 860 | ZBTxRequest(); |
| okini3939 | 1:e3b2027e685c | 861 | XBeeAddress64& getAddress64(); |
| okini3939 | 1:e3b2027e685c | 862 | uint16_t getAddress16(); |
| okini3939 | 1:e3b2027e685c | 863 | uint8_t getBroadcastRadius(); |
| okini3939 | 1:e3b2027e685c | 864 | uint8_t getOption(); |
| okini3939 | 1:e3b2027e685c | 865 | void setAddress64(XBeeAddress64& addr64); |
| okini3939 | 1:e3b2027e685c | 866 | void setAddress16(uint16_t addr16); |
| okini3939 | 1:e3b2027e685c | 867 | void setBroadcastRadius(uint8_t broadcastRadius); |
| okini3939 | 1:e3b2027e685c | 868 | void setOption(uint8_t option); |
| okini3939 | 1:e3b2027e685c | 869 | protected: |
| okini3939 | 1:e3b2027e685c | 870 | // declare virtual functions |
| okini3939 | 1:e3b2027e685c | 871 | virtual uint8_t getFrameData(uint8_t pos); |
| okini3939 | 1:e3b2027e685c | 872 | virtual uint8_t getFrameDataLength(); |
| okini3939 | 1:e3b2027e685c | 873 | private: |
| okini3939 | 1:e3b2027e685c | 874 | XBeeAddress64 _addr64; |
| okini3939 | 1:e3b2027e685c | 875 | uint16_t _addr16; |
| okini3939 | 1:e3b2027e685c | 876 | uint8_t _broadcastRadius; |
| okini3939 | 1:e3b2027e685c | 877 | uint8_t _option; |
| okini3939 | 1:e3b2027e685c | 878 | }; |
| okini3939 | 1:e3b2027e685c | 879 | |
| okini3939 | 1:e3b2027e685c | 880 | #endif |
| okini3939 | 1:e3b2027e685c | 881 | |
| okini3939 | 1:e3b2027e685c | 882 | /** |
| okini3939 | 1:e3b2027e685c | 883 | * Represents an AT Command TX packet |
| okini3939 | 1:e3b2027e685c | 884 | * The command is used to configure the serially connected XBee radio |
| okini3939 | 1:e3b2027e685c | 885 | */ |
| okini3939 | 1:e3b2027e685c | 886 | class AtCommandRequest : public XBeeRequest { |
| okini3939 | 1:e3b2027e685c | 887 | public: |
| okini3939 | 1:e3b2027e685c | 888 | AtCommandRequest(); |
| okini3939 | 1:e3b2027e685c | 889 | AtCommandRequest(uint8_t *command); |
| okini3939 | 1:e3b2027e685c | 890 | AtCommandRequest(uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength); |
| okini3939 | 1:e3b2027e685c | 891 | virtual uint8_t getFrameData(uint8_t pos); |
| okini3939 | 1:e3b2027e685c | 892 | virtual uint8_t getFrameDataLength(); |
| okini3939 | 1:e3b2027e685c | 893 | uint8_t* getCommand(); |
| okini3939 | 1:e3b2027e685c | 894 | void setCommand(uint8_t* command); |
| okini3939 | 1:e3b2027e685c | 895 | uint8_t* getCommandValue(); |
| okini3939 | 1:e3b2027e685c | 896 | void setCommandValue(uint8_t* command); |
| okini3939 | 1:e3b2027e685c | 897 | uint8_t getCommandValueLength(); |
| okini3939 | 1:e3b2027e685c | 898 | void setCommandValueLength(uint8_t length); |
| okini3939 | 1:e3b2027e685c | 899 | /** |
| okini3939 | 1:e3b2027e685c | 900 | * Clears the optional commandValue and commandValueLength so that a query may be sent |
| okini3939 | 1:e3b2027e685c | 901 | */ |
| okini3939 | 1:e3b2027e685c | 902 | void clearCommandValue(); |
| okini3939 | 1:e3b2027e685c | 903 | //void reset(); |
| okini3939 | 1:e3b2027e685c | 904 | private: |
| okini3939 | 1:e3b2027e685c | 905 | uint8_t *_command; |
| okini3939 | 1:e3b2027e685c | 906 | uint8_t *_commandValue; |
| okini3939 | 1:e3b2027e685c | 907 | uint8_t _commandValueLength; |
| okini3939 | 1:e3b2027e685c | 908 | }; |
| okini3939 | 1:e3b2027e685c | 909 | |
| okini3939 | 1:e3b2027e685c | 910 | /** |
| okini3939 | 1:e3b2027e685c | 911 | * Represents an Remote AT Command TX packet |
| okini3939 | 1:e3b2027e685c | 912 | * The command is used to configure a remote XBee radio |
| okini3939 | 1:e3b2027e685c | 913 | */ |
| okini3939 | 1:e3b2027e685c | 914 | class RemoteAtCommandRequest : public AtCommandRequest { |
| okini3939 | 1:e3b2027e685c | 915 | public: |
| okini3939 | 1:e3b2027e685c | 916 | RemoteAtCommandRequest(); |
| okini3939 | 1:e3b2027e685c | 917 | /** |
| okini3939 | 1:e3b2027e685c | 918 | * Creates a RemoteAtCommandRequest with 16-bit address to set a command. |
| okini3939 | 1:e3b2027e685c | 919 | * 64-bit address defaults to broadcast and applyChanges is true. |
| okini3939 | 1:e3b2027e685c | 920 | */ |
| okini3939 | 1:e3b2027e685c | 921 | RemoteAtCommandRequest(uint16_t remoteAddress16, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength); |
| okini3939 | 1:e3b2027e685c | 922 | /** |
| okini3939 | 1:e3b2027e685c | 923 | * Creates a RemoteAtCommandRequest with 16-bit address to query a command. |
| okini3939 | 1:e3b2027e685c | 924 | * 64-bit address defaults to broadcast and applyChanges is true. |
| okini3939 | 1:e3b2027e685c | 925 | */ |
| okini3939 | 1:e3b2027e685c | 926 | RemoteAtCommandRequest(uint16_t remoteAddress16, uint8_t *command); |
| okini3939 | 1:e3b2027e685c | 927 | /** |
| okini3939 | 1:e3b2027e685c | 928 | * Creates a RemoteAtCommandRequest with 64-bit address to set a command. |
| okini3939 | 1:e3b2027e685c | 929 | * 16-bit address defaults to broadcast and applyChanges is true. |
| okini3939 | 1:e3b2027e685c | 930 | */ |
| okini3939 | 1:e3b2027e685c | 931 | RemoteAtCommandRequest(XBeeAddress64 &remoteAddress64, uint8_t *command, uint8_t *commandValue, uint8_t commandValueLength); |
| okini3939 | 1:e3b2027e685c | 932 | /** |
| okini3939 | 1:e3b2027e685c | 933 | * Creates a RemoteAtCommandRequest with 16-bit address to query a command. |
| okini3939 | 1:e3b2027e685c | 934 | * 16-bit address defaults to broadcast and applyChanges is true. |
| okini3939 | 1:e3b2027e685c | 935 | */ |
| okini3939 | 1:e3b2027e685c | 936 | RemoteAtCommandRequest(XBeeAddress64 &remoteAddress64, uint8_t *command); |
| okini3939 | 1:e3b2027e685c | 937 | uint16_t getRemoteAddress16(); |
| okini3939 | 1:e3b2027e685c | 938 | void setRemoteAddress16(uint16_t remoteAddress16); |
| okini3939 | 1:e3b2027e685c | 939 | XBeeAddress64& getRemoteAddress64(); |
| okini3939 | 1:e3b2027e685c | 940 | void setRemoteAddress64(XBeeAddress64 &remoteAddress64); |
| okini3939 | 1:e3b2027e685c | 941 | bool getApplyChanges(); |
| okini3939 | 1:e3b2027e685c | 942 | void setApplyChanges(bool applyChanges); |
| okini3939 | 1:e3b2027e685c | 943 | virtual uint8_t getFrameData(uint8_t pos); |
| okini3939 | 1:e3b2027e685c | 944 | virtual uint8_t getFrameDataLength(); |
| okini3939 | 1:e3b2027e685c | 945 | static XBeeAddress64 broadcastAddress64; |
| okini3939 | 1:e3b2027e685c | 946 | // static uint16_t broadcast16Address; |
| okini3939 | 1:e3b2027e685c | 947 | private: |
| okini3939 | 1:e3b2027e685c | 948 | XBeeAddress64 _remoteAddress64; |
| okini3939 | 1:e3b2027e685c | 949 | uint16_t _remoteAddress16; |
| okini3939 | 1:e3b2027e685c | 950 | bool _applyChanges; |
| okini3939 | 1:e3b2027e685c | 951 | }; |
| okini3939 | 1:e3b2027e685c | 952 | |
| okini3939 | 1:e3b2027e685c | 953 | |
| okini3939 | 1:e3b2027e685c | 954 | |
| okini3939 | 1:e3b2027e685c | 955 | #endif //XBee_h |