lel
Fork of XBeeLib by
XBeeZB/XBeeZB.h@2:2ee1b6d51df2, 2015-05-14 (annotated)
- Committer:
- hbujanda
- Date:
- Thu May 14 16:21:39 2015 +0200
- Revision:
- 2:2ee1b6d51df2
- Parent:
- 1:794d1d3e4a08
- Child:
- 3:8662ebe83570
Automatic upload
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
spastor | 0:fcaad0dfa051 | 1 | /** |
spastor | 0:fcaad0dfa051 | 2 | * Copyright (c) 2015 Digi International Inc., |
spastor | 0:fcaad0dfa051 | 3 | * All rights not expressly granted are reserved. |
spastor | 0:fcaad0dfa051 | 4 | * |
spastor | 0:fcaad0dfa051 | 5 | * This Source Code Form is subject to the terms of the Mozilla Public |
spastor | 0:fcaad0dfa051 | 6 | * License, v. 2.0. If a copy of the MPL was not distributed with this file, |
spastor | 0:fcaad0dfa051 | 7 | * You can obtain one at http://mozilla.org/MPL/2.0/. |
spastor | 0:fcaad0dfa051 | 8 | * |
spastor | 0:fcaad0dfa051 | 9 | * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343 |
spastor | 0:fcaad0dfa051 | 10 | * ======================================================================= |
spastor | 0:fcaad0dfa051 | 11 | */ |
spastor | 0:fcaad0dfa051 | 12 | |
spastor | 0:fcaad0dfa051 | 13 | #if !defined(__XBEE_ZB_H_) |
spastor | 0:fcaad0dfa051 | 14 | #define __XBEE_ZB_H_ |
spastor | 0:fcaad0dfa051 | 15 | |
spastor | 0:fcaad0dfa051 | 16 | #include "XBee/XBee.h" |
spastor | 0:fcaad0dfa051 | 17 | #include "FrameHandlers/FH_AtCmdResp.h" |
spastor | 0:fcaad0dfa051 | 18 | #include "FrameHandlers/FH_RxPacketZB.h" |
spastor | 0:fcaad0dfa051 | 19 | #include "FrameHandlers/FH_IoDataSampleZB.h" |
spastor | 0:fcaad0dfa051 | 20 | #include "RemoteXBee/RemoteXBee.h" |
spastor | 0:fcaad0dfa051 | 21 | |
spastor | 0:fcaad0dfa051 | 22 | namespace XBeeLib { |
spastor | 0:fcaad0dfa051 | 23 | |
spastor | 0:fcaad0dfa051 | 24 | /** Class for XBee ZigBee modules, derived from XBee */ |
spastor | 0:fcaad0dfa051 | 25 | class XBeeZB : public XBee |
spastor | 0:fcaad0dfa051 | 26 | { |
spastor | 0:fcaad0dfa051 | 27 | public: |
spastor | 0:fcaad0dfa051 | 28 | |
spastor | 0:fcaad0dfa051 | 29 | /** |
spastor | 0:fcaad0dfa051 | 30 | * IoLine for XBeeZB Modules |
spastor | 0:fcaad0dfa051 | 31 | */ |
spastor | 0:fcaad0dfa051 | 32 | enum IoLine { |
spastor | 0:fcaad0dfa051 | 33 | DIO0_AD0 = 0, /**< DIO0_AD0 pin */ |
spastor | 0:fcaad0dfa051 | 34 | DIO1_AD1 = 1, /**< DIO1_AD1 pin */ |
spastor | 0:fcaad0dfa051 | 35 | DIO2_AD2 = 2, /**< DIO2_AD2 pin */ |
spastor | 0:fcaad0dfa051 | 36 | DIO3_AD3 = 3, /**< DIO3_AD3 pin */ |
spastor | 0:fcaad0dfa051 | 37 | DIO4 = 4, /**< DIO4 pin */ |
spastor | 0:fcaad0dfa051 | 38 | DIO5 = 5, /**< DIO5 pin */ |
spastor | 0:fcaad0dfa051 | 39 | DIO6 = 6, /**< DIO6 pin */ |
spastor | 0:fcaad0dfa051 | 40 | DIO7 = 7, /**< DIO7 pin */ |
spastor | 0:fcaad0dfa051 | 41 | DIO10 = 10, /**< DIO10 pin */ |
spastor | 0:fcaad0dfa051 | 42 | DIO11 = 11, /**< DIO11 pin */ |
spastor | 0:fcaad0dfa051 | 43 | DIO12 = 12, /**< DIO12 pin */ |
spastor | 0:fcaad0dfa051 | 44 | SUPPLY_VOLTAGE = 7, /**< SUPPLY_VOLTAGE is not a real pin */ |
spastor | 0:fcaad0dfa051 | 45 | }; |
spastor | 0:fcaad0dfa051 | 46 | |
spastor | 0:fcaad0dfa051 | 47 | /** Class constructor |
spastor | 0:fcaad0dfa051 | 48 | * @param tx the TX pin of the UART that will interface the XBee module |
spastor | 0:fcaad0dfa051 | 49 | * @param rx the RX pin of the UART that will interface the XBee module |
spastor | 0:fcaad0dfa051 | 50 | * @param reset the pin to which the XBee's reset line is attached to, use NC if not available |
spastor | 0:fcaad0dfa051 | 51 | * @param rts the RTS pin for the UART that will interface the XBee module, use NC if not available |
spastor | 0:fcaad0dfa051 | 52 | * @param cts the CTS pin for the UART that will interface the XBee module, use NC if not available |
spastor | 0:fcaad0dfa051 | 53 | * @param baud the baudrate for the UART that will interface the XBee module. Note that the module has to be already configured |
spastor | 0:fcaad0dfa051 | 54 | * to this baud rate (ATBD parameter). By default it is configured to 9600 bps |
spastor | 0:fcaad0dfa051 | 55 | */ |
spastor | 0:fcaad0dfa051 | 56 | XBeeZB(PinName tx, PinName rx, PinName reset = NC, PinName rts = NC, PinName cts = NC, int baud = 9600); |
spastor | 0:fcaad0dfa051 | 57 | |
spastor | 0:fcaad0dfa051 | 58 | /** Class destructor */ |
spastor | 0:fcaad0dfa051 | 59 | virtual ~XBeeZB(); |
spastor | 0:fcaad0dfa051 | 60 | |
spastor | 0:fcaad0dfa051 | 61 | /** init- initializes object |
spastor | 0:fcaad0dfa051 | 62 | * This function must be called just after creating the object so it initializes internal data. |
spastor | 0:fcaad0dfa051 | 63 | * @returns |
spastor | 0:fcaad0dfa051 | 64 | * Success if the module has been properly initialized and is ready to process data. |
spastor | 0:fcaad0dfa051 | 65 | * Failure otherwise. |
spastor | 0:fcaad0dfa051 | 66 | */ |
spastor | 0:fcaad0dfa051 | 67 | RadioStatus init(); |
spastor | 0:fcaad0dfa051 | 68 | |
spastor | 0:fcaad0dfa051 | 69 | /** set_panid - sets the 64bit extended PAN ID. |
spastor | 0:fcaad0dfa051 | 70 | * |
spastor | 0:fcaad0dfa051 | 71 | * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID |
spastor | 0:fcaad0dfa051 | 72 | * and the routers will join any extended PAN ID |
spastor | 0:fcaad0dfa051 | 73 | * @param panid the PAN ID value that will be set on the radio |
spastor | 0:fcaad0dfa051 | 74 | * @returns |
spastor | 0:fcaad0dfa051 | 75 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 76 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 77 | */ |
spastor | 0:fcaad0dfa051 | 78 | RadioStatus set_panid(uint64_t panid); |
spastor | 0:fcaad0dfa051 | 79 | |
spastor | 0:fcaad0dfa051 | 80 | /** get_configured_panid - gets the configured PAN ID, as it was set by @ref set_panid(). |
spastor | 0:fcaad0dfa051 | 81 | * |
spastor | 0:fcaad0dfa051 | 82 | * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID |
spastor | 0:fcaad0dfa051 | 83 | * and the routers will join any extended PAN ID |
spastor | 0:fcaad0dfa051 | 84 | * @param panid pointer where the configured PAN ID will be stored |
spastor | 0:fcaad0dfa051 | 85 | * @returns |
spastor | 0:fcaad0dfa051 | 86 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 87 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 88 | */ |
spastor | 0:fcaad0dfa051 | 89 | RadioStatus get_configured_panid(uint64_t * const panid); |
spastor | 0:fcaad0dfa051 | 90 | |
spastor | 0:fcaad0dfa051 | 91 | /** get_operating_panid - gets the operating 64bit extended PAN ID the module is running on. This is useful to determine the PAN ID when the ID parameter (@ref set_panid) is set to 0x00. |
spastor | 0:fcaad0dfa051 | 92 | * |
spastor | 0:fcaad0dfa051 | 93 | * @param panid pointer where the operating PAN ID will be stored |
spastor | 0:fcaad0dfa051 | 94 | * @returns |
spastor | 0:fcaad0dfa051 | 95 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 96 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 97 | */ |
spastor | 0:fcaad0dfa051 | 98 | RadioStatus get_operating_panid(uint64_t * const panid); |
spastor | 0:fcaad0dfa051 | 99 | |
spastor | 0:fcaad0dfa051 | 100 | /** set_panid - sets the 64bit extended PAN ID. |
spastor | 0:fcaad0dfa051 | 101 | * |
spastor | 0:fcaad0dfa051 | 102 | * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID |
spastor | 0:fcaad0dfa051 | 103 | * and the routers will join any extended PAN ID |
spastor | 0:fcaad0dfa051 | 104 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 105 | * @param panid the PAN ID value that will be set on the radio |
spastor | 0:fcaad0dfa051 | 106 | * @returns |
spastor | 0:fcaad0dfa051 | 107 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 108 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 109 | */ |
spastor | 0:fcaad0dfa051 | 110 | RadioStatus set_panid(const RemoteXBee& remote, uint64_t panid); |
spastor | 0:fcaad0dfa051 | 111 | |
spastor | 0:fcaad0dfa051 | 112 | /** get_configured_panid - gets the configured PAN ID in a remote node, as it was set by @ref set_panid() |
spastor | 0:fcaad0dfa051 | 113 | * |
spastor | 0:fcaad0dfa051 | 114 | * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID |
spastor | 0:fcaad0dfa051 | 115 | * and the routers will join any extended PAN ID |
spastor | 0:fcaad0dfa051 | 116 | * |
spastor | 0:fcaad0dfa051 | 117 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 118 | * @param panid pointer where the configured PAN ID will be stored |
spastor | 0:fcaad0dfa051 | 119 | * @returns |
spastor | 0:fcaad0dfa051 | 120 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 121 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 122 | */ |
spastor | 0:fcaad0dfa051 | 123 | RadioStatus get_configured_panid(const RemoteXBee& remote, uint64_t * const panid); |
spastor | 0:fcaad0dfa051 | 124 | |
spastor | 0:fcaad0dfa051 | 125 | /** get_operating_panid - gets the operating 64bit extended PAN ID in which a remote node is running on. This is useful to determine the PAN ID when the ID parameter (@ref set_panid) is set to 0x00. |
spastor | 0:fcaad0dfa051 | 126 | * |
spastor | 0:fcaad0dfa051 | 127 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 128 | * @param panid pointer where the operating PAN ID will be stored |
spastor | 0:fcaad0dfa051 | 129 | * @returns |
spastor | 0:fcaad0dfa051 | 130 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 131 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 132 | */ |
spastor | 0:fcaad0dfa051 | 133 | RadioStatus get_operating_panid(const RemoteXBee& remote, uint64_t * const panid); |
spastor | 0:fcaad0dfa051 | 134 | |
spastor | 0:fcaad0dfa051 | 135 | /** set_channel_mask - sets the channel mask in which the module will scan for the PAN ID (if it is a router or end-device) or start the network (if it is a coordinator). |
spastor | 0:fcaad0dfa051 | 136 | * It should be set to the minimum available set of channels of all nodes in the network. Refer to "SC" parameter in the product manual for more information. |
spastor | 0:fcaad0dfa051 | 137 | * |
spastor | 0:fcaad0dfa051 | 138 | * @param chmask bit field list of channels to scan (router/end-devices) or to choose when starting a network (coordinator). Bit 0 is for channel 0x0B and bit 15 for channel 0x1A. |
spastor | 0:fcaad0dfa051 | 139 | * @returns |
spastor | 0:fcaad0dfa051 | 140 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 141 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 142 | */ |
spastor | 0:fcaad0dfa051 | 143 | RadioStatus set_channel_mask(uint16_t const chmask); |
spastor | 0:fcaad0dfa051 | 144 | |
spastor | 0:fcaad0dfa051 | 145 | /** get_channel_mask - gets the channel mask in which the module will scan for the PAN ID (if it is a router or end-device) or start the network (if it is a coordinator). |
spastor | 0:fcaad0dfa051 | 146 | * |
spastor | 0:fcaad0dfa051 | 147 | * @param chmask pointer to where the configured channel mask will be stored |
spastor | 0:fcaad0dfa051 | 148 | * @returns |
spastor | 0:fcaad0dfa051 | 149 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 150 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 151 | */ |
spastor | 0:fcaad0dfa051 | 152 | RadioStatus get_channel_mask(uint16_t * const chmask); |
spastor | 0:fcaad0dfa051 | 153 | |
spastor | 0:fcaad0dfa051 | 154 | /** check_for_coordinator_at_start - (Routers only) If enabled, a router will verify the coordinator is on its operating channel when joining or coming up from a power cycle. |
spastor | 0:fcaad0dfa051 | 155 | * If a coordinator is not detected, the router will leave its current channel and attempt to join a new PAN. If JV=0, the router will continue operating on its current channel even if a coordinator is not detected. |
spastor | 0:fcaad0dfa051 | 156 | * |
spastor | 0:fcaad0dfa051 | 157 | * @param enable whether to enable this feature or not |
spastor | 0:fcaad0dfa051 | 158 | * @returns |
spastor | 0:fcaad0dfa051 | 159 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 160 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 161 | */ |
spastor | 0:fcaad0dfa051 | 162 | RadioStatus check_for_coordinator_at_start(bool enable); |
spastor | 0:fcaad0dfa051 | 163 | |
spastor | 0:fcaad0dfa051 | 164 | /** enable_network_encryption - Enable network encryption. |
spastor | 0:fcaad0dfa051 | 165 | * |
spastor | 0:fcaad0dfa051 | 166 | * @param enable whether to enable this feature or not |
spastor | 0:fcaad0dfa051 | 167 | * @returns |
spastor | 0:fcaad0dfa051 | 168 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 169 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 170 | */ |
spastor | 0:fcaad0dfa051 | 171 | RadioStatus enable_network_encryption(bool enable); |
spastor | 0:fcaad0dfa051 | 172 | |
spastor | 0:fcaad0dfa051 | 173 | /** set_encryption_key - Set the 128-bit AES network encryption key. If set to 0 (default), the module will select a random network key. |
spastor | 0:fcaad0dfa051 | 174 | * It is not recommended to set the key programmatically, because it could be read through the raw serial port bits. |
spastor | 0:fcaad0dfa051 | 175 | * @param key pointer to the 128-bit AES key |
spastor | 0:fcaad0dfa051 | 176 | * @param length size of the buffer pointed by 'key' |
spastor | 0:fcaad0dfa051 | 177 | * @returns |
spastor | 0:fcaad0dfa051 | 178 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 179 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 180 | */ |
spastor | 0:fcaad0dfa051 | 181 | RadioStatus set_encryption_key(const uint8_t * const key, const uint16_t length); |
spastor | 0:fcaad0dfa051 | 182 | |
spastor | 0:fcaad0dfa051 | 183 | /** set_tc_link_key - Set the Trust Center 128-bit AES link key. Setting it to 0 will cause the coordinator to transmit the network key in the clear to joining devices, and will cause joining devices to acquire the network key in the clear when joining. |
spastor | 0:fcaad0dfa051 | 184 | * It is not recommended to set the key programmatically, because it could be read through the raw serial port bits. |
spastor | 0:fcaad0dfa051 | 185 | * @param key pointer to the 128-bit AES key |
spastor | 0:fcaad0dfa051 | 186 | * @param length size of the buffer pointed by 'key' |
spastor | 0:fcaad0dfa051 | 187 | * @returns |
spastor | 0:fcaad0dfa051 | 188 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 189 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 190 | */ |
spastor | 0:fcaad0dfa051 | 191 | RadioStatus set_tc_link_key(const uint8_t * const key, const uint16_t length); |
spastor | 0:fcaad0dfa051 | 192 | |
spastor | 0:fcaad0dfa051 | 193 | #define XBEE_ZB_ENC_OPT_SEND_KEY_ON_JOIN 0x01 |
spastor | 0:fcaad0dfa051 | 194 | #define XBEE_ZB_ENC_OPT_USE_TRUST_CENTER 0x02 |
spastor | 0:fcaad0dfa051 | 195 | /** set_encryption_options - Configure options for encryption. Unused option bits should be set to 0. Options include: |
spastor | 0:fcaad0dfa051 | 196 | * - XBEE_ZB_ENC_OPT_SEND_KEY_ON_JOIN - Send the security key unsecured over-the-air during joins |
spastor | 0:fcaad0dfa051 | 197 | * - XBEE_ZB_ENC_OPT_USE_TRUST_CENTER - Use trust center (coordinator only) |
spastor | 0:fcaad0dfa051 | 198 | * @param options bit mask with the encryption options |
spastor | 0:fcaad0dfa051 | 199 | * @returns |
spastor | 0:fcaad0dfa051 | 200 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 201 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 202 | */ |
spastor | 0:fcaad0dfa051 | 203 | RadioStatus set_encryption_options(const uint8_t options); |
spastor | 0:fcaad0dfa051 | 204 | |
spastor | 0:fcaad0dfa051 | 205 | /** register_node_discovery_cb - registers the callback function that will be called |
spastor | 0:fcaad0dfa051 | 206 | * when the responses to the node discovery command arrive |
spastor | 0:fcaad0dfa051 | 207 | * |
spastor | 0:fcaad0dfa051 | 208 | * @param function function pointer with the callback function |
spastor | 0:fcaad0dfa051 | 209 | */ |
spastor | 0:fcaad0dfa051 | 210 | void register_node_discovery_cb(node_discovery_zb_cb_t function); |
spastor | 0:fcaad0dfa051 | 211 | |
spastor | 0:fcaad0dfa051 | 212 | /** unregister_node_discovery_cb - removes the node discovery callback */ |
spastor | 0:fcaad0dfa051 | 213 | void unregister_node_discovery_cb(); |
spastor | 0:fcaad0dfa051 | 214 | |
spastor | 0:fcaad0dfa051 | 215 | /** register_receive_cb - registers the callback function that will be called |
spastor | 0:fcaad0dfa051 | 216 | * when a data packet is received |
spastor | 0:fcaad0dfa051 | 217 | * |
spastor | 0:fcaad0dfa051 | 218 | * @param function function pointer with the callback function |
spastor | 0:fcaad0dfa051 | 219 | */ |
spastor | 0:fcaad0dfa051 | 220 | void register_receive_cb(receive_zb_cb_t function); |
spastor | 0:fcaad0dfa051 | 221 | |
spastor | 0:fcaad0dfa051 | 222 | /** unregister_receive_cb - removes the rx packet callback */ |
spastor | 0:fcaad0dfa051 | 223 | void unregister_receive_cb(); |
spastor | 0:fcaad0dfa051 | 224 | |
spastor | 0:fcaad0dfa051 | 225 | /** register_io_sample_cb - registers the callback function that will be called |
spastor | 0:fcaad0dfa051 | 226 | * when a IO Sample Data packet is received |
spastor | 0:fcaad0dfa051 | 227 | * |
spastor | 0:fcaad0dfa051 | 228 | * @param function function pointer with the callback function |
spastor | 0:fcaad0dfa051 | 229 | */ |
spastor | 0:fcaad0dfa051 | 230 | void register_io_sample_cb(io_data_cb_zb_t function); |
spastor | 0:fcaad0dfa051 | 231 | |
spastor | 0:fcaad0dfa051 | 232 | /** unregister_io_sample_cb - removes the IO Sample Data reception callback */ |
spastor | 0:fcaad0dfa051 | 233 | void unregister_io_sample_cb(); |
spastor | 0:fcaad0dfa051 | 234 | |
spastor | 0:fcaad0dfa051 | 235 | /** get_network_role - returns the role of this device in the ZigBee network |
spastor | 0:fcaad0dfa051 | 236 | * |
spastor | 0:fcaad0dfa051 | 237 | * @returns the role of this device |
spastor | 0:fcaad0dfa051 | 238 | */ |
spastor | 0:fcaad0dfa051 | 239 | NetworkRole get_network_role(); |
spastor | 0:fcaad0dfa051 | 240 | /** */ |
spastor | 0:fcaad0dfa051 | 241 | |
spastor | 0:fcaad0dfa051 | 242 | /*********************** send_data member methods ************************/ |
spastor | 0:fcaad0dfa051 | 243 | /** send_data - sends data to a remote device waiting for the packet |
spastor | 0:fcaad0dfa051 | 244 | * answer with the result of the operation |
spastor | 0:fcaad0dfa051 | 245 | * |
spastor | 0:fcaad0dfa051 | 246 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 247 | * @param data pointer to the data that will be sent |
spastor | 0:fcaad0dfa051 | 248 | * @param len number of bytes that will be transmitted |
spastor | 0:fcaad0dfa051 | 249 | * @returns the result of the data transfer |
spastor | 0:fcaad0dfa051 | 250 | * TxStatusSuccess if the operation was successful, |
spastor | 0:fcaad0dfa051 | 251 | * the error code otherwise |
spastor | 0:fcaad0dfa051 | 252 | */ |
spastor | 0:fcaad0dfa051 | 253 | virtual TxStatus send_data(const RemoteXBee& remote, const uint8_t *const data, uint16_t len); |
spastor | 0:fcaad0dfa051 | 254 | |
hbujanda | 2:2ee1b6d51df2 | 255 | /** send_data_asyncr - sends data to a remote device not waiting for the packet answer |
spastor | 0:fcaad0dfa051 | 256 | * |
hbujanda | 2:2ee1b6d51df2 | 257 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 258 | * @param data pointer to the data that will be sent |
spastor | 0:fcaad0dfa051 | 259 | * @param len number of bytes that will be transmitted |
spastor | 0:fcaad0dfa051 | 260 | * @returns the result of the data transfer |
spastor | 0:fcaad0dfa051 | 261 | * TxStatusSuccess if the operation was successful, |
spastor | 0:fcaad0dfa051 | 262 | * the error code otherwise |
spastor | 0:fcaad0dfa051 | 263 | */ |
hbujanda | 2:2ee1b6d51df2 | 264 | TxStatus send_data_asyncr(const RemoteXBee& remote, const uint8_t *const data, uint16_t len); |
spastor | 0:fcaad0dfa051 | 265 | |
spastor | 0:fcaad0dfa051 | 266 | /** send_data - sends data to a remote device waiting for the packet |
spastor | 0:fcaad0dfa051 | 267 | * answer with the result of the operation. This method uses |
spastor | 0:fcaad0dfa051 | 268 | * the explicit addressing frame, allowing to use source and |
spastor | 0:fcaad0dfa051 | 269 | * destination end points and cluster and profile IDs |
spastor | 0:fcaad0dfa051 | 270 | * |
spastor | 0:fcaad0dfa051 | 271 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 272 | * @param source_ep source end point |
spastor | 0:fcaad0dfa051 | 273 | * @param dest_ep destination end point |
spastor | 0:fcaad0dfa051 | 274 | * @param cluster_id cluster ID |
spastor | 0:fcaad0dfa051 | 275 | * @param profile_id profile ID |
spastor | 0:fcaad0dfa051 | 276 | * @param data pointer to the data that will be sent |
spastor | 0:fcaad0dfa051 | 277 | * @param len number of bytes that will be transmitted |
spastor | 0:fcaad0dfa051 | 278 | * @returns the result of the data transfer |
spastor | 0:fcaad0dfa051 | 279 | * TxStatusSuccess if the operation was successful, |
spastor | 0:fcaad0dfa051 | 280 | * the error code otherwise |
spastor | 0:fcaad0dfa051 | 281 | */ |
spastor | 0:fcaad0dfa051 | 282 | TxStatus send_data(const RemoteXBee& remote, uint8_t source_ep, |
spastor | 0:fcaad0dfa051 | 283 | uint8_t dest_ep, uint16_t cluster_id, uint16_t profile_id, |
spastor | 0:fcaad0dfa051 | 284 | const uint8_t *const data, uint16_t len); |
spastor | 0:fcaad0dfa051 | 285 | |
spastor | 0:fcaad0dfa051 | 286 | /** send_data_to_coordinator - sends data to the ZigBee coordinator waiting for the |
spastor | 0:fcaad0dfa051 | 287 | * packet answer with the result of the operation |
spastor | 0:fcaad0dfa051 | 288 | * |
spastor | 0:fcaad0dfa051 | 289 | * @param data pointer to the data that will be sent |
spastor | 0:fcaad0dfa051 | 290 | * @param len number of bytes that will be transmitted |
spastor | 0:fcaad0dfa051 | 291 | * @returns the result of the data transfer |
spastor | 0:fcaad0dfa051 | 292 | * TxStatusSuccess if the operation was successful, |
spastor | 0:fcaad0dfa051 | 293 | * the error code otherwise |
spastor | 0:fcaad0dfa051 | 294 | */ |
spastor | 0:fcaad0dfa051 | 295 | TxStatus send_data_to_coordinator(const uint8_t *const data, uint16_t len); |
spastor | 0:fcaad0dfa051 | 296 | |
spastor | 0:fcaad0dfa051 | 297 | /** is_joined - checks if the device is joined to ZigBee network |
spastor | 0:fcaad0dfa051 | 298 | * @returns true if joined, false otherwise |
spastor | 0:fcaad0dfa051 | 299 | */ |
spastor | 0:fcaad0dfa051 | 300 | bool is_joined(); |
spastor | 0:fcaad0dfa051 | 301 | |
hbujanda | 2:2ee1b6d51df2 | 302 | /** get_remote_node_by_id - searches for a device in the network with the specified Node Identifier. |
spastor | 0:fcaad0dfa051 | 303 | * |
spastor | 0:fcaad0dfa051 | 304 | * @param node_id node id of the device we are looking for |
hbujanda | 2:2ee1b6d51df2 | 305 | * @returns a RemoteXBeeZB with the 16-bit and 64-bit address of the remote device whose node id matches with the parameter. |
hbujanda | 2:2ee1b6d51df2 | 306 | * If node is not found, the returned object will have invalid addresses (RemoteXBeeZB::is_valid() will return false). |
spastor | 0:fcaad0dfa051 | 307 | */ |
hbujanda | 2:2ee1b6d51df2 | 308 | RemoteXBeeZB get_remote_node_by_id(const char * const node_id); |
spastor | 0:fcaad0dfa051 | 309 | |
spastor | 0:fcaad0dfa051 | 310 | /* Allow using XBee::set_param() methods for local radio from this class */ |
spastor | 0:fcaad0dfa051 | 311 | using XBee::set_param; |
spastor | 0:fcaad0dfa051 | 312 | |
spastor | 0:fcaad0dfa051 | 313 | /** set_param - sets a parameter in a remote radio by sending an AT command and waiting for the response. |
spastor | 0:fcaad0dfa051 | 314 | * |
spastor | 0:fcaad0dfa051 | 315 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 316 | * @param param parameter to be set. |
spastor | 0:fcaad0dfa051 | 317 | * @param data the parameter value (4 bytes) to be set. |
spastor | 0:fcaad0dfa051 | 318 | * @returns the command response status. |
spastor | 0:fcaad0dfa051 | 319 | */ |
spastor | 0:fcaad0dfa051 | 320 | virtual AtCmdFrame::AtCmdResp set_param(const RemoteXBee& remote, const char * const param, uint32_t data); |
spastor | 0:fcaad0dfa051 | 321 | |
spastor | 0:fcaad0dfa051 | 322 | /** set_param - sets a parameter in a remote radio by sending an AT command and waiting for the response. |
spastor | 0:fcaad0dfa051 | 323 | * |
spastor | 0:fcaad0dfa051 | 324 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 325 | * @param param parameter to be set. |
spastor | 0:fcaad0dfa051 | 326 | * @param data the parameter value byte array (len bytes) to be set. |
spastor | 0:fcaad0dfa051 | 327 | * @param len number of bytes of the parameter value. |
spastor | 0:fcaad0dfa051 | 328 | * @returns the command response status. |
spastor | 0:fcaad0dfa051 | 329 | */ |
spastor | 0:fcaad0dfa051 | 330 | virtual AtCmdFrame::AtCmdResp set_param(const RemoteXBee& remote, const char * const param, const uint8_t * data = NULL, uint16_t len = 0); |
spastor | 0:fcaad0dfa051 | 331 | |
spastor | 0:fcaad0dfa051 | 332 | /* Allow using XBee::get_param() methods for local radio from this class */ |
spastor | 0:fcaad0dfa051 | 333 | using XBee::get_param; |
spastor | 0:fcaad0dfa051 | 334 | |
spastor | 0:fcaad0dfa051 | 335 | /** get_param - gets a parameter from a remote radio by sending an AT command and waiting for the response. |
spastor | 0:fcaad0dfa051 | 336 | * |
spastor | 0:fcaad0dfa051 | 337 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 338 | * @param param parameter to be get. |
spastor | 0:fcaad0dfa051 | 339 | * @param data pointer where the param value (4 bytes) will be stored. |
spastor | 0:fcaad0dfa051 | 340 | * @returns the command response status. |
spastor | 0:fcaad0dfa051 | 341 | */ |
spastor | 0:fcaad0dfa051 | 342 | virtual AtCmdFrame::AtCmdResp get_param(const RemoteXBee& remote, const char * const param, uint32_t * const data); |
spastor | 0:fcaad0dfa051 | 343 | |
spastor | 0:fcaad0dfa051 | 344 | /** get_param - gets a parameter from a remote radio by sending an AT command and waiting for the response. |
spastor | 0:fcaad0dfa051 | 345 | * |
spastor | 0:fcaad0dfa051 | 346 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 347 | * @param param parameter to be get. |
spastor | 0:fcaad0dfa051 | 348 | * @param data pointer where the param value (n bytes) will be stored. |
spastor | 0:fcaad0dfa051 | 349 | * @param len pointer where the number of bytes of the param value will be stored. |
spastor | 0:fcaad0dfa051 | 350 | * @returns the command response status. |
spastor | 0:fcaad0dfa051 | 351 | */ |
spastor | 0:fcaad0dfa051 | 352 | virtual AtCmdFrame::AtCmdResp get_param(const RemoteXBee& remote, const char * const param, uint8_t * const data, uint16_t * const len); |
spastor | 0:fcaad0dfa051 | 353 | |
spastor | 0:fcaad0dfa051 | 354 | /************************* IO member methods **************************/ |
spastor | 0:fcaad0dfa051 | 355 | /** set_pin_config - configures a radio IO line |
spastor | 0:fcaad0dfa051 | 356 | * |
spastor | 0:fcaad0dfa051 | 357 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 358 | * @param line IO line being configured |
spastor | 0:fcaad0dfa051 | 359 | * @param mode configuration mode for the selected line |
spastor | 0:fcaad0dfa051 | 360 | * @returns |
spastor | 0:fcaad0dfa051 | 361 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 362 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 363 | */ |
spastor | 0:fcaad0dfa051 | 364 | RadioStatus set_pin_config(const RemoteXBee& remote, IoLine line, IoMode mode); |
spastor | 0:fcaad0dfa051 | 365 | |
spastor | 0:fcaad0dfa051 | 366 | /** get_pin_config - gets the configuration of a radio IO line |
spastor | 0:fcaad0dfa051 | 367 | * |
spastor | 0:fcaad0dfa051 | 368 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 369 | * @param line IO line being read to get its configuration |
spastor | 0:fcaad0dfa051 | 370 | * @param mode pointer where the configuration will be stored |
spastor | 0:fcaad0dfa051 | 371 | * @returns |
spastor | 0:fcaad0dfa051 | 372 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 373 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 374 | */ |
spastor | 0:fcaad0dfa051 | 375 | RadioStatus get_pin_config(const RemoteXBee& remote, IoLine line, IoMode * const mode); |
spastor | 0:fcaad0dfa051 | 376 | |
spastor | 0:fcaad0dfa051 | 377 | /** set_dio - sets to low/high a DIO line |
spastor | 0:fcaad0dfa051 | 378 | * |
spastor | 0:fcaad0dfa051 | 379 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 380 | * @param line DIO line being set |
spastor | 0:fcaad0dfa051 | 381 | * @param val value that will be set in the DIO line |
spastor | 0:fcaad0dfa051 | 382 | * @returns |
spastor | 0:fcaad0dfa051 | 383 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 384 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 385 | */ |
spastor | 0:fcaad0dfa051 | 386 | RadioStatus set_dio(const RemoteXBee& remote, IoLine line, DioVal val); |
spastor | 0:fcaad0dfa051 | 387 | |
spastor | 0:fcaad0dfa051 | 388 | /** get_dio - read the value of a DIO configured as digital input |
spastor | 0:fcaad0dfa051 | 389 | * |
spastor | 0:fcaad0dfa051 | 390 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 391 | * @param line DIO line being read |
spastor | 0:fcaad0dfa051 | 392 | * @param val pointer where the DIO value read will be stored |
spastor | 0:fcaad0dfa051 | 393 | * @returns |
spastor | 0:fcaad0dfa051 | 394 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 395 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 396 | */ |
spastor | 0:fcaad0dfa051 | 397 | RadioStatus get_dio(const RemoteXBee& remote, IoLine line, DioVal * const val); |
spastor | 0:fcaad0dfa051 | 398 | |
spastor | 0:fcaad0dfa051 | 399 | /** get_adc - read the value of the espcified ADC line |
spastor | 0:fcaad0dfa051 | 400 | * |
spastor | 0:fcaad0dfa051 | 401 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 402 | * @param line ADC line being read |
spastor | 0:fcaad0dfa051 | 403 | * @param val pointer where the value read from hte ADC will be stored |
spastor | 0:fcaad0dfa051 | 404 | * @returns |
spastor | 0:fcaad0dfa051 | 405 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 406 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 407 | */ |
spastor | 0:fcaad0dfa051 | 408 | RadioStatus get_adc(const RemoteXBee& remote, IoLine line, uint16_t * const val); |
spastor | 0:fcaad0dfa051 | 409 | |
spastor | 0:fcaad0dfa051 | 410 | /** set_pin_pull_up - enables or disables the internal pull-up resistor of a line |
spastor | 0:fcaad0dfa051 | 411 | * |
spastor | 0:fcaad0dfa051 | 412 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 413 | * @param line line being configured for pull-up |
spastor | 0:fcaad0dfa051 | 414 | * @param enable whether to enable the internal pull-up resistor. |
spastor | 0:fcaad0dfa051 | 415 | * @returns |
spastor | 0:fcaad0dfa051 | 416 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 417 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 418 | */ |
spastor | 0:fcaad0dfa051 | 419 | RadioStatus set_pin_pull_up(const RemoteXBee& remote, IoLine line, bool enable); |
spastor | 0:fcaad0dfa051 | 420 | |
spastor | 0:fcaad0dfa051 | 421 | /** enable_dio_change_detection - enables or disables the notification when a change is detected in a digital input line. |
spastor | 0:fcaad0dfa051 | 422 | * In other words, it will force an IO Sample transmission when the DIO state changes. Only for DIO0 to DIO11. |
spastor | 0:fcaad0dfa051 | 423 | * |
spastor | 0:fcaad0dfa051 | 424 | * @param remote remote device |
spastor | 0:fcaad0dfa051 | 425 | * @param line line being configured for pull-up |
spastor | 0:fcaad0dfa051 | 426 | * @param enable whether to enable the internal pull-up resistor. |
spastor | 0:fcaad0dfa051 | 427 | * @returns |
spastor | 0:fcaad0dfa051 | 428 | * Success if the operation was successful, |
spastor | 0:fcaad0dfa051 | 429 | * Failure otherwise |
spastor | 0:fcaad0dfa051 | 430 | */ |
spastor | 0:fcaad0dfa051 | 431 | RadioStatus enable_dio_change_detection(const RemoteXBee& remote, IoLine line, bool enable); |
spastor | 0:fcaad0dfa051 | 432 | |
spastor | 0:fcaad0dfa051 | 433 | protected: |
spastor | 0:fcaad0dfa051 | 434 | /** Role of this device in the ZigBee network (coord, router or end device) */ |
spastor | 0:fcaad0dfa051 | 435 | NetworkRole _nw_role; |
spastor | 0:fcaad0dfa051 | 436 | |
spastor | 0:fcaad0dfa051 | 437 | /** Indicates if the device is joined to a network. This variable is automatically updated |
spastor | 0:fcaad0dfa051 | 438 | * by the library. If the device is acting as coordinator, its value its true */ |
spastor | 0:fcaad0dfa051 | 439 | volatile bool _joined_network; |
spastor | 0:fcaad0dfa051 | 440 | |
spastor | 0:fcaad0dfa051 | 441 | /** Vcc exceeded counter, automatically updated by the library */ |
spastor | 0:fcaad0dfa051 | 442 | volatile uint16_t _vcc_exceeded_cnt; |
spastor | 0:fcaad0dfa051 | 443 | |
spastor | 0:fcaad0dfa051 | 444 | /* TODO, add setter/getter */ |
spastor | 0:fcaad0dfa051 | 445 | uint8_t _broadcast_radious; |
spastor | 0:fcaad0dfa051 | 446 | |
spastor | 0:fcaad0dfa051 | 447 | /** Frame handler used for the node discovery. Registered when a callback function |
spastor | 0:fcaad0dfa051 | 448 | * is registered */ |
spastor | 0:fcaad0dfa051 | 449 | FH_NodeDiscoveryZB *_nd_handler; |
spastor | 0:fcaad0dfa051 | 450 | |
spastor | 0:fcaad0dfa051 | 451 | /** Frame handler used for the rx packets. Automatically registered when a callback |
spastor | 0:fcaad0dfa051 | 452 | * function is registered */ |
spastor | 0:fcaad0dfa051 | 453 | FH_RxPacketZB *_rx_pkt_handler; |
spastor | 0:fcaad0dfa051 | 454 | |
spastor | 0:fcaad0dfa051 | 455 | /** Frame handler used for the IO Data Sample packets. Automatically registered when a callback |
spastor | 0:fcaad0dfa051 | 456 | * function is registered */ |
spastor | 0:fcaad0dfa051 | 457 | FH_IoDataSampeZB *_io_data_handler; |
spastor | 0:fcaad0dfa051 | 458 | |
spastor | 0:fcaad0dfa051 | 459 | /** Method called directly by the library when a modem status frame is received to |
spastor | 0:fcaad0dfa051 | 460 | * update the internal status variables */ |
spastor | 0:fcaad0dfa051 | 461 | virtual void radio_status_update(AtCmdFrame::ModemStatus modem_status); |
spastor | 0:fcaad0dfa051 | 462 | |
spastor | 0:fcaad0dfa051 | 463 | /* Allow using XBee::send_data() methods from this class */ |
spastor | 0:fcaad0dfa051 | 464 | using XBee::send_data; |
spastor | 0:fcaad0dfa051 | 465 | }; |
spastor | 0:fcaad0dfa051 | 466 | |
spastor | 0:fcaad0dfa051 | 467 | } /* namespace XBeeLib */ |
spastor | 0:fcaad0dfa051 | 468 | |
spastor | 0:fcaad0dfa051 | 469 | #endif /* __XBEE_ZB_H_ */ |
spastor | 0:fcaad0dfa051 | 470 | |
spastor | 0:fcaad0dfa051 | 471 |