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.

FrameHandlers/FH_AtCmdResp.cpp@9:780db84ce891, 2016-07-29 (annotated)

Committer:
hbujanda
Date:
Fri Jul 29 13:10:07 2016 +0200
Revision:
9:780db84ce891
Parent:
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 #include "FrameHandlers/FH_AtCmdResp.h"
spastor 0:fcaad0dfa051 14 #include "Frames/ApiFrame.h"
spastor 0:fcaad0dfa051 15
spastor 0:fcaad0dfa051 16 using namespace XBeeLib;
spastor 0:fcaad0dfa051 17
spastor 0:fcaad0dfa051 18 /** Class constructor */
spastor 4:629712865107 19 FH_AtCmdResp::FH_AtCmdResp() :
spastor 0:fcaad0dfa051 20 FrameHandler(ApiFrame::AtCmdResp), at_cmd_resp_cb(NULL)
spastor 0:fcaad0dfa051 21 {
spastor 0:fcaad0dfa051 22 }
spastor 0:fcaad0dfa051 23
spastor 4:629712865107 24 FH_AtCmdResp::FH_AtCmdResp(ApiFrame::ApiFrameType type) :
spastor 0:fcaad0dfa051 25 FrameHandler(type), at_cmd_resp_cb(NULL)
spastor 0:fcaad0dfa051 26 {
spastor 0:fcaad0dfa051 27 }
spastor 0:fcaad0dfa051 28
spastor 0:fcaad0dfa051 29 /** Class destructor */
spastor 0:fcaad0dfa051 30 FH_AtCmdResp::~FH_AtCmdResp()
spastor 0:fcaad0dfa051 31 {
spastor 0:fcaad0dfa051 32 }
spastor 0:fcaad0dfa051 33
spastor 0:fcaad0dfa051 34 void FH_AtCmdResp::register_at_cmd_resp_cb(at_cmd_resp_cb_t function)
spastor 0:fcaad0dfa051 35 {
spastor 4:629712865107 36 at_cmd_resp_cb = function;
spastor 0:fcaad0dfa051 37 }
spastor 0:fcaad0dfa051 38
spastor 0:fcaad0dfa051 39 void FH_AtCmdResp::unregister_at_cmd_resp_cb()
spastor 0:fcaad0dfa051 40 {
spastor 0:fcaad0dfa051 41 at_cmd_resp_cb = NULL;
spastor 0:fcaad0dfa051 42 }
spastor 0:fcaad0dfa051 43
spastor 0:fcaad0dfa051 44 void FH_AtCmdResp::process_frame_data(const ApiFrame * const frame)
spastor 0:fcaad0dfa051 45 {
spastor 4:629712865107 46 /* The caller checks that the type matches, so no need to check it here again */
spastor 4:629712865107 47
spastor 4:629712865107 48 if (at_cmd_resp_cb == NULL) {
spastor 0:fcaad0dfa051 49 return;
spastor 4:629712865107 50 }
spastor 4:629712865107 51
spastor 0:fcaad0dfa051 52 at_cmd_resp_cb(frame->get_data(), frame->get_data_len());
spastor 0:fcaad0dfa051 53 }
spastor 0:fcaad0dfa051 54
spastor 0:fcaad0dfa051 55
spastor 0:fcaad0dfa051 56 /** Class constructor */
spastor 4:629712865107 57 FH_NodeDiscoveryZB::FH_NodeDiscoveryZB() :
spastor 0:fcaad0dfa051 58 FH_AtCmdResp(ApiFrame::AtCmdResp), node_discovery_cb(NULL)
spastor 0:fcaad0dfa051 59 {
spastor 0:fcaad0dfa051 60 }
spastor 0:fcaad0dfa051 61
spastor 0:fcaad0dfa051 62 /** Class destructor */
spastor 0:fcaad0dfa051 63 FH_NodeDiscoveryZB::~FH_NodeDiscoveryZB()
spastor 0:fcaad0dfa051 64 {
spastor 0:fcaad0dfa051 65 }
spastor 0:fcaad0dfa051 66
spastor 0:fcaad0dfa051 67 void FH_NodeDiscoveryZB::register_node_discovery_cb(node_discovery_zb_cb_t function)
spastor 0:fcaad0dfa051 68 {
spastor 4:629712865107 69 node_discovery_cb = function;
spastor 0:fcaad0dfa051 70 }
spastor 0:fcaad0dfa051 71
spastor 0:fcaad0dfa051 72 void FH_NodeDiscoveryZB::unregister_node_discovery_cb()
spastor 0:fcaad0dfa051 73 {
spastor 0:fcaad0dfa051 74 node_discovery_cb = NULL;
spastor 0:fcaad0dfa051 75 }
spastor 0:fcaad0dfa051 76
spastor 0:fcaad0dfa051 77
spastor 0:fcaad0dfa051 78 void FH_NodeDiscoveryZB::process_frame_data(const ApiFrame *const frame)
spastor 0:fcaad0dfa051 79 {
spastor 4:629712865107 80 /* The caller checks that the type matches, so no need to check it here again */
spastor 4:629712865107 81
spastor 0:fcaad0dfa051 82 if (node_discovery_cb == NULL) {
spastor 0:fcaad0dfa051 83 return;
spastor 0:fcaad0dfa051 84 }
spastor 0:fcaad0dfa051 85
spastor 4:629712865107 86 if (frame->get_data_at(ATCMD_RESP_CMD_LOW_OFFSET) != 'N' ||
spastor 0:fcaad0dfa051 87 frame->get_data_at(ATCMD_RESP_CMD_HIGH_OFFSET) != 'D') {
spastor 0:fcaad0dfa051 88 return;
spastor 0:fcaad0dfa051 89 }
spastor 4:629712865107 90
spastor 0:fcaad0dfa051 91 if (frame->get_data_at(ATCMD_RESP_STATUS_OFFSET) != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 92 return;
spastor 0:fcaad0dfa051 93 }
spastor 0:fcaad0dfa051 94
spastor 0:fcaad0dfa051 95 const uint8_t * const data = frame->get_data(); /* The data payload we get here is the full AT command response payload, excluding the frameid. Keep that in mind for the offsets */
spastor 0:fcaad0dfa051 96 const uint16_t addr16 = UINT16(data[ATCMD_RESP_NW_ADDR_H_OFFSET], data[ATCMD_RESP_NW_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 97 const uint64_t addr64 = addr64_from_uint8_t(&data[ATCMD_RESP_SH_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 98 const char * const node_id = (const char *)&data[ATCMD_RESP_NI_OFFSET];
spastor 0:fcaad0dfa051 99 RemoteXBeeZB remote = RemoteXBeeZB(addr64, addr16);
spastor 0:fcaad0dfa051 100
spastor 0:fcaad0dfa051 101 node_discovery_cb(remote, node_id);
spastor 0:fcaad0dfa051 102 }
spastor 0:fcaad0dfa051 103
spastor 0:fcaad0dfa051 104
spastor 0:fcaad0dfa051 105
spastor 0:fcaad0dfa051 106 /** Class constructor */
spastor 4:629712865107 107 FH_NodeDiscovery802::FH_NodeDiscovery802() :
spastor 0:fcaad0dfa051 108 FH_AtCmdResp(ApiFrame::AtCmdResp), node_discovery_cb(NULL)
spastor 0:fcaad0dfa051 109 {
spastor 0:fcaad0dfa051 110 }
spastor 0:fcaad0dfa051 111
spastor 0:fcaad0dfa051 112 /** Class destructor */
spastor 0:fcaad0dfa051 113 FH_NodeDiscovery802::~FH_NodeDiscovery802()
spastor 0:fcaad0dfa051 114 {
spastor 0:fcaad0dfa051 115 }
spastor 0:fcaad0dfa051 116
spastor 0:fcaad0dfa051 117 void FH_NodeDiscovery802::register_node_discovery_cb(node_discovery_802_cb_t function)
spastor 0:fcaad0dfa051 118 {
spastor 4:629712865107 119 node_discovery_cb = function;
spastor 0:fcaad0dfa051 120 }
spastor 0:fcaad0dfa051 121
spastor 0:fcaad0dfa051 122 void FH_NodeDiscovery802::unregister_node_discovery_cb()
spastor 0:fcaad0dfa051 123 {
spastor 0:fcaad0dfa051 124 node_discovery_cb = NULL;
spastor 0:fcaad0dfa051 125 }
spastor 0:fcaad0dfa051 126
spastor 0:fcaad0dfa051 127
spastor 0:fcaad0dfa051 128 void FH_NodeDiscovery802::process_frame_data(const ApiFrame *const frame)
spastor 0:fcaad0dfa051 129 {
spastor 4:629712865107 130 /* The caller checks that the type matches, so no need to check it here again */
spastor 0:fcaad0dfa051 131
spastor 0:fcaad0dfa051 132 if (node_discovery_cb == NULL) {
spastor 0:fcaad0dfa051 133 return;
spastor 0:fcaad0dfa051 134 }
spastor 0:fcaad0dfa051 135
spastor 4:629712865107 136 if (frame->get_data_at(ATCMD_RESP_CMD_LOW_OFFSET) != 'N' ||
spastor 0:fcaad0dfa051 137 frame->get_data_at(ATCMD_RESP_CMD_HIGH_OFFSET) != 'D') {
spastor 0:fcaad0dfa051 138 return;
spastor 0:fcaad0dfa051 139 }
spastor 0:fcaad0dfa051 140
spastor 0:fcaad0dfa051 141 if (frame->get_data_at(ATCMD_RESP_STATUS_OFFSET) != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 142 return;
spastor 0:fcaad0dfa051 143 }
spastor 0:fcaad0dfa051 144
spastor 4:629712865107 145 const uint16_t min_atnd_response_with_data = sizeof (uint16_t) + sizeof(uint64_t);
spastor 0:fcaad0dfa051 146 if (frame->get_data_len() < min_atnd_response_with_data) {
spastor 0:fcaad0dfa051 147 /* Do not process the ATND "OK" response */
spastor 0:fcaad0dfa051 148 return;
spastor 0:fcaad0dfa051 149 }
spastor 0:fcaad0dfa051 150
spastor 0:fcaad0dfa051 151 const uint8_t * const data = frame->get_data();
spastor 0:fcaad0dfa051 152 const uint16_t addr16 = UINT16(data[ATCMD_RESP_NW_ADDR_H_OFFSET], data[ATCMD_RESP_NW_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 153 const uint64_t addr64 = addr64_from_uint8_t(&data[ATCMD_RESP_SH_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 154 #if 0
spastor 0:fcaad0dfa051 155 const uint8_t signal_strength = data[ATCMD_802_RESP_SIGN_STR_OFFSET];
spastor 0:fcaad0dfa051 156 #endif
spastor 0:fcaad0dfa051 157 const RemoteXBee802 remote = RemoteXBee802(addr64, addr16);
spastor 0:fcaad0dfa051 158 const char * const nodeid = (const char *)(&data[ATCMD_802_RESP_NI_OFFSET]);
spastor 0:fcaad0dfa051 159
spastor 0:fcaad0dfa051 160 node_discovery_cb(remote, nodeid);
spastor 0:fcaad0dfa051 161 }
hbujanda 6:06522f3a6642 162
hbujanda 6:06522f3a6642 163 /** Class constructor */
hbujanda 6:06522f3a6642 164 FH_NodeDiscoveryDM::FH_NodeDiscoveryDM() :
hbujanda 6:06522f3a6642 165 FH_AtCmdResp(ApiFrame::AtCmdResp), node_discovery_cb(NULL)
hbujanda 6:06522f3a6642 166 {
hbujanda 6:06522f3a6642 167 }
hbujanda 6:06522f3a6642 168
hbujanda 6:06522f3a6642 169 /** Class destructor */
hbujanda 6:06522f3a6642 170 FH_NodeDiscoveryDM::~FH_NodeDiscoveryDM()
hbujanda 6:06522f3a6642 171 {
hbujanda 6:06522f3a6642 172 }
hbujanda 6:06522f3a6642 173
hbujanda 6:06522f3a6642 174 void FH_NodeDiscoveryDM::register_node_discovery_cb(node_discovery_dm_cb_t function)
hbujanda 6:06522f3a6642 175 {
hbujanda 6:06522f3a6642 176 node_discovery_cb = function;
hbujanda 6:06522f3a6642 177 }
hbujanda 6:06522f3a6642 178
hbujanda 6:06522f3a6642 179 void FH_NodeDiscoveryDM::unregister_node_discovery_cb()
hbujanda 6:06522f3a6642 180 {
hbujanda 6:06522f3a6642 181 node_discovery_cb = NULL;
hbujanda 6:06522f3a6642 182 }
hbujanda 6:06522f3a6642 183
hbujanda 6:06522f3a6642 184
hbujanda 6:06522f3a6642 185 void FH_NodeDiscoveryDM::process_frame_data(const ApiFrame *const frame)
hbujanda 6:06522f3a6642 186 {
hbujanda 6:06522f3a6642 187 /* The caller checks that the type matches, so no need to check it here again */
hbujanda 6:06522f3a6642 188
hbujanda 6:06522f3a6642 189 if (node_discovery_cb == NULL) {
hbujanda 6:06522f3a6642 190 return;
hbujanda 6:06522f3a6642 191 }
hbujanda 6:06522f3a6642 192
hbujanda 6:06522f3a6642 193 if (frame->get_data_at(ATCMD_RESP_CMD_LOW_OFFSET) != 'N' ||
hbujanda 6:06522f3a6642 194 frame->get_data_at(ATCMD_RESP_CMD_HIGH_OFFSET) != 'D') {
hbujanda 6:06522f3a6642 195 return;
hbujanda 6:06522f3a6642 196 }
hbujanda 6:06522f3a6642 197
hbujanda 6:06522f3a6642 198 if (frame->get_data_at(ATCMD_RESP_STATUS_OFFSET) != AtCmdFrame::AtCmdRespOk) {
hbujanda 6:06522f3a6642 199 return;
hbujanda 6:06522f3a6642 200 }
hbujanda 6:06522f3a6642 201
hbujanda 6:06522f3a6642 202 const uint8_t * const data = frame->get_data(); /* The data payload we get here is the full AT command response payload, excluding the frameid. Keep that in mind for the offsets */
hbujanda 6:06522f3a6642 203 const uint64_t addr64 = addr64_from_uint8_t(&data[ATCMD_RESP_SH_ADDR_L_OFFSET]);
hbujanda 6:06522f3a6642 204 const char * const node_id = (const char *)&data[ATCMD_RESP_NI_OFFSET];
hbujanda 6:06522f3a6642 205 RemoteXBeeDM remote = RemoteXBeeDM(addr64);
hbujanda 6:06522f3a6642 206
hbujanda 6:06522f3a6642 207 node_discovery_cb(remote, node_id);
hbujanda 6:06522f3a6642 208 }