Digi International Inc. / XBeeLib

Library to easily communicate with XBee modules.

Dependencies:   DigiLogger

Dependents:   WaterLogger XbeeGateway XBee_Cooker ProjetReceiver ... more

Use XBee radio modules to easily improve your project with wireless connectivity. You can enable entire networks of connected devices. XBees can exchange data with other modules in the network and configure remote modules as well as trigger actions or collect sensor data on XBee nodes without needing additional external microcontrollers. Using this documentation and configuration tools with XBee modules, it is easy to develop these types of applications and more.

/media/uploads/spastor/xbee-xbeepro-series1.jpg

The XBee mbed Library is a ready-to-import mbed extension that dramatically reduces development time for XBee projects on the mbed platforms. There are many modular examples, making it an easy and smooth process to add wireless networking to a whole range of useful applications.

Info

Currently 802.15.4 (Series 1 and 2), ZigBee (Series 2) and DigiMesh (Series 1 and 2) modules are supported. The libraries can be extended to support other protocols like DigiMesh point-to-point, WiFi, etc.

User manual

The user manual can be found at this project's Wiki pages:

  1. Configuring the library
  2. Debugging the library
  3. Initializing modules
  4. Resetting the local module
  5. Receiving Data from other module
  6. Sending data to another module
  7. Discovering nodes in the network
  8. Configuring local and remote modules
  9. Handling modem status changes
  10. Handling remote modules DIOs, ADCs and PWMs
  11. Handling IO Data Samples from other module
  12. Radio Power Management

Ready to use examples

There are a lot of ready to use examples to get started quickly.
Make sure you have a valid example setup before running the examples:

Examples for ZigBee modules

Import programXBeeZB_Receive_Data

ZigBee Receive Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_Send_Data

ZigBee Send Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_module_config

ZigBee network configuration example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_AT_Commands

ZigBee AT Commands example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_dio_adc

ZigBee DIOs and ADCs example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_IO_Sample_Callback

ZigBee IO Sampling Callback example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_modem_status

ZigBee Modem Status example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_node_discovery

ZigBee Node Discovery example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_power_mngmnt_cyclic_sleep

ZigBee Power Management using Cyclic Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_power_mngmnt_pin_sleep

ZigBee Power Management using Pin Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Examples for 802.15.4 modules

Import programXBee802_Receive_Data

802.15.4 Receive Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_Send_Data

802.15.4 Send Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_module_config

802.15.4 network configuration example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_AT_Commands

802.15.4 AT Commands example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_dio_adc_pwm

802.15.4 DIOs, ADCs and PWM example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_IO_Sample_Callback

802.15.4 IO Sampling Callback example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_node_discovery

802.15.4 Node Discovery example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_power_mngmnt_cyclic_sleep

802.15.4 Power Management using Cyclic Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_power_mngmnt_pin_sleep

802.15.4 Power Management using Pin Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Examples for DigiMesh modules

Import programXBeeDM_Receive_Data

DigiMesh Receive Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_Send_Data

DigiMesh Send Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_module_config

DigiMesh network configuration example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_AT_Commands

DigiMesh AT Commands example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_dio_adc_pwm

DigiMEsh DIOs, ADCs and PWMs example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_IO_Sample_Callback

DigiMesh IO Sampling Callback example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_modem_status

DigiMesh Modem Status example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_node_discovery

DigiMesh Node Discovery example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_power_mngmnt_asyncr_cyclic_sleep

DigiMesh Power Management using Asynchronous Cyclic Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_power_mngmnt_pin_sleep

DigiMesh Power Management using Pin Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

XBeeZB/XBeeZB.h@4:629712865107, 2015-06-01 (annotated)

Committer:
spastor
Date:
Mon Jun 01 18:59:43 2015 +0200
Revision:
4:629712865107
Parent:
3:8662ebe83570
Child:
6:06522f3a6642
Automatic upload

Who changed what in which revision?

UserRevisionLine numberNew 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 4:629712865107 47 enum AssocStatus {
spastor 4:629712865107 48 ErrorReading = -1, /**< Error occurred when reading parameter. */
spastor 4:629712865107 49 Joined = 0x00, /**< Successfully formed or joined a network. (Coordinators form a network, routers and end devices join a network.) */
spastor 4:629712865107 50 NoPANs = 0x21, /**< Scan found no PANs */
spastor 4:629712865107 51 NoValidPAN = 0x22, /**< Scan found no valid PANs based on current SC and ID settings */
spastor 4:629712865107 52 JoinNotAllowed = 0x23, /**< Valid Coordinator or Routers found, but they are not allowing joining (NJ expired). */
spastor 4:629712865107 53 NoBeacons = 0x24, /**< No joinable beacons were found. */
spastor 4:629712865107 54 Unexpected = 0x25, /**< Unexpected state, node should not be attempting to join at this time. */
spastor 4:629712865107 55 JoinFailed = 0x27, /**< Node Joining attempt failed (typically due to incompatible security settings). */
spastor 4:629712865107 56 CoordStartFail = 0x2A, /**< Coordinator start attempt failed */
spastor 4:629712865107 57 CheckingCoord = 0x2B, /**< Checking for an existing coordinator. */
spastor 4:629712865107 58 LeaveFail = 0x2C, /**< Attempt to leave the network failed. */
spastor 4:629712865107 59 JoinNoResponse = 0xAB, /**< Attempted to join a device that did not respond. */
spastor 4:629712865107 60 SecKeyUnsec = 0xAC, /**< Secure join error - network security key received unsecured. */
spastor 4:629712865107 61 SecKeyNotRec = 0xAD, /**< Secure join error - network security key not received. */
spastor 4:629712865107 62 SecBadKey = 0xAF, /**< Secure join error - joining device does not have the right preconfigured link key. */
spastor 4:629712865107 63 Scanning = 0xFF /**< Scanning for a ZigBee network (routers and end devices). */
spastor 4:629712865107 64 };
spastor 4:629712865107 65
spastor 0:fcaad0dfa051 66 /** Class constructor
spastor 0:fcaad0dfa051 67 * @param tx the TX pin of the UART that will interface the XBee module
spastor 0:fcaad0dfa051 68 * @param rx the RX pin of the UART that will interface the XBee module
spastor 0:fcaad0dfa051 69 * @param reset the pin to which the XBee's reset line is attached to, use NC if not available
spastor 0:fcaad0dfa051 70 * @param rts the RTS pin for the UART that will interface the XBee module, use NC if not available
spastor 0:fcaad0dfa051 71 * @param cts the CTS pin for the UART that will interface the XBee module, use NC if not available
spastor 0:fcaad0dfa051 72 * @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 73 * to this baud rate (ATBD parameter). By default it is configured to 9600 bps
spastor 0:fcaad0dfa051 74 */
spastor 0:fcaad0dfa051 75 XBeeZB(PinName tx, PinName rx, PinName reset = NC, PinName rts = NC, PinName cts = NC, int baud = 9600);
spastor 4:629712865107 76
spastor 0:fcaad0dfa051 77 /** Class destructor */
spastor 0:fcaad0dfa051 78 virtual ~XBeeZB();
spastor 4:629712865107 79
spastor 0:fcaad0dfa051 80 /** init- initializes object
spastor 0:fcaad0dfa051 81 * This function must be called just after creating the object so it initializes internal data.
spastor 0:fcaad0dfa051 82 * @returns
spastor 0:fcaad0dfa051 83 * Success if the module has been properly initialized and is ready to process data.
spastor 0:fcaad0dfa051 84 * Failure otherwise.
spastor 0:fcaad0dfa051 85 */
spastor 0:fcaad0dfa051 86 RadioStatus init();
spastor 0:fcaad0dfa051 87
spastor 4:629712865107 88 /** set_panid - sets the 64bit extended PAN ID.
spastor 0:fcaad0dfa051 89 *
spastor 0:fcaad0dfa051 90 * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID
spastor 0:fcaad0dfa051 91 * and the routers will join any extended PAN ID
spastor 0:fcaad0dfa051 92 * @param panid the PAN ID value that will be set on the radio
spastor 0:fcaad0dfa051 93 * @returns
spastor 0:fcaad0dfa051 94 * Success if the operation was successful,
spastor 0:fcaad0dfa051 95 * Failure otherwise
spastor 0:fcaad0dfa051 96 */
spastor 0:fcaad0dfa051 97 RadioStatus set_panid(uint64_t panid);
spastor 4:629712865107 98
spastor 0:fcaad0dfa051 99 /** get_configured_panid - gets the configured PAN ID, as it was set by @ref set_panid().
spastor 0:fcaad0dfa051 100 *
spastor 0:fcaad0dfa051 101 * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID
spastor 0:fcaad0dfa051 102 * and the routers will join any extended PAN ID
spastor 0:fcaad0dfa051 103 * @param panid pointer where the configured PAN ID will be stored
spastor 0:fcaad0dfa051 104 * @returns
spastor 0:fcaad0dfa051 105 * Success if the operation was successful,
spastor 0:fcaad0dfa051 106 * Failure otherwise
spastor 0:fcaad0dfa051 107 */
spastor 0:fcaad0dfa051 108 RadioStatus get_configured_panid(uint64_t * const panid);
spastor 0:fcaad0dfa051 109
spastor 0:fcaad0dfa051 110 /** 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 111 *
spastor 0:fcaad0dfa051 112 * @param panid pointer where the operating PAN ID will be stored
spastor 0:fcaad0dfa051 113 * @returns
spastor 0:fcaad0dfa051 114 * Success if the operation was successful,
spastor 0:fcaad0dfa051 115 * Failure otherwise
spastor 0:fcaad0dfa051 116 */
spastor 0:fcaad0dfa051 117 RadioStatus get_operating_panid(uint64_t * const panid);
spastor 0:fcaad0dfa051 118
spastor 0:fcaad0dfa051 119 /** set_panid - sets the 64bit extended PAN ID.
spastor 0:fcaad0dfa051 120 *
spastor 0:fcaad0dfa051 121 * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID
spastor 0:fcaad0dfa051 122 * and the routers will join any extended PAN ID
spastor 0:fcaad0dfa051 123 * @param remote remote device
spastor 0:fcaad0dfa051 124 * @param panid the PAN ID value that will be set on the radio
spastor 0:fcaad0dfa051 125 * @returns
spastor 0:fcaad0dfa051 126 * Success if the operation was successful,
spastor 0:fcaad0dfa051 127 * Failure otherwise
spastor 0:fcaad0dfa051 128 */
spastor 0:fcaad0dfa051 129 RadioStatus set_panid(const RemoteXBee& remote, uint64_t panid);
spastor 0:fcaad0dfa051 130
spastor 0:fcaad0dfa051 131 /** get_configured_panid - gets the configured PAN ID in a remote node, as it was set by @ref set_panid()
spastor 0:fcaad0dfa051 132 *
spastor 0:fcaad0dfa051 133 * @note on ZigBee devices, if set to 0, the coordinator will select a random PAN ID
spastor 0:fcaad0dfa051 134 * and the routers will join any extended PAN ID
spastor 0:fcaad0dfa051 135 *
spastor 0:fcaad0dfa051 136 * @param remote remote device
spastor 0:fcaad0dfa051 137 * @param panid pointer where the configured PAN ID will be stored
spastor 0:fcaad0dfa051 138 * @returns
spastor 0:fcaad0dfa051 139 * Success if the operation was successful,
spastor 0:fcaad0dfa051 140 * Failure otherwise
spastor 0:fcaad0dfa051 141 */
spastor 0:fcaad0dfa051 142 RadioStatus get_configured_panid(const RemoteXBee& remote, uint64_t * const panid);
spastor 0:fcaad0dfa051 143
spastor 0:fcaad0dfa051 144 /** 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 145 *
spastor 0:fcaad0dfa051 146 * @param remote remote device
spastor 0:fcaad0dfa051 147 * @param panid pointer where the operating PAN ID 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_operating_panid(const RemoteXBee& remote, uint64_t * const panid);
spastor 0:fcaad0dfa051 153
spastor 0:fcaad0dfa051 154 /** 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 155 * 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 156 *
spastor 0:fcaad0dfa051 157 * @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 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 set_channel_mask(uint16_t const chmask);
spastor 0:fcaad0dfa051 163
spastor 0:fcaad0dfa051 164 /** 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 165 *
spastor 0:fcaad0dfa051 166 * @param chmask pointer to where the configured channel mask will be stored
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 get_channel_mask(uint16_t * const chmask);
spastor 0:fcaad0dfa051 172
spastor 0:fcaad0dfa051 173 /** 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 174 * 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 175 *
spastor 0:fcaad0dfa051 176 * @param enable whether to enable this feature or not
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 check_for_coordinator_at_start(bool enable);
spastor 0:fcaad0dfa051 182
spastor 4:629712865107 183 /** set_network_security_key - (Coordinator only) Set the 128-bit AES network encryption key. If set to 0 (default), the module will select a random network key.
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 4:629712865107 191 RadioStatus set_network_security_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 /*********************** send_data member methods ************************/
spastor 4:629712865107 236 /** send_data - sends data to a remote device
spastor 0:fcaad0dfa051 237 *
spastor 0:fcaad0dfa051 238 * @param remote remote device
spastor 0:fcaad0dfa051 239 * @param data pointer to the data that will be sent
spastor 0:fcaad0dfa051 240 * @param len number of bytes that will be transmitted
spastor 3:8662ebe83570 241 * @param syncr if true, method waits for the packet answer with the result of the operation
spastor 0:fcaad0dfa051 242 * @returns the result of the data transfer
spastor 0:fcaad0dfa051 243 * TxStatusSuccess if the operation was successful,
spastor 0:fcaad0dfa051 244 * the error code otherwise
spastor 0:fcaad0dfa051 245 */
spastor 4:629712865107 246 virtual TxStatus send_data(const RemoteXBee& remote, const uint8_t *const data, uint16_t len, bool syncr = true);
spastor 0:fcaad0dfa051 247
spastor 3:8662ebe83570 248 /** send_data - sends data to a remote device. This method uses
spastor 0:fcaad0dfa051 249 * the explicit addressing frame, allowing to use source and
spastor 0:fcaad0dfa051 250 * destination end points and cluster and profile IDs
spastor 0:fcaad0dfa051 251 *
spastor 0:fcaad0dfa051 252 * @param remote remote device
spastor 0:fcaad0dfa051 253 * @param source_ep source end point
spastor 0:fcaad0dfa051 254 * @param dest_ep destination end point
spastor 0:fcaad0dfa051 255 * @param cluster_id cluster ID
spastor 0:fcaad0dfa051 256 * @param profile_id profile ID
spastor 0:fcaad0dfa051 257 * @param data pointer to the data that will be sent
spastor 0:fcaad0dfa051 258 * @param len number of bytes that will be transmitted
spastor 3:8662ebe83570 259 * @param syncr if true, method waits for the packet answer with the result of the operation
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 */
spastor 4:629712865107 264 TxStatus send_data(const RemoteXBee& remote, uint8_t source_ep,
spastor 0:fcaad0dfa051 265 uint8_t dest_ep, uint16_t cluster_id, uint16_t profile_id,
spastor 3:8662ebe83570 266 const uint8_t *const data, uint16_t len, bool syncr = true);
spastor 0:fcaad0dfa051 267
spastor 3:8662ebe83570 268 /** send_data_to_coordinator - sends data to the ZigBee coordinator
spastor 0:fcaad0dfa051 269 *
spastor 0:fcaad0dfa051 270 * @param data pointer to the data that will be sent
spastor 0:fcaad0dfa051 271 * @param len number of bytes that will be transmitted
spastor 3:8662ebe83570 272 * @param syncr if true, method waits for the packet answer with the result of the operation
spastor 0:fcaad0dfa051 273 * @returns the result of the data transfer
spastor 0:fcaad0dfa051 274 * TxStatusSuccess if the operation was successful,
spastor 0:fcaad0dfa051 275 * the error code otherwise
spastor 0:fcaad0dfa051 276 */
spastor 3:8662ebe83570 277 TxStatus send_data_to_coordinator(const uint8_t *const data, uint16_t len, bool syncr = true);
spastor 0:fcaad0dfa051 278
spastor 4:629712865107 279 /** get_assoc_status - returns current network association status. This wraps AI parameter, for more information refer to moudle's Reference Manual.
spastor 4:629712865107 280 *
spastor 4:629712865107 281 * @returns an AssocStatus with current network association status.
spastor 4:629712865107 282 */
spastor 4:629712865107 283 AssocStatus get_assoc_status(void);
spastor 4:629712865107 284
spastor 0:fcaad0dfa051 285 /** is_joined - checks if the device is joined to ZigBee network
spastor 0:fcaad0dfa051 286 * @returns true if joined, false otherwise
spastor 0:fcaad0dfa051 287 */
spastor 0:fcaad0dfa051 288 bool is_joined();
spastor 4:629712865107 289
hbujanda 2:2ee1b6d51df2 290 /** get_remote_node_by_id - searches for a device in the network with the specified Node Identifier.
spastor 0:fcaad0dfa051 291 *
spastor 0:fcaad0dfa051 292 * @param node_id node id of the device we are looking for
hbujanda 2:2ee1b6d51df2 293 * @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 294 * If node is not found, the returned object will have invalid addresses (RemoteXBeeZB::is_valid() will return false).
spastor 0:fcaad0dfa051 295 */
hbujanda 2:2ee1b6d51df2 296 RemoteXBeeZB get_remote_node_by_id(const char * const node_id);
spastor 0:fcaad0dfa051 297
spastor 0:fcaad0dfa051 298 /* Allow using XBee::set_param() methods for local radio from this class */
spastor 0:fcaad0dfa051 299 using XBee::set_param;
spastor 0:fcaad0dfa051 300
spastor 0:fcaad0dfa051 301 /** set_param - sets a parameter in a remote radio by sending an AT command and waiting for the response.
spastor 0:fcaad0dfa051 302 *
spastor 0:fcaad0dfa051 303 * @param remote remote device
spastor 0:fcaad0dfa051 304 * @param param parameter to be set.
spastor 0:fcaad0dfa051 305 * @param data the parameter value (4 bytes) to be set.
spastor 0:fcaad0dfa051 306 * @returns the command response status.
spastor 0:fcaad0dfa051 307 */
spastor 0:fcaad0dfa051 308 virtual AtCmdFrame::AtCmdResp set_param(const RemoteXBee& remote, const char * const param, uint32_t data);
spastor 4:629712865107 309
spastor 0:fcaad0dfa051 310 /** set_param - sets a parameter in a remote radio by sending an AT command and waiting for the response.
spastor 0:fcaad0dfa051 311 *
spastor 0:fcaad0dfa051 312 * @param remote remote device
spastor 0:fcaad0dfa051 313 * @param param parameter to be set.
spastor 4:629712865107 314 * @param data the parameter value byte array (len bytes) to be set.
spastor 0:fcaad0dfa051 315 * @param len number of bytes of the parameter value.
spastor 0:fcaad0dfa051 316 * @returns the command response status.
spastor 0:fcaad0dfa051 317 */
spastor 0:fcaad0dfa051 318 virtual AtCmdFrame::AtCmdResp set_param(const RemoteXBee& remote, const char * const param, const uint8_t * data = NULL, uint16_t len = 0);
spastor 4:629712865107 319
spastor 0:fcaad0dfa051 320 /* Allow using XBee::get_param() methods for local radio from this class */
spastor 0:fcaad0dfa051 321 using XBee::get_param;
spastor 0:fcaad0dfa051 322
spastor 0:fcaad0dfa051 323 /** get_param - gets a parameter from a remote radio by sending an AT command and waiting for the response.
spastor 0:fcaad0dfa051 324 *
spastor 0:fcaad0dfa051 325 * @param remote remote device
spastor 0:fcaad0dfa051 326 * @param param parameter to be get.
spastor 4:629712865107 327 * @param data pointer where the param value (4 bytes) will be stored.
spastor 0:fcaad0dfa051 328 * @returns the command response status.
spastor 0:fcaad0dfa051 329 */
spastor 0:fcaad0dfa051 330 virtual AtCmdFrame::AtCmdResp get_param(const RemoteXBee& remote, const char * const param, uint32_t * const data);
spastor 4:629712865107 331
spastor 0:fcaad0dfa051 332 /** get_param - gets a parameter from a remote radio by sending an AT command and waiting for the response.
spastor 0:fcaad0dfa051 333 *
spastor 0:fcaad0dfa051 334 * @param remote remote device
spastor 0:fcaad0dfa051 335 * @param param parameter to be get.
spastor 4:629712865107 336 * @param data pointer where the param value (n bytes) will be stored.
spastor 4:629712865107 337 * @param len pointer where the number of bytes of the param value will be stored.
spastor 0:fcaad0dfa051 338 * @returns the command response status.
spastor 0:fcaad0dfa051 339 */
spastor 0:fcaad0dfa051 340 virtual AtCmdFrame::AtCmdResp get_param(const RemoteXBee& remote, const char * const param, uint8_t * const data, uint16_t * const len);
spastor 0:fcaad0dfa051 341
spastor 0:fcaad0dfa051 342 /************************* IO member methods **************************/
spastor 0:fcaad0dfa051 343 /** set_pin_config - configures a radio IO line
spastor 0:fcaad0dfa051 344 *
spastor 0:fcaad0dfa051 345 * @param remote remote device
spastor 0:fcaad0dfa051 346 * @param line IO line being configured
spastor 0:fcaad0dfa051 347 * @param mode configuration mode for the selected line
spastor 0:fcaad0dfa051 348 * @returns
spastor 0:fcaad0dfa051 349 * Success if the operation was successful,
spastor 0:fcaad0dfa051 350 * Failure otherwise
spastor 0:fcaad0dfa051 351 */
spastor 0:fcaad0dfa051 352 RadioStatus set_pin_config(const RemoteXBee& remote, IoLine line, IoMode mode);
spastor 0:fcaad0dfa051 353
spastor 0:fcaad0dfa051 354 /** get_pin_config - gets the configuration of a radio IO line
spastor 0:fcaad0dfa051 355 *
spastor 0:fcaad0dfa051 356 * @param remote remote device
spastor 0:fcaad0dfa051 357 * @param line IO line being read to get its configuration
spastor 0:fcaad0dfa051 358 * @param mode pointer where the configuration will be stored
spastor 0:fcaad0dfa051 359 * @returns
spastor 0:fcaad0dfa051 360 * Success if the operation was successful,
spastor 0:fcaad0dfa051 361 * Failure otherwise
spastor 0:fcaad0dfa051 362 */
spastor 0:fcaad0dfa051 363 RadioStatus get_pin_config(const RemoteXBee& remote, IoLine line, IoMode * const mode);
spastor 0:fcaad0dfa051 364
spastor 0:fcaad0dfa051 365 /** set_dio - sets to low/high a DIO line
spastor 0:fcaad0dfa051 366 *
spastor 0:fcaad0dfa051 367 * @param remote remote device
spastor 0:fcaad0dfa051 368 * @param line DIO line being set
spastor 0:fcaad0dfa051 369 * @param val value that will be set in the DIO line
spastor 0:fcaad0dfa051 370 * @returns
spastor 0:fcaad0dfa051 371 * Success if the operation was successful,
spastor 0:fcaad0dfa051 372 * Failure otherwise
spastor 0:fcaad0dfa051 373 */
spastor 0:fcaad0dfa051 374 RadioStatus set_dio(const RemoteXBee& remote, IoLine line, DioVal val);
spastor 0:fcaad0dfa051 375
spastor 0:fcaad0dfa051 376 /** get_dio - read the value of a DIO configured as digital input
spastor 0:fcaad0dfa051 377 *
spastor 0:fcaad0dfa051 378 * @param remote remote device
spastor 0:fcaad0dfa051 379 * @param line DIO line being read
spastor 0:fcaad0dfa051 380 * @param val pointer where the DIO value read will be stored
spastor 0:fcaad0dfa051 381 * @returns
spastor 0:fcaad0dfa051 382 * Success if the operation was successful,
spastor 0:fcaad0dfa051 383 * Failure otherwise
spastor 0:fcaad0dfa051 384 */
spastor 0:fcaad0dfa051 385 RadioStatus get_dio(const RemoteXBee& remote, IoLine line, DioVal * const val);
spastor 0:fcaad0dfa051 386
spastor 0:fcaad0dfa051 387 /** get_adc - read the value of the espcified ADC line
spastor 0:fcaad0dfa051 388 *
spastor 0:fcaad0dfa051 389 * @param remote remote device
spastor 0:fcaad0dfa051 390 * @param line ADC line being read
spastor 0:fcaad0dfa051 391 * @param val pointer where the value read from hte ADC will be stored
spastor 0:fcaad0dfa051 392 * @returns
spastor 0:fcaad0dfa051 393 * Success if the operation was successful,
spastor 0:fcaad0dfa051 394 * Failure otherwise
spastor 0:fcaad0dfa051 395 */
spastor 0:fcaad0dfa051 396 RadioStatus get_adc(const RemoteXBee& remote, IoLine line, uint16_t * const val);
spastor 0:fcaad0dfa051 397
spastor 3:8662ebe83570 398 /** get_iosample - retrieves an @ref IOSampleZB from a remote node. This object can be used to get the remote node's ADC and DIO values.
spastor 3:8662ebe83570 399 *
spastor 3:8662ebe83570 400 * @param remote remote device
spastor 3:8662ebe83570 401 * @returns IOSampleZB object with the remote node's DIO and ADC values.
spastor 3:8662ebe83570 402 */
spastor 3:8662ebe83570 403 IOSampleZB get_iosample(const RemoteXBee& remote);
spastor 3:8662ebe83570 404
spastor 0:fcaad0dfa051 405 /** set_pin_pull_up - enables or disables the internal pull-up resistor of a line
spastor 0:fcaad0dfa051 406 *
spastor 0:fcaad0dfa051 407 * @param remote remote device
spastor 0:fcaad0dfa051 408 * @param line line being configured for pull-up
spastor 0:fcaad0dfa051 409 * @param enable whether to enable the internal pull-up resistor.
spastor 0:fcaad0dfa051 410 * @returns
spastor 0:fcaad0dfa051 411 * Success if the operation was successful,
spastor 0:fcaad0dfa051 412 * Failure otherwise
spastor 0:fcaad0dfa051 413 */
spastor 0:fcaad0dfa051 414 RadioStatus set_pin_pull_up(const RemoteXBee& remote, IoLine line, bool enable);
spastor 0:fcaad0dfa051 415
spastor 0:fcaad0dfa051 416 /** enable_dio_change_detection - enables or disables the notification when a change is detected in a digital input line.
spastor 0:fcaad0dfa051 417 * In other words, it will force an IO Sample transmission when the DIO state changes. Only for DIO0 to DIO11.
spastor 0:fcaad0dfa051 418 *
spastor 0:fcaad0dfa051 419 * @param remote remote device
spastor 0:fcaad0dfa051 420 * @param line line being configured for pull-up
spastor 0:fcaad0dfa051 421 * @param enable whether to enable the internal pull-up resistor.
spastor 0:fcaad0dfa051 422 * @returns
spastor 0:fcaad0dfa051 423 * Success if the operation was successful,
spastor 0:fcaad0dfa051 424 * Failure otherwise
spastor 0:fcaad0dfa051 425 */
spastor 0:fcaad0dfa051 426 RadioStatus enable_dio_change_detection(const RemoteXBee& remote, IoLine line, bool enable);
spastor 0:fcaad0dfa051 427
spastor 0:fcaad0dfa051 428 protected:
spastor 0:fcaad0dfa051 429
spastor 0:fcaad0dfa051 430 /** Frame handler used for the node discovery. Registered when a callback function
spastor 0:fcaad0dfa051 431 * is registered */
spastor 0:fcaad0dfa051 432 FH_NodeDiscoveryZB *_nd_handler;
spastor 0:fcaad0dfa051 433
spastor 0:fcaad0dfa051 434 /** Frame handler used for the rx packets. Automatically registered when a callback
spastor 0:fcaad0dfa051 435 * function is registered */
spastor 0:fcaad0dfa051 436 FH_RxPacketZB *_rx_pkt_handler;
spastor 4:629712865107 437
spastor 0:fcaad0dfa051 438 /** Frame handler used for the IO Data Sample packets. Automatically registered when a callback
spastor 0:fcaad0dfa051 439 * function is registered */
spastor 0:fcaad0dfa051 440 FH_IoDataSampeZB *_io_data_handler;
spastor 0:fcaad0dfa051 441
spastor 4:629712865107 442 /** Method called directly by the library when a modem status frame is received to
spastor 0:fcaad0dfa051 443 * update the internal status variables */
spastor 0:fcaad0dfa051 444 virtual void radio_status_update(AtCmdFrame::ModemStatus modem_status);
spastor 0:fcaad0dfa051 445
spastor 0:fcaad0dfa051 446 /* Allow using XBee::send_data() methods from this class */
spastor 0:fcaad0dfa051 447 using XBee::send_data;
spastor 0:fcaad0dfa051 448 };
spastor 0:fcaad0dfa051 449
spastor 0:fcaad0dfa051 450 } /* namespace XBeeLib */
spastor 0:fcaad0dfa051 451
spastor 0:fcaad0dfa051 452 #endif /* __XBEE_ZB_H_ */